syndication

POST `/v1/syndication/connections`

Connect a social account.

Authentication

Send an API key as a bearer token. The key must carry the syndication.manage 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/syndication/connections \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "channel": <string>, "name": <string>, "credentials": <object> }'

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

Stores the credential in Vault and the pointer on the row, then probes it immediately so the customer learns now whether it works rather than when their next article publishes. Gated on syndication.manage, which is a separate key from links.edit because this posts publicly on the customer's own brand accounts.

Parameters

Name	Type	Required	What it is
`org_id (query)`	`string`	No	Which organisation to connect it for, within the caller's subtree. ⛔ Scoped by `syndication.manage`, never by the reading key — a member holding only view on a client org must not…

Request body

Name	Type	Required	What it is
`channel`	`string`	Yes	—
`name`	`string`	Yes	—
`credentials`	`object`	Yes	Every value the channel's `fields` name. The secret half goes to Vault and is never returned.
`byo`	`boolean`	No	—

Response

Name	Type	Required	What it is
`id`	`string`	Yes	—
`channel`	`string`	Yes	—
`name`	`string`	Yes	The customer's own name for it. ⛔ `name` on the wire, `label` on the model: `Field.label` is DRF's own attribute and shadowing it is silent at runtime.
`target`	`string`	Yes	The non-secret half — a handle, an instance, a board id.
`status`	`string<unverified, ready, needs_reconnect, error>`	Yes	⛔⛔ `needs_reconnect` is NOT a failure — the credential lapsed and only the customer can fix it. `unverified` means we have not looked, which is a third fact and not a quiet green.
`account_ref`	`string`	Yes	The account the VENDOR said this credential belongs to — discovered.
`verify_error`	`string`	Yes	A machine code the dashboard turns into copy. Never a sentence.
`verified_at`	`string`	Yes	—
`expires_at`	`string`	Yes	⛔ `null` means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green.
`byo`	`boolean`	Yes	Whether the customer supplied their own developer app.
`created_at`	`string`	Yes	—

Errors this endpoint can return

401 · 403 · 422