Skip to main content
POST
/
advertisers
/
{advertiserId}
/
catalogs
/
{catalogId}
/
activation-plan
/
preview
Preview catalog activation plan
curl --request POST \
  --url https://api.interchange.io/api/v2/buyer/advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "plan": {
    "planId": "<string>",
    "catalogId": "<string>",
    "platformCatalogId": "<string>",
    "catalogVersionId": "<string>",
    "transformId": "<string>",
    "planHash": "<string>",
    "itemCount": 4503599627370495,
    "campaignGroups": [
      {
        "key": "<string>",
        "name": "<string>",
        "fieldValues": {},
        "itemIds": [
          "<string>"
        ],
        "itemCount": 4503599627370495,
        "budget": {
          "amount": 1,
          "currency": "<string>"
        }
      }
    ],
    "creativeAssets": [
      {
        "key": "<string>",
        "prompt": "<string>",
        "fieldValues": {},
        "itemIds": [
          "<string>"
        ],
        "itemCount": 4503599627370495
      }
    ],
    "syndicationTargets": [
      {
        "adcpAgentId": "<string>",
        "usesTransformedCatalog": true,
        "requiresCreativeAssembly": true,
        "creativeAgentId": "<string>",
        "reason": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

advertiserId
string
required

Advertiser ID

Minimum string length: 1
catalogId
string
required

Buyer-assigned catalog_id or platform catalog id returned by list catalogs

Minimum string length: 1

Body

application/json
transform
object

Optional ad hoc transform. If omitted, the active catalog transform is used.

adcpAgentIds
string[]

Optional seller agents to evaluate for upstream catalog/creative syndication. If omitted, enabled catalog syndication targets are used.

Minimum string length: 1
save
boolean
default:false

Persist this activation plan against the latest catalog version. Requires an active saved transform when transform is omitted.

Response

Preview catalog activation plan

plan
object
required