Նույնականացում
Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:
Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն
Այս վերջնակետը JSON մարմնում որպես դաշտ վերցնում է org_id-ը։
Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:
Փորձել
Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:
curl -X POST https://api.zinndigital.com/v1/agency/boards \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում
Մանրամասներ
Creates the board and a working default pipeline — Requests · Backlog · In progress · Review · Done — with Requests marked as the client intake column and Requests, In progress and Done already client-visible. ⛔ Not a placeholder (§2.41): the board is usable by an agency and by its client the moment it exists, rather than after a configuration step nobody documents. Requires the agency_project_board entitlement on the acting org.
Հարցման մարմին
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
name | string | Այո | — |
description | string | Ոչ | — |
org_id | string | Ոչ | — |
client_org_id | string | Ոչ | — |
Պատասխան
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
id | Uuid | Այո | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Այո | The agency that owns this board. |
client_org_id | string | Ոչ | The client organisation this board's work is for, if any. This is what authorises a client's read — never the org tree, because "is a descendant of the agency" is a weaker claim… |
client_org_name | string | Ոչ | That client organisation's name, resolved by the engine. client_org_id set with this null is a real state and not an error — the board names a client the caller may not read —… |
name | string | Այո | — |
description | string | Ոչ | — |
archived_at | string | Ոչ | — |
open_question_count | integer | Ոչ | — |
created_at | string | Այո | — |
updated_at | string | Ոչ | — |
created_by | AgencyBoardActor | Ոչ | Who created the board. null if that account no longer exists. |
updated_by | AgencyBoardActor | Ոչ | Who last changed the board itself — its name, description or client organisation. ⛔ NOT "who last touched anything on it": that is the activity feed. It moves exactly when… |
Այս վերջնակետի կողմից վերադարձվող սխալները
401 · 403 · 422