Save or update an agency-owned campaign and selected inventory in the advertiser portal. The agency remains the owner and payer; clientName labels the client brief.
View input schema
{
"type": "object",
"properties": {
"advertisementId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"campaignName": {
"type": "string",
"minLength": 1,
"maxLength": 160
},
"clientName": {
"type": "string",
"maxLength": 160
},
"landingUrl": {
"type": "string",
"format": "uri",
"maxLength": 2000,
"description": "Client business or campaign landing page URL."
},
"screenIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 1000,
"default": []
},
"source": {
"type": "string",
"enum": [
"owned",
"vistar",
"mixed"
],
"default": "mixed"
},
"impressions": {
"type": "integer",
"exclusiveMinimum": 0
},
"budgetUsd": {
"type": "number",
"exclusiveMinimum": 0
},
"ownedBudgetUsd": {
"type": "number",
"exclusiveMinimum": 0
},
"partnerBudgetUsd": {
"type": "number",
"exclusiveMinimum": 0
},
"ownedImpressions": {
"type": "integer",
"exclusiveMinimum": 0
},
"partnerImpressions": {
"type": "integer",
"exclusiveMinimum": 0
},
"quoteId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"quoteIds": {
"type": "object",
"properties": {
"owned": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"partner": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"additionalProperties": false
},
"flightStart": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Local calendar date, YYYY-MM-DD."
},
"flightEnd": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Local calendar date, YYYY-MM-DD."
},
"startTime": {
"type": "string",
"default": "00:00"
},
"endTime": {
"type": "string",
"default": "23:59"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "IANA timezone for the local flight."
},
"providerPlan": {
"anyOf": [
{
"type": "object",
"properties": {
"advertisementId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"geography": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
},
"radius": {
"type": "object",
"properties": {
"center": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"lng": {
"type": "number",
"minimum": -180,
"maximum": 180
}
},
"required": [
"lat",
"lng"
],
"additionalProperties": false
},
"miles": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 500
}
},
"required": [
"center",
"miles"
],
"additionalProperties": false
},
"markets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"country": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"code": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"country",
"code"
],
"additionalProperties": false
},
"maxItems": 50
},
"postalCodes": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 200
},
"countryCode": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"polygon": {
"type": "array",
"items": {
"type": "object",
"properties": {
"lat": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"lng": {
"type": "number",
"minimum": -180,
"maximum": 180
}
},
"required": [
"lat",
"lng"
],
"additionalProperties": false
},
"minItems": 3,
"maxItems": 100
}
},
"additionalProperties": false
},
"budgetUsd": {
"type": "number",
"exclusiveMinimum": 0
},
"flightStart": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Local calendar date, YYYY-MM-DD."
},
"flightEnd": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Local calendar date, YYYY-MM-DD."
},
"channels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ctv",
"video",
"audio",
"display"
]
},
"minItems": 1,
"maxItems": 4
},
"selectedProductIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 100
},
"personaIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 50
},
"intuiziSegmentIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 50
},
"packageAudienceLens": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"contextualTargeting": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 100
},
"contextualAvoidance": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 100
},
"audience": {
"type": "object",
"properties": {
"age_range": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
},
"income_range": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
},
"culture": {
"type": "array",
"items": {
"type": "string",
"enum": [
"white",
"black",
"asian",
"american_indian",
"hispanic"
]
},
"minItems": 1
},
"education": {
"type": "array",
"items": {
"type": "string",
"enum": [
"hs_or_less",
"some_college",
"bachelors",
"graduate"
]
},
"minItems": 1
},
"gender": {
"type": "array",
"items": {
"type": "string",
"enum": [
"male",
"female"
]
},
"minItems": 1
},
"language": {
"type": "array",
"items": {
"type": "string",
"enum": [
"english_only",
"spanish",
"other_indo_european",
"asian_pacific",
"other"
]
},
"minItems": 1
},
"life_stage": {
"type": "array",
"items": {
"type": "string",
"enum": [
"new_movers",
"settled",
"long_tenured",
"married",
"singles",
"new_parents",
"empty_nesters"
]
},
"minItems": 1
},
"household": {
"type": "boolean"
},
"lifestyle": {
"type": "object",
"additionalProperties": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"propertyNames": {
"minLength": 1
}
},
"interests": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
"intent": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
"place": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
"venue_concept": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
{
"type": "object",
"additionalProperties": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 100
},
"propertyNames": {
"minLength": 1
}
}
]
},
"hard": {
"type": "boolean"
},
"min_fit": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"additionalProperties": false
},
"targeting": {
"type": "object",
"properties": {
"personaIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 50
},
"intuiziSegmentIds": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 50
},
"packageAudienceLens": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"contextualTargeting": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 100
},
"contextualAvoidance": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"maxItems": 100
},
"audience": {
"type": "object",
"properties": {
"age_range": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
},
"income_range": {
"type": "array",
"minItems": 2,
"maxItems": 2,
"items": {
"type": "number"
}
},
"culture": {
"type": "array",
"items": {
"type": "string",
"enum": [
"white",
"black",
"asian",
"american_indian",
"hispanic"
]
},
"minItems": 1
},
"education": {
"type": "array",
"items": {
"type": "string",
"enum": [
"hs_or_less",
"some_college",
"bachelors",
"graduate"
]
},
"minItems": 1
},
"gender": {
"type": "array",
"items": {
"type": "string",
"enum": [
"male",
"female"
]
},
"minItems": 1
},
"language": {
"type": "array",
"items": {
"type": "string",
"enum": [
"english_only",
"spanish",
"other_indo_european",
"asian_pacific",
"other"
]
},
"minItems": 1
},
"life_stage": {
"type": "array",
"items": {
"type": "string",
"enum": [
"new_movers",
"settled",
"long_tenured",
"married",
"singles",
"new_parents",
"empty_nesters"
]
},
"minItems": 1
},
"household": {
"type": "boolean"
},
"lifestyle": {
"type": "object",
"additionalProperties": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"propertyNames": {
"minLength": 1
}
},
"interests": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
"intent": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
"place": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
"venue_concept": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1
},
{
"type": "object",
"additionalProperties": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 100
},
"propertyNames": {
"minLength": 1
}
}
]
},
"hard": {
"type": "boolean"
},
"min_fit": {
"type": "number",
"minimum": 0,
"maximum": 1
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": [
"budgetUsd",
"flightStart",
"flightEnd",
"channels"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"idempotency_key": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Stable unique key for this action. Reuse this key and unchanged arguments when retrying."
}
},
"required": [
"flightStart",
"flightEnd",
"idempotency_key"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}