agency-board

PUT `/v1/agency/boards/{boardId}/cards/{cardId}/labels`

Set the labels on a card.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (bearer token). لا يحدد نقطة النهاية هذه إذنًا محددًا في المواصفات، لذا امنح مفتاحك الحد الأدنى الذي محتاجه وتحقق من الاستجابة بدلاً من الافتراض.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X PUT https://api.zinndigital.com/v1/agency/boards/{boardId}/cards/{cardId}/labels \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "label_ids": <string[]> }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Replaces the card's whole label set. Every id is re-checked against **this board**, so a label from another board is refused rather than quietly attached.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`boardId (path)`	`Uuid`	نعم	Project board ID (UUIDv7).
`cardId (path)`	`Uuid`	نعم	Board card ID (UUIDv7).

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`label_ids`	`string[]`	نعم	The COMPLETE set the card should wear afterwards — this replaces, it does not add. An empty array takes every label off, which is why the array may be empty: an add/remove pair…
`created_by`	`AgencyBoardActor`	لا	—
`updated_by`	`AgencyBoardActor`	لا	Who last edited this card. Moves exactly when `updated_at` does.
`assignee`	`AgencyBoardActor`	لا	The resolved form of `assignee_id`.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`column_id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`title`	`string`	نعم	—
`body`	`string`	لا	—
`visibility`	`AgencyBoardVisibility`	نعم	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`	نعم	—
`assignee_id`	`string`	لا	—
`due_at`	`string`	لا	—
`created_by_client`	`boolean`	لا	Whether the client raised this card themselves.
`archived_at`	`string`	لا	—
`cover_colour`	`AgencyBoardLabelColour`	لا	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[]`	لا	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`	لا	—
`updated_at`	`string`	لا	—

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422

PUT /v1/agency/boards/{boardId}/cards/{cardId}/labels