agency-board

PATCH `/v1/agency/boards/{boardId}/labels/{labelId}`

Rename or recolour a label.

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Parameter

Name	Typ	Erforderlich	Was es ist
`boardId (path)`	`Uuid`	Ja	Project board ID (UUIDv7).
`labelId (path)`	`Uuid`	Ja	Board label ID (UUIDv7).

Anfragekörper

Name	Typ	Erforderlich	Was es ist
`name`	`string`	Nein	—
`colour`	`AgencyBoardLabelColour`	Nein	⛔ A palette token, never a hex string. The consoles render in the viewer's theme and every colour the design system owns has a dark variant; a hex an agency picked in daylig…

Antwort

Name	Typ	Erforderlich	Was es ist
`id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ja	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ja	—
`colour`	`AgencyBoardLabelColour`	Ja	⛔ A palette token, never a hex string. The consoles render in the viewer's theme and every colour the design system owns has a dark variant; a hex an agency picked in daylig…
`position`	`integer`	Ja	—

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}/labels/{labelId}