agency-board

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

Rename an endpoint, or pause and resume it.

Autentikasi

Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Parameter

Nama	Jenis	Wajib	Tentang apa ini
`boardId (path)`	`Uuid`	Ya	Project board ID (UUIDv7).
`endpointId (path)`	`Uuid`	Ya	Inbound endpoint ID (UUIDv7).

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`name`	`string`	Ya	—
`signature_scheme`	`string<zinn, github>`	Tidak	`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>`	Tidak	—

Tanggapan

Nama	Jenis	Wajib	Tentang apa ini
`id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ya	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ya	—
`endpoint_key`	`string`	Ya	The opaque path segment. Not the board id, and unchanged by a secret rotation.
`url`	`string`	Tidak	The full URL to paste into the sending system.
`signature_scheme`	`string<zinn, github>`	Ya	—
`status`	`BoardAutomationStatus`	Ya	`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`	Ya	—
`request_count`	`integer`	Tidak	—
`rejected_count`	`integer`	Tidak	—
`last_rejection`	`string`	Tidak	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`	Tidak	—
`created_at`	`string`	Tidak	—

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422

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