syndication

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

Rename a connection or replace its credential.

Autentikasi

Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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

Parameter

Nama	Jenis	Wajib	Tentang apa ini
`connectionId (path)`	`string`	Ya	—

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`name`	`string`	Tidak	—
`credentials`	`object`	Tidak	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Tanggapan

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

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}