agency-board
PATCH /v1/agency/boards/{boardId}/inbound-endpoints/{endpointId}
Rename an endpoint, or pause and resume it.
પ્રમાણીકરણ
બિયરર ટૉકન તરીકે API કી મોકલો. આ એન્ડપૉઇન્ટ સ્પેશિફિકેશનમાં કોઈ ચોક્કસ પરવાનગી જણાવતું નથી, તેથી ધારણા બાંધવાને બદલે તમારી કીને તેની જરૂરિયાત મુજબ ન્યૂનતમ પરવાનગી આપો અને રિસ્પોન્સ તપાસો.
આ એન્ડપૉઇન્ટ કોઈ સંસ્થા આઈડી (organisation id) લેતું નથી. તમારી કી (key) પહેલેથી જ તે જે સંસ્થા સાથે સંબંધિત છે તેની ઓળખ કરે છે, અને પ્રતિસાદ (response) તે જ પૂરતો મર્યાદિત છે.
આયમાવો
કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.
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