links

POST /v1/content/run-schedules

Post to these sites every N hours.

All links endpoints

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.

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

NameTypeRequiredWhat it is
briefstringNo
site_idsstring[]No
anchorsContentRunAnchor[]No
categorystringNo
publish_policyContentRunPublishPolicyNoHow far a run may go on its own. `draft_only` is the default and puts nothing live.
interval_hoursintegerNo
enabledbooleanNo
recipe_idstringNo

Response

NameTypeRequiredWhat it is
idstringYes
enabledbooleanYes
interval_hoursintegerYes
next_run_atstringYes
last_run_atstringNo
last_run_idstringNo
briefstringYes
categorystringNo
publish_policyContentRunPublishPolicyYesHow far a run may go on its own. `draft_only` is the default and puts nothing live.
site_idsstring[]Yes
recipe_idstringNo

Errors this endpoint can return

401 · 403 · 422