agency-board

PATCH `/v1/agency/boards/{boardId}`

Rename a board or attach a client organisation to it.

Аутентификация

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

Attaching a client to a board that has none is always allowed — that is how a board created for internal work becomes a client's board. ⛔ **Changing or clearing a client that is already attached is refused with a `422` once the client has seen anything on the board** — a client-visible card, a question asked of them, or one of their people invited to it. Re-pointing such a board would hand a second client the first one's brief, answers and complaints through a screen whose whole promise is that a client sees only what the agency shared. Archive the board and start a new one for the other client. Sending the client id the board already holds is not a change and is never refused, so a rename carrying the whole form still works.

Параметры

Имя	Тип	Обязательно	Что это
`boardId (path)`	`Uuid`	Да	Project board ID (UUIDv7).

Тело запроса

Имя	Тип	Обязательно	Что это
`name`	`string`	Нет	—
`description`	`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 `upda…

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}