agency-board

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

Edit a card.

所有 agency-board 端点

所有开发者文档

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

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 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 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)UuidProject board ID (UUIDv7).
cardId (path)UuidBoard card ID (UUIDv7).

请求正文

名称类型必填内容简介
titlestring
bodystring
visibilityAgencyBoardVisibilityWho 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 that…
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".

响应

名称类型必填内容简介
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
board_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
column_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
titlestring
bodystring
visibilityAgencyBoardVisibilityWho 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 that…
positioninteger
assignee_idstring
due_atstring
created_by_clientbooleanWhether the client raised this card themselves.
archived_atstring
cover_colourAgencyBoardLabelColourA 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…
created_atstring
updated_atstring

此端点可能返回的错误

401 · 403 · 404 · 422