syndication
POST /v1/syndication/connections/{connectionId}/verify
Check a connection against the live channel.
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.
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/syndication/connections/{connectionId}/verify \
-H "Authorization: Bearer zdk_live_…"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
⛔ A failure is a 200 carrying a non-ready status, not an error response — "we could not reach it" is the answer to the question that was asked. Three outcomes: ready, needs_reconnect (the customer must act) and error (we reached the vendor and it said no for another reason). Gated on syndication.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
connectionId (path) | string | Yes | — |
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 · 404