Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте JSON корпусында өріс ретінде org_id қабылдайды.
Сіздің ұйым идентификаторыңыз басқару панеліндегі API кілттері экранында, кілттің өзінің жанында орналасқан. Бұл сіз жасайтын әрбір шақырудағы бірдей идентификатор.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
curl -X POST https://api.zinndigital.com/v1/agency/boards \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған 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.
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
name | string | Иә | — |
description | string | Жоқ | — |
org_id | string | Жоқ | — |
client_org_id | string | Жоқ | — |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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 `upda… |
Бұл соңғы нүкте қайтара алатын қателер
401 · 403 · 422