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, за да можете да видите действителния отговор. Отворете този крайpoint в 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`	Да	—

Грешки, които този крайpoint може да върне

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}