agency-board

PATCH `/v1/agency/boards/{boardId}/inbound-endpoints/{endpointId}`

Rename an endpoint, or pause and resume it.

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

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

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

Спробувати

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

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/inbound-endpoints/{endpointId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

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

Параметри

Назва	Тип	Обов'язкове	Що це таке
`boardId (path)`	`Uuid`	Так	Project board ID (UUIDv7).
`endpointId (path)`	`Uuid`	Так	Inbound endpoint ID (UUIDv7).

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`name`	`string`	Так	—
`signature_scheme`	`string<zinn, github>`	Ні	`zinn` verifies `X-Zinn-Signature` over "<timestamp>.<body>"; `github` verifies GitHub's own `X-Hub-Signature-256` over the body. One route, one rate limiter, one log, whichever…
`status`	`string<enabled, disabled>`	Ні	—

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`Uuid`	Так	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Так	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Так	—
`endpoint_key`	`string`	Так	The opaque path segment. Not the board id, and unchanged by a secret rotation.
`url`	`string`	Ні	The full URL to paste into the sending system.
`signature_scheme`	`string<zinn, github>`	Так	—
`status`	`BoardAutomationStatus`	Так	`suspended` means WE paused it after repeated failure and it carries a reason the customer has not read. It is a third state rather than a reuse of `disabled`, because collapsin…
`has_secret`	`boolean`	Так	—
`request_count`	`integer`	Ні	—
`rejected_count`	`integer`	Ні	—
`last_rejection`	`string`	Ні	Why the last refused request was refused — so "my n8n node says 404" is answerable from this screen rather than from a support ticket.
`last_seen_at`	`string`	Ні	—
`created_at`	`string`	Ні	—

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

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}/inbound-endpoints/{endpointId}