agency-board

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

Rename an endpoint, or pause and resume it.

การยืนยันตัวตน

ส่ง API key เป็น 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}