Skip to main content
PATCH
Change only the named fields of a product for an ad server source

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

esaId
integer
required

Ad server source connection id. The wire field remains esaId for API compatibility.

Required range: 0 < x <= 9007199254740991
Example:

123

productId
string
required

Upstream product id for the ad server source.

Minimum string length: 1
Example:

"prod_abc"

Body

application/json

Partial change body for an ad-server-source product. Only the fields present are applied; an omitted field — or one sent as null — keeps its stored value, and inventory merges one level deep. The exceptions are included_age_signal and audience_evidence, which null clears, and fixed_targeting, which merges part by part (geo, key_values.include, key_values.exclude: omit keeps, null removes) and whose top-level null removes all of it. Unknown/extra fields are forwarded as-is.

wholesale_product_id
string | null
Required string length: 1 - 100
name
string | null
Required string length: 1 - 200
description
string | null
status
string | null
delivery_type
string | null
channels
enum<string>[] | null
Available options:
display
format_options
object[] | null
inventory
object | null
pricing_options
object[] | null
included_age_signal
object | null

The fixed age cohort the product's inventory delivers to, published to AdCP 3.2 buyers as an included signal.

audience_evidence
object[] | null

AdCP 3.2 audience_evidence entries: planning evidence about who the inventory reaches, never targeting.

Minimum array length: 1
fixed_targeting
object | null

Targeting every line item booked from the product carries. Merged part by part: omit keeps a part, null removes it; null here removes all of it.

overlay_support
object | null

AdCP 3.2 overlay_support: the targeting dimensions a buyer may set. null keeps the stored declaration.

{key}
any

Response

Change only the named fields of a product for an ad server source