reseller

PUT `/v1/reseller/brand/menu/{item_id}`

Change one link.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن reseller.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

حيث يتم إدخال معرف مؤسستك

تأخذ نقطة النهاية هذه org_id كمعلمة استعلام. اتركه فارغاً ليغطي الاستدعاء شجرة مستأجريك بالكامل، أو أرسله لتضييق نطاق الاستدعاء ليشمل منظمة واحدة.

معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (API) في لوحة تحكمك، بجوار المفتاح نفسه. وهو نفس المعرف في كل طلب تجريه.

جربه الآن

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

curl -X PUT https://api.zinndigital.com/v1/reseller/brand/menu/{item_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "label": <string>, "url": <string> }'

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

التفاصيل

Replaces one navigation link. Requires `reseller.manage`. ⛔ Scoped to your own organisation as well as to the id. A `get(pk=…)` would let any reseller edit any other reseller's link by guessing a uuid — and uuid7 is time-ordered, so guessing is less of a barrier than it sounds.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`org_id (query)`	`Uuid`	لا	The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agen…
`item_id (path)`	`string`	نعم	—

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`label`	`string`	نعم	—
`url`	`string`	نعم	—
`icon`	`string`	لا	—
`position`	`integer`	لا	—
`new_tab`	`boolean`	لا	—
`visibility`	`string<both, client, staff>`	لا	—

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`string`	نعم	—
`label`	`string`	نعم	—
`url`	`string`	نعم	—
`icon`	`string`	نعم	A design-system icon name from `icons`, or `""` for a label-only item.
`position`	`integer`	نعم	Sort key. Ties break on the label, so the order is total and stable.
`new_tab`	`boolean`	نعم	Renders `target="_blank"`. The panel pairs it with `rel="noopener noreferrer"` unconditionally — that is set on every external item, not only the new-tab ones, because `Refe…
`visibility`	`string<both, client, staff>`	نعم	Who sees it. Filtered server-side on `GET /v1/branding`: a payload carrying a staff-only link that the app hides has already disclosed it to anybody with a network tab, whic…
`external`	`boolean`	نعم	Whether the link leaves the panel. Computed here so every renderer agrees.

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

401 · 403 · 404 · 422

PUT /v1/reseller/brand/menu/{item_id}