agency-board
POST /v1/agency/boards
Create a project board.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве поля в теле JSON.
Идентификатор вашей организации находится на экране ключей 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.
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
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