Skip to main content
PUT /api/v2/buyer/advertisers/{advertiserId} Updates an existing advertiser. All body fields are optional — send only what you want to change. sandbox cannot be changed after creation.

​
Request

curl
curl -X PUT https://api.interchange.io/api/v2/buyer/advertisers/12345 \
  -H "Authorization: Bearer $SCOPE3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corporation",
    "optimizationApplyMode": "AUTO",
    "frequencyCaps": [
      { "max_impressions": 5, "window": { "interval": 7, "unit": "days" } }
    ]
  }'

​
Parameters

FieldTypeRequiredNotes
advertiserIdstring (path)YesUnique identifier for the advertiser
namestringNoUpdated name (1–255 chars)
descriptionstringNoUpdated description (max 1000 chars)
brandstringNoUpdated brand domain. Re-resolves the brand reference
optimizationApplyModeenumNoAUTO or MANUAL
campaignBudgetTypeenumNototal_budget
primaryCurrencystringNoISO 4217 code. Only changeable when existing non-archived campaign budgets already use it
linkedAccountsarrayNoAccounts to add. Existing links are not removed. Each item may include credentialId from list available accounts to disambiguate duplicate account IDs across connected credentials
utmConfigarrayNoReplaces all seat-level UTM params. Pass [] to clear
dataDeliveryobjectNoData-delivery configuration. Omit to leave existing config untouched
dataDelivery.credentialsarrayNoReplaces all existing live credentials. Pass [] to archive all
dataDelivery.outputsarrayNoReplaces all existing advertiser-scoped Data Delivery Outputs. Pass [] to clear
frequencyCapsarrayNoReplaces all existing non-archived caps. Pass [] to clear; omit to leave untouched

​
Response

{
  "id": "12345",
  "name": "Acme Corporation",
  "description": null,
  "status": "ACTIVE",
  "sandbox": false,
  "optimizationApplyMode": "AUTO",
  "campaignBudgetType": "total_budget",
  "primaryCurrency": "USD",
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-20T14:45:00Z",
  "brand": "acme.com",
  "linkedAccounts": [],
  "utmConfig": [],
  "frequencyCaps": []
}
Returns the full advertiser resource with the applied changes.
linkedAccounts is additive (existing links stay), but utmConfig and frequencyCaps replace their entire existing set. Pass an empty array to clear, or omit the field to leave it untouched.

​
Errors

  • 400 VALIDATION_ERROR — invalid field value, or a primaryCurrency change blocked by existing campaign budgets.
  • 404 NOT_FOUND — advertiserId does not exist or is not visible to the authenticated customer.
See Errors for the full error contract.

Advertiser tasks

All advertiser operations

Advertiser overview

Fields, lifecycle, and concepts

Get advertiser

Read the current state first

Delete advertiser

Archive when done