---
updatedAt: 2026-08-24T09:14:57.000Z
agentTools:
projectIndex: https://developers.vibe.co/llms.txt
---
# Update an advertiser
**Scopes:**
`advertisers:write`
*Rate limits*:
Burst: `5/s`
Steady: `120/m`
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"paths": {
"/advertisers/{advertiser_id}": {
"patch": {
"operationId": "updateAdvertiser",
"parameters": [
{
"name": "advertiser_id",
"required": true,
"in": "path",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "account_id",
"required": false,
"in": "query",
"description": "Required only for embedded apps.",
"schema": {
"type": "number"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdvertiserUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Advertiser updated",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Advertiser"
}
}
}
},
"400": {
"description": "Bad request error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"missingApiKey": {
"summary": "Missing API key",
"value": {
"error": {
"type": "validation",
"message": "Missing API Key",
"status": 400,
"detail": null,
"request_id": "req_8f3a4b2c",
"doc_url": null
}
}
},
"validationError": {
"summary": "Validation error",
"value": {
"error": {
"type": "validation",
"message": "Validation error",
"status": 400,
"detail": {
"validation": [
"id must be a string"
]
},
"request_id": "req_8f3a4b2c",
"doc_url": null
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"invalidApiKey": {
"summary": "Invalid API key",
"value": {
"error": {
"type": "invalid_token",
"message": "Unauthorized",
"status": 401,
"detail": null,
"request_id": "req_8f3a4b2c",
"doc_url": "https://developers.vibe.co/errors/invalid-token"
}
}
}
}
}
}
},
"403": {
"description": "Insufficient scope error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"insufficientScope": {
"summary": "Missing required scope",
"value": {
"error": {
"type": "insufficient_scope",
"message": "Missing required scope",
"status": 403,
"detail": {
"required": "advertisers:write",
"granted": [
"test"
]
},
"request_id": "req_8f3a4b2c",
"doc_url": "https://developers.vibe.co/reference/oauth2token"
}
}
}
}
}
}
},
"404": {
"description": "Advertiser not found"
}
},
"summary": "Update an advertiser",
"tags": [
"Advertisers"
],
"x-rate-limit": {
"rps": 5,
"rpm": 120
},
"x-scopes": [
"advertisers:write"
],
"description": "**Scopes:**\n`advertisers:write`\n
*Rate limits*:
Burst: `5/s`
Steady: `120/m`\n"
}
}
},
"info": {
"title": "Vibe Public API",
"description": "Vibe Public API revision 2026-06-01",
"version": "2026-06-01",
"contact": {}
},
"tags": [
{
"name": "Advertisers",
"description": "An Advertiser represents a brand running on Vibe. It owns Campaigns, Creatives, Audiences, and Impression Trackers, and is the primary scope of most reporting queries.\n\nYou'll create one Advertiser per brand. Most other resources require an `advertiser_id` — cache yours."
}
],
"servers": [
{
"url": "https://api.vibe.co",
"description": "Production API"
}
],
"components": {
"securitySchemes": {
"bearer": {
"scheme": "bearer",
"bearerFormat": "JWT",
"type": "http"
}
},
"schemas": {
"ErrorDetail": {
"type": "object",
"properties": {
"required": {
"type": "string",
"example": "audiences:write"
},
"granted": {
"example": [
"audiences:read",
"reporting:read"
],
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"required",
"granted"
]
},
"ApiError": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"insufficient_scope",
"invalid_token",
"validation",
"internal_error"
]
},
"message": {
"type": "string"
},
"status": {
"type": "number",
"example": 403
},
"detail": {
"nullable": true,
"allOf": [
{
"$ref": "#/components/schemas/ErrorDetail"
}
]
},
"request_id": {
"type": "string",
"example": "req_8f3a4b2c"
},
"doc_url": {
"type": "string",
"example": "https://developers.vibe.co/reference/oauth2token",
"nullable": true
}
},
"required": [
"type",
"message",
"status",
"request_id"
]
},
"ErrorResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ApiError"
}
},
"required": [
"error"
]
},
"App": {
"type": "object",
"properties": {
"app_id": {
"type": "string",
"description": "App identifier: Android package name, iOS bundle ID, or pixel ID"
},
"os": {
"type": "string",
"enum": [
"ANDROID",
"IOS",
"WEB"
],
"description": "Operating system / environment"
}
},
"required": [
"app_id",
"os"
]
},
"Advertiser": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
},
"industry": {
"type": "string"
},
"apps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/App"
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"name",
"url",
"industry",
"apps",
"created_at",
"updated_at"
]
},
"AdvertiserUpdate": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri",
"description": "The brand-owned website of the advertiser. Marketplace, app store and social media pages are rejected."
},
"industry": {
"type": "string",
"enum": [
"AUTOMOTIVE",
"EDUCATION",
"FINANCIAL_SERVICES",
"FOOD_DRINK",
"FOOD_DRINK_WINE",
"GAMING",
"GAMING_GAMBLING",
"HEALTH_FITNESS",
"HEALTH_FITNESS_ALTERNATIVE",
"HUNTING_SHOOTING",
"LAW_LEGAL_PRACTICE",
"MEDIA_ENTERTAINMENT",
"OTHER",
"POLITICS",
"PROFESSIONAL_SERVICES",
"REAL_ESTATE",
"RELIGION_SPIRITUALITY",
"RETAIL",
"TECHNOLOGY_TELECOMMUNICATIONS",
"TOBACCO_SMOKING",
"TRAVEL_HOSPITALITY"
]
}
}
}
}
},
"security": [
{
"bearer": []
}
]
}
```