syndication

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

Rename a connection or replace its credential.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

⛔ 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

Naziv	Vrsta	Obavezno	Što je to
`connectionId (path)`	`string`	Da	—

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`name`	`string`	Ne	—
`credentials`	`object`	Ne	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Odgovor

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

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}