links
POST /v1/content/campaigns
Schedule a run of articles across a window.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
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 \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "brief": <string>, "posts": <integer> }'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
Creates one queued article per topic, each targeting every site the campaign resolved to, each with its own moment inside the drip window. Gated on links.edit. Nothing is started by this call. The articles are queued as pending runs and a Temporal sweep starts each when its moment arrives — so the request path carries no long work, generation cost is spread across the window rather than paid upfront, and a campaign created during a Temporal outage is visible and simply starts late. Refused with 422 when the account is not in good standing: we do not spend money on an account that is not being paid for.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | Narrow to one organisation. A reseller managing several client organisations reads the wrong one without it — and on a footprint-free network, another operator's posting schedule… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
brief | string | Yes | The standing instruction — voice, audience, what the sites are about. |
posts | integer | Yes | How many ARTICLES to write. Each is placed on every target site, so the number of publications is this times the site count. |
topics | string[] | No | One subject per article, so N articles are N articles rather than N paraphrases. A shorter list cycles; an empty one means the brief alone. |
site_ids | string[] | No | — |
site_group_id | string | No | A site group, resolved when the campaign is created rather than copied. A recurring schedule pointed at a group re-resolves it on every firing, so sites added later are… |
drip_days | integer | No | Spread the articles across this many days. 0 publishes them together. |
drip_jitter_minutes | integer | No | Randomise each moment by up to this many minutes either way. Perfectly even spacing is more detectable than posting all at once — nothing a person does is that regular — so this… |
anchors | ContentRunAnchor[] | No | — |
category | string | No | — |
publish_policy | ContentRunPublishPolicy | No | How far a run may go on its own. draft_only is the default and puts nothing live. |
recipe_id | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
campaign_id | string | Yes | — |
targets | ContentCampaignTargets | Yes | — |
posts | ContentCampaignPlannedPost[] | Yes | — |
total_articles | integer | Yes | Articles written. One per topic. |
total_placements | integer | Yes | Individual publications — articles times sites. The number that reads as "how much am I about to do", and the one the spend estimate is built on. |
first_at | string | No | — |
last_at | string | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422