syndication

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

Rename a connection or replace its credential.

Pengesahan

Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

⛔ 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	Diperlukan	Apakah ia
`connectionId (path)`	`string`	Ya	—

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`name`	`string`	Tidak	—
`credentials`	`object`	Tidak	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Respons

Nama	Jenis	Diperlukan	Apakah ia
`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	—

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}