agency-board

POST /v1/agency/boards/{boardId}/views

Create or replace a named cut of the board.

Все эндпоинты agency-board

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

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

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

Попробовать

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

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

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

Подробнее

⛔ Server-side rather than per-browser, because the value of a saved view is that the whole team opens the same one — on a second laptop, on a phone, and after a browser reset. ⭐ Upsert by name: saving over a view you already have is what a person means by pressing Save with the same name, and a uniqueness error there is a dead end with no remedy in a UI. Unknown keys in `definition` are DROPPED rather than refused, so a newer console and an older engine can coexist during a deploy.

Параметры

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

Тело запроса

ИмяТипОбязательноЧто это
namestringДа
definitionAgencyBoardViewDefinitionНетThe filters, grouping and search that make up one cut of a board. ⛔ Unknown keys are DROPPED on save rather than refused, so a newer console's extra control does not 400 against…
is_defaultbooleanНет

Ответ

ИмяТипОбязательноЧто это
idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringДа
definitionAgencyBoardViewDefinitionДаThe filters, grouping and search that make up one cut of a board. ⛔ Unknown keys are DROPPED on save rather than refused, so a newer console's extra control does not 400 against…
is_defaultbooleanДаWhat a member sees on opening this board cold. At most one per board.
created_atstringНет

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

401 · 403 · 404 · 422