syndication

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

Rename a connection or replace its credential.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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

Параметри

Назва	Тип	Обов'язкове	Що це таке
`connectionId (path)`	`string`	Так	—

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`name`	`string`	Ні	—
`credentials`	`object`	Ні	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`string`	Так	—
`channel`	`string`	Так	—
`name`	`string`	Так	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`	Так	The non-secret half — a handle, an instance, a board id.
`status`	`string<unverified, ready, needs_reconnect, error>`	Так	⛔⛔ `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`	Так	The account the VENDOR said this credential belongs to — discovered.
`verify_error`	`string`	Так	A machine code the dashboard turns into copy. Never a sentence.
`verified_at`	`string`	Так	—
`expires_at`	`string`	Так	⛔ `null` means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green.
`byo`	`boolean`	Так	Whether the customer supplied their own developer app.
`created_at`	`string`	Так	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}