syndication

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

Rename a connection or replace its credential.

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

⛔ 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`.

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`connectionId (path)`	`string`	Sì	—

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`name`	`string`	No	—
`credentials`	`object`	No	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Risposta

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

Errori che questo endpoint può restituire

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}