ads

PATCH /v1/ads/connections/{connection_id}/brand-watch

Edit the competitor watch — switch, thresholds, extra brand terms (za-N9).

All ads endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the ads.manage permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PATCH https://api.zinndigital.com/v1/ads/connections/{connection_id}/brand-watch \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Gated on ads.manage; audit action ads.brand_watch_update. Every threshold is the customer's: a whole number inside its bounds, or null to reset it to Recommended. terms replaces the extra brand terms (lower-cased, de-duplicated; the build plan's brand is always watched). 422 brandWatchInvalid names the field (unknown fields are refused).

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
enabledbooleanNo—
min_share_pctobjectNo—
top_floor_pctobjectNo—
rank_lost_pctobjectNo—
min_impressionsobjectNo—
termsstring[]No—

Response

NameTypeRequiredWhat it is
dataAdsBrandWatchYesza-N9 (docs/1006 §80) — a connection's competitor watch: its settings, and the competitors seen bidding on its brand terms.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429