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.
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/link-sets \
-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
Gated on links.edit. Shares are optional: leave every one blank and the links rotate evenly; set some and the rest share what is left. A set whose shares cannot be resolved is refused with a sentence naming the total, not a code.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | No | — |
notes | string | No | — |
is_archived | boolean | No | — |
entries | LinkSetEntry[] | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | — |
notes | string | Yes | — |
is_archived | boolean | Yes | An archived set is hidden from the picker and takes no new recipes; the recipes already using it keep working. Archiving is offered where deleting is refused. |
entries | LinkSetEntry[] | Yes | — |
created_at | string | Yes | — |
updated_at | string | Yes | — |
recipe_count | integer | Yes | How many recipes point at this set — so a delete button can say so first. |
distribution | object[] | Yes | The resolved share of every (URL, wording) pair, summing to 100 — what will actually happen. Computed by the same function a run uses. |
distribution_error | string | Yes | Why there is no distribution, or empty. Separate from distribution because an empty list also means "this set has no links", and one value for two facts is not an answer. |
Errors this endpoint can return
401 · 403 · 422