agency-board

PATCH /v1/agency/boards/{boardId}/cards/{cardId}

Edit a card.

Всички крайни точки в agency-board

Упълномощаване

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

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

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

⭐ Sending `assignee_id: null` **unassigns**; omitting the field leaves the assignee alone. The two are different requests and the API distinguishes them, because a `null`-means-absent API cannot express "unassign" at all.

Параметри

ИмеТипЗадължителноКакво представлява
boardId (path)UuidДаProject board ID (UUIDv7).
cardId (path)UuidДаBoard card ID (UUIDv7).

Тяло на заявката

ИмеТипЗадължителноКакво представлява
titlestringНе
bodystringНе
visibilityAgencyBoardVisibilityНе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…
assignee_idstringНе
due_atstringНе
cover_colourstring<neutral, info, violet, ok, warn, crit, >НеA palette token, or the empty string to clear the cover. ⛔ The empty string is the CLEAR rather than `null`, so there is exactly one spelling of "no cover".

Отговор

ИмеТипЗадължителноКакво представлява
idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
column_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
titlestringДа
bodystringНе
visibilityAgencyBoardVisibilityДа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…
positionintegerДа
assignee_idstringНе
due_atstringНе
created_by_clientbooleanНеWhether the client raised this card themselves.
archived_atstringНе
cover_colourAgencyBoardLabelColourНеA colour band across the top of the card, or the empty string for none. ⛔ Shares the label palette rather than declaring a second one: two palettes on one screen is how a cover…
labelsAgencyBoardLabel[]НеThe labels this card wears, in the board's label order. ⛔ Agency-only — the client's projection of a card carries no labels at all, because a label is the agency's private vocab…
created_atstringНе
updated_atstringНе

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422