ads

PATCH /v1/ads/connections/{connection_id}/competitor-groups

Edit a competitor ad group threshold; null puts it back on Recommended (audited).

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}/competitor-groups \
  -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.competitor_groups_update. Each field is a whole number inside its bounds (see settings.<field>.min/max in the GET), or null for the Recommended value. Any unknown field or out-of-range value refuses the whole request with competitorGroupsInvalid (nothing is half-applied).

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
block_free_hostsobjectNoza-71: block searches for a free host. null = Recommended (on).
block_off_marketobjectNoza-71: block a local brand searched outside its market. null = Recommended (on).
min_impressionsobjectNo—
min_clicksobjectNo—
lookback_daysobjectNo—
max_keywordsobjectNo—
rivalsobjectNoza-73: add or dismiss competitors found on the account, by name (from found_rivals). An unknown name or value refuses the whole request (competitorGroupsInvalid, field rivals).

Response

NameTypeRequiredWhat it is
dataobjectYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429