syndication

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

Rename a connection or replace its credential.

Pagpapatotoo

Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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

Mga Parameter

Pangalan	Uri	Kailangan	Ano ito
`connectionId (path)`	`string`	Oo	—

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`name`	`string`	Hindi	—
`credentials`	`object`	Hindi	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Tugon

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

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}