agency-board

POST `/v1/agency/boards/{boardId}/labels`

Define a label.

المصادقة

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

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

جربه الآن

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

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

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

التفاصيل

Labels are per BOARD, not per organisation — an agency running Website relaunch and Monthly SEO wants different vocabularies, and a shared org-wide list makes every picker a list of somebody else's categories. Names are unique per board, case-insensitively.

المعلمات

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

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`name`	`string`	نعم	—
`colour`	`AgencyBoardLabelColour`	لا	⛔ 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 daylight…

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	نعم	—
`colour`	`AgencyBoardLabelColour`	نعم	⛔ 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 daylight…
`position`	`integer`	نعم	—

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

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/labels