ads
POST /v1/ads/connections/{connection_id}/allowed-terms
Allow a competitor's name in ONE ad group's ad text (audited).
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 POST https://api.zinndigital.com/v1/ads/connections/{connection_id}/allowed-terms \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "ad_group_id": <string>, "term": <string> }'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.allowed_term_add. ad_group_id is the ad group's id or resource name (as the ads list returns it); term the company name (up to 60 characters). The name stays refused in every other ad group. Allowing a name already allowed there changes nothing (200); a new or re-allowed one answers 201. Refusal codes: allowNoAdGroup, allowTermEmpty, allowTermTooLong.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
connection_id (path) | string | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
ad_group_id | string | Yes | — |
ad_group_name | string | No | — |
term | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | AdsAllowedTerm | Yes | One competitor name allowed in ONE ad group's ad text (za-237, docs/1006 §53). |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429