links
POST /v1/content/run-schedules
Post to these sites every N hours.
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/run-schedules \
-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
Creates a cadence. The first run happens one interval from now, not immediately — a customer setting up a daily schedule at 4pm expects one tomorrow, not one before they have finished reading the form. Gated on links.edit. The cadence is served by a durable workflow on the worker, not by a job that calls this API back, so a scheduled run behaves identically to one started by hand. Minimum interval is one hour: anything finer on a private network is a footprint.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
brief | string | No | — |
site_ids | string[] | No | — |
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. |
interval_hours | integer | No | — |
enabled | boolean | No | — |
recipe_id | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
enabled | boolean | Yes | — |
interval_hours | integer | Yes | — |
next_run_at | string | Yes | — |
last_run_at | string | No | — |
last_run_id | string | No | — |
brief | string | Yes | — |
category | string | No | — |
publish_policy | ContentRunPublishPolicy | Yes | How far a run may go on its own. draft_only is the default and puts nothing live. |
site_ids | string[] | Yes | — |
recipe_id | string | No | — |
Errors this endpoint can return
401 · 403 · 422