Toggle syndication

Deprecated. This page documents the v2 buyer API, which is closed to new API clients and switches off on 1 December 2026. Use V3 instead: see Move a v2 buyer REST integration to V3. The conversion endpoint, Log event, stays open.

POST /api/v2/buyer/advertisers/{advertiserId}/syndicate Toggles syndication ON or OFF for an audience, event source, or catalog to one or more ADCP agents. Returns one status record per agent immediately. The sync itself is asynchronous — poll Get syndication status to confirm each record reaches COMPLETED.

Request

curl -X POST https://api.apostra.com/api/v2/buyer/advertisers/12345/syndicate \
  -H "Authorization: Bearer $SCOPE3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resourceType": "AUDIENCE",
    "resourceId": "aud_88f0",
    "adcpAgentIds": ["42", "57"],
    "enabled": true
  }'

Parameters

Field	Type	Required	Notes
`advertiserId`	string (path)	Yes	Advertiser that owns the resource
`resourceType`	enum	Yes	`AUDIENCE`, `EVENT_SOURCE`, or `CATALOG`
`resourceId`	string	Yes	ID of the resource being syndicated
`adcpAgentIds`	string[]	Yes	One or more ADCP agent IDs. At least one required
`enabled`	boolean	Yes	`true` turns syndication on, `false` turns it off

Response

[
  {
    "id": "1",
    "customerId": 7,
    "advertiserId": "12345",
    "resourceType": "AUDIENCE",
    "resourceId": "aud_88f0",
    "audienceId": "1",
    "eventSourceId": null,
    "catalogId": null,
    "adcpAgentId": "42",
    "adcpAgentAccountId": null,
    "enabled": true,
    "status": "PENDING",
    "errorMessage": null,
    "responseData": null,
    "createdAt": "2026-06-06T17:00:00.000Z",
    "updatedAt": "2026-06-06T17:00:00.000Z",
    "completedAt": null
  }
]

The payload carries one record per agent in adcpAgentIds. Records start at status: "PENDING"; completedAt is null until the async sync finishes. For a seller that has no separate agent record, adcpAgentId is the seller’s public key (for a hosted Storefront, storefront-<platformId>) instead of a numeric id.

Errors

400 VALIDATION_ERROR — unknown resourceType, empty adcpAgentIds, or a missing required field.

See Errors for the full error contract.

Syndication tasks

All syndication operations

Get syndication status

Confirm the async sync completed

Start building

Core Concepts

Buyer operations

Seller operations

Cross-Cutting Reference

Buyer API reference

Seller API reference

Release Notes

Toggle syndication

Request

Parameters

Response

Errors

Syndication tasks

Get syndication status

​Request

​Parameters

​Response

​Errors

​Related

Syndication tasks

Get syndication status

Request

Parameters

Response

Errors

Related