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}