agency-board

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

Edit a card.

Autenticación

Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.

Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

⭐ 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.

Parámetros

Nombre	Tipo	Obligatorio	¿Qué es esto?
`boardId (path)`	`Uuid`	Sí	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Sí	Board card ID (UUIDv7).

Cuerpo de la solicitud

Nombre	Tipo	Obligatorio	¿Qué es esto?
`title`	`string`	No	—
`body`	`string`	No	—
`visibility`	`AgencyBoardVisibility`	No	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_id`	`string`	No	—
`due_at`	`string`	No	—
`cover_colour`	`string<neutral, info, violet, ok, warn, crit, >`	No	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".

Respuesta

Nombre	Tipo	Obligatorio	¿Qué es esto?
`id`	`Uuid`	Sí	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Sí	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`column_id`	`Uuid`	Sí	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`title`	`string`	Sí	—
`body`	`string`	No	—
`visibility`	`AgencyBoardVisibility`	Sí	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…
`position`	`integer`	Sí	—
`assignee_id`	`string`	No	—
`due_at`	`string`	No	—
`created_by_client`	`boolean`	No	Whether the client raised this card themselves.
`archived_at`	`string`	No	—
`cover_colour`	`AgencyBoardLabelColour`	No	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…
`labels`	`AgencyBoardLabel[]`	No	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_at`	`string`	No	—
`updated_at`	`string`	No	—

Errores que este endpoint puede devolver

401 · 403 · 404 · 422

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