agency-board

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

Rename an endpoint, or pause and resume it.

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.

Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

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

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Tham số

Tên	Loại	Bắt buộc	Nội dung này là gì
`boardId (path)`	`Uuid`	Có	Project board ID (UUIDv7).
`endpointId (path)`	`Uuid`	Có	Inbound endpoint ID (UUIDv7).

Nội dung yêu cầu

Tên	Loại	Bắt buộc	Nội dung này là gì
`name`	`string`	Có	—
`signature_scheme`	`string<zinn, github>`	Không	`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>`	Không	—

Phản hồi

Tên	Loại	Bắt buộc	Nội dung này là gì
`id`	`Uuid`	Có	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Có	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Có	—
`endpoint_key`	`string`	Có	The opaque path segment. Not the board id, and unchanged by a secret rotation.
`url`	`string`	Không	The full URL to paste into the sending system.
`signature_scheme`	`string<zinn, github>`	Có	—
`status`	`BoardAutomationStatus`	Có	`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`	Có	—
`request_count`	`integer`	Không	—
`rejected_count`	`integer`	Không	—
`last_rejection`	`string`	Không	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`	Không	—
`created_at`	`string`	Không	—

Các lỗi điểm cuối này có thể trả về

401 · 403 · 404 · 422

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