ads
PATCH /v1/ads/connections/{connection_id}/paid-geo
The mode and the customer's own thresholds for paid revenue by country and device (za-168).
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}/paid-geo \
-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.paid_geo_settings (before and after). mode: off (not read), suggest (every proposal waits for approval; recommended), auto (each proposal is approved at once where the action class — campaigns for a country campaign, bids for a device modifier — is Automatic; the apply gate still checks the kill switches, the spend ceilings and good standing). A threshold set to null goes back to the recommended value; outside its min..max it is refused (422). Takes effect at the next daily audit.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
connection_id (path) | string | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
mode | string<off, suggest, auto> | No | — |
window_days | object | No | — |
min_sales | object | No | — |
country_share_pct | object | No | — |
device_gap_pct | object | No | — |
device_step_pct | object | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
data | AdsPaidGeo | Yes | za-168 (docs/1006 §PAIDGEO) — paid revenue by country and device. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429