tenancy

PATCH `/v1/orgs/{orgId}`

Rename an organization.

المصادقة

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

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

تأخذ نقطة النهاية هذه معرف مؤسستك في عنوان URL نفسه باسم orgId. استبدله في المسار — فلا يوجد رأس أو معامل استعلام يمكنه القيام بذلك بدلاً منه.

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

جربه الآن

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

curl -X PATCH https://api.zinndigital.com/v1/orgs/{orgId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

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

التفاصيل

⛔ Deliberately narrow: only `name`. `type`, `parent_org_id` and `default_currency` are **not** editable here — re-parenting moves a whole billing relationship and is `tenancy.offboarding`'s job. ⭐ The currency is not un-changeable, it simply is not a patchable field: it has its own route, `POST /v1/orgs/{orgId}/billing-currency` (`changeOrganizationBillingCurrency`), because re-denominating converts the wallet and re-prices live subscriptions rather than writing one column. This description read "a currency change would leave stored prices and issued invoices denominated in something the org no longer claims (#501)" until 2026-08-31, which was true of a patch and was read as *"it cannot be done"*. Requires `org.update` **on that org**; an org you cannot reach answers 404 rather than 403, the same as the GET, so this is never an existence oracle.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`orgId (path)`	`Uuid`	نعم	Organization ID (UUIDv7).
`orgId (path)`	`Uuid`	نعم	—

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`name`	`string`	نعم	The organization's display name. The only editable field.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`type`	`OrgType`	نعم	Organization type in the tenancy tree.
`parent_org_id`	`Uuid \| null`	لا	Parent in the tenancy tree; null for a top-level org.
`name`	`string`	نعم	—
`brand_id`	`object`	لا	White-label brand applied to this org's surfaces.
`default_currency`	`CurrencyCode`	نعم	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`status`	`string<active, suspended, closed>`	نعم	—
`created_at`	`string`	نعم	—

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

401 · 403 · 404 · 422 · 429

PATCH /v1/orgs/{orgId}