agency-board

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

Edit a card.

Tous les points de terminaison agency-board

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`boardId (path)`	`Uuid`	Oui	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	Oui	Board card ID (UUIDv7).

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`title`	`string`	Non	—
`body`	`string`	Non	—
`visibility`	`AgencyBoardVisibility`	Non	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`	Non	—
`due_at`	`string`	Non	—
`cover_colour`	`string<neutral, info, violet, ok, warn, crit, >`	Non	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".

Réponse

Nom	Type	Obligatoire	Qu'est-ce que c'est
`id`	`Uuid`	Oui	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Oui	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`column_id`	`Uuid`	Oui	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`title`	`string`	Oui	—
`body`	`string`	Non	—
`visibility`	`AgencyBoardVisibility`	Oui	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`	Oui	—
`assignee_id`	`string`	Non	—
`due_at`	`string`	Non	—
`created_by_client`	`boolean`	Non	Whether the client raised this card themselves.
`archived_at`	`string`	Non	—
`cover_colour`	`AgencyBoardLabelColour`	Non	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[]`	Non	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`	Non	—
`updated_at`	`string`	Non	—

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422

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