links
POST /v1/content/campaigns/{campaignId}/pause
Hold every article that has not started.
Authentication
Send an API key as a bearer token. The key must carry the links.edit 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/content/campaigns/{campaignId}/pause \
-H "Authorization: Bearer zdk_live_…"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
Holds every queued article. Acts only on articles that have not started — one already being written has been paid for, and one already published is on a customer's site, so pausing cannot mean un-publishing and must not appear to. affected is how many were actually held, so a screen can say "paused 8 of 12" rather than reporting a silent success the customer's own queue contradicts. Gated on links.edit.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
campaignId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
affected | integer | Yes | How many articles the action actually touched. A campaign of twelve with four already written reports 8 for a pause, so a screen can say "paused 8 of 12" rather than a silent… |
campaign | ContentCampaign | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422