tenancy

PATCH `/v1/orgs/{orgId}`

Rename an organization.

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Түлхүүр нь org.update эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.

Таны байгууллагын дугаар орох газар

Энэ төгсгөл цэг нь таны байгууллагын ID-г URL дотроо orgId хэлбэрээр авдаг. Үүнийг зам дотор орлуулан бичнэ үү — оронд нь ажиллах толгой эсвэл хүсэлтийн параметр байхгүй.

Танай байгууллагын ID нь таны хяналтын самбар дээрх API түлхүүрийн дэлгэцэнд, түлхүүр өөрөө хажууд байрладаг. Энэ нь таны хийх дуудлага бүрт ижил ID байна.

Туршиж үзэх

Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.

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

Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй API рүү хүсэлт илгээх тул та бодит хариуг харах боломжтой болно. Энэ төгсгөлийн цэгийг 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}