agency-board
PATCH /v1/agency/boards/{boardId}/inbound-endpoints/{endpointId}
Rename an endpoint, or pause and resume it.
Баталгаажуулалт
API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Энэхүү төгсгөлийн цэг нь тодорхойлолтдоо тодорхой зөвшөөрлийг заагаагүй тул түлхүүрээрээ шаардагдах хамгийн бага эрхийг өгч, таамаглахаас илүүтэйгээр хариуг шалгана уу.
Энэ төгсгөл цэг нь ямар ч байгууллагын ID шаардахгүй. Таны түлхүүр аль хэдийн харьяалагдах байгууллагыг тодорхойлж байгаа бөгөөд хариу нь тухайн байгууллагын хүрээнд хязгаарлагдана.
Туршиж үзэх
Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.
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 консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй 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