agency-board

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

Rename an endpoint, or pause and resume it.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Parametry

Název	Typ	Požadováno	Co to je
`boardId (path)`	`Uuid`	Ano	Project board ID (UUIDv7).
`endpointId (path)`	`Uuid`	Ano	Inbound endpoint ID (UUIDv7).

Tělo požadavku

Název	Typ	Požadováno	Co to je
`name`	`string`	Ano	—
`signature_scheme`	`string<zinn, github>`	Ne	`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>`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ano	—
`endpoint_key`	`string`	Ano	The opaque path segment. Not the board id, and unchanged by a secret rotation.
`url`	`string`	Ne	The full URL to paste into the sending system.
`signature_scheme`	`string<zinn, github>`	Ano	—
`status`	`BoardAutomationStatus`	Ano	`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`	Ano	—
`request_count`	`integer`	Ne	—
`rejected_count`	`integer`	Ne	—
`last_rejection`	`string`	Ne	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`	Ne	—
`created_at`	`string`	Ne	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422

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