syndication

PUT `/v1/syndication/connections/{connectionId}`

Rename a connection or replace its credential.

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X PUT https://api.zinndigital.com/v1/syndication/connections/{connectionId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

⛔ Omitting `credentials` KEEPS the stored credential rather than clearing it — a customer renaming a connection must not silently delete their token. Gated on `syndication.manage`.

Parameters

Naam	Type	Verplicht	Wat dit is
`connectionId (path)`	`string`	Ja	—

Aanvraaglichaam

Naam	Type	Verplicht	Wat dit is
`name`	`string`	Nee	—
`credentials`	`object`	Nee	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Reactie

Naam	Type	Verplicht	Wat dit is
`id`	`string`	Ja	—
`channel`	`string`	Ja	—
`name`	`string`	Ja	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`	Ja	The non-secret half — a handle, an instance, a board id.
`status`	`string<unverified, ready, needs_reconnect, error>`	Ja	⛔⛔ `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`	Ja	The account the VENDOR said this credential belongs to — discovered.
`verify_error`	`string`	Ja	A machine code the dashboard turns into copy. Never a sentence.
`verified_at`	`string`	Ja	—
`expires_at`	`string`	Ja	⛔ `null` means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green.
`byo`	`boolean`	Ja	Whether the customer supplied their own developer app.
`created_at`	`string`	Ja	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}