agency-board
PATCH /v1/agency/boards/{boardId}/columns/{columnId}
Rename a column, change what the client sees, or make it the intake column.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/columns/{columnId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
⛔ Setting `visibility` to `internal` hides **every card in the column** from the client at once, by the AND rule — nothing is rewritten on the cards, so setting it back to `client` restores exactly the previous state rather than a guess at it. `is_intake: true` moves the client's "raise a request" column here; at most one column per board holds it, and the previous one is cleared in the same transaction.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
boardId (path) | Uuid | Да | Project board ID (UUIDv7). |
columnId (path) | Uuid | Да | Board column ID (UUIDv7). |
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
name | string | Нет | — |
visibility | AgencyBoardVisibility | Нет | Who may see this object. `internal` is always the default. A **card** reaches the client only when it is `client` **and its column is too** — an AND, not inheritance, because th… |
wip_limit | integer | Нет | — |
position | integer | Нет | — |
is_intake | boolean | Нет | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
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 | Да | — |
position | integer | Да | — |
visibility | AgencyBoardVisibility | Да | Who may see this object. `internal` is always the default. A **card** reaches the client only when it is `client` **and its column is too** — an AND, not inheritance, because th… |
is_intake | boolean | Да | The single column a client may raise a request in. At most one per board. |
wip_limit | integer | Нет | Advisory only, shown in the UI. ⛔ It never refuses a move: a WIP limit that blocks work turns a management convention into an outage on a Friday evening. |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 422