ads
POST /v1/ads/connections/{connection_id}/tiktok/changes
Pause, resume, re-budget, re-bid, exclude audiences or add a negative keyword on TikTok — the click is the approval (TTFULL).
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}/tiktok/changes \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "action": <string<pause, enable, budget, bid, exclude_audiences, negative>>, "object_id": <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.tiktok_change. The object is read from TikTok first (the value it holds is kept as the Undo); the change is proposed and approved in one step, then sent by the apply workflow through the same gate as every write (kill switches, good standing, spend ceilings), with a 30-day Undo that puts back exactly what TikTok held. action: pause / enable (kind campaigns, adgroups or ads), budget (kind campaigns or adgroups, amount_micros), bid (an ad group, amount_micros), exclude_audiences (an ad group, audience_ids; needs TikTok's Audience management permission), negative (a Search Ads campaign, text, EXACT match). Refusals (422): noSuchConnection, netScopeNotGranted (TikTok said this grant cannot: reconnect), noSuchAd, netNotEditable (no budget or bid of its own, or nothing would change), paused, killed, disconnected, notInGoodStanding.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
connection_id (path) | string | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
action | string<pause, enable, budget, bid, exclude_audiences, negative> | Yes | — |
kind | string<campaigns, adgroups, ads> | No | — |
object_id | string | Yes | — |
amount_micros | integer | No | Micros of the account currency (1 unit = 1,000,000). |
audience_ids | string[] | No | — |
text | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
org_id | string | Yes | — |
connection_id | string | Yes | — |
action_class | string | Yes | — |
status | AdsChangeStatus | Yes | — |
summary | object | Yes | What the change does, for the card. SERVEWATCH adds serving_check (a bid-strategy switch simulated before the send: verdict ok · unknown · starves, strategy, reason,… |
budget_delta_minor | object | Yes | — |
proposed_by | string | Yes | Who proposed the change: who stored it (user:<id>, autopilot, mcp:<id>, apikey:<id>, …) — except a member of our staff, who reads support and never their id… |
proposed_by_kind | object | Yes | PROPOSERKIND: who proposed the change, as a kind the screen translates — the same words as a decision's decided_by_kind. person a member of this account's org; agency a… |
proposed_at | string | Yes | — |
decided_by | string | Yes | Who approved or declined it (autopilot when the audit made it by itself; a person who applied the audit's one-click suggestion is named here although proposed_by stays… |
decided_at | object | Yes | — |
applied_at | object | Yes | — |
undoable | boolean | Yes | — |
undo_until | object | Yes | — |
undone_at | object | Yes | — |
error | string | Yes | Why the change was not sent, its CODE leading (ceiling, killed, paused, holdReleased — GATE-PERSON r10: kept for a person while its campaign was held, and the hold was… |
decision_reason | string | No | za-104: the reason given with the decision. An agency's client must give one to reject on the approval portal; decided_by then reads… |
Errors this endpoint can return
400 · 401 · 403 · 404 · 422 · 429