agency-board

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

Rename an endpoint, or pause and resume it.

אימות

שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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}