tenancy
PATCH /v1/orgs/{orgId}
Rename an organization.
ការផ្ទៀងផ្ទាត់ភាពត្រឹមត្រូវ
បញ្ជូនសោ API ជា bearer token។ សោនេះត្រូវតែមានសិទ្ធិ org.update។ សោដែលគ្មានសិទ្ធិនេះនឹងត្រូវបដិសេធដោយកូដ 403 មិនមែន 404 ទេ។
កន្លែងដែលលេខសម្គាល់អង្គការរបស់អ្នកត្រូវដាក់
ចំនុចបញ្ចប់នេះទទួលលេខសម្គាល់អង្គការរបស់អ្នកនៅក្នុង URL ផ្ទាល់ ដូចជា orgId។ សូមជំនួសវាចូលទៅក្នុងផ្លូវ (path) ដែលគ្មានក្បាលទំព័រ ឬប៉ារ៉ាម៉ែត្រសំណួរណាមួយអាចធ្វើជំនួសបានឡើយ។
លេខសម្គាល់អង្គការរបស់អ្នកស្ថិតនៅលើអេក្រង់គ្រាប់ចុច 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 ក្នុងផ្ទាំងគ្រប់គ្រងរបស់អ្នក បំពេញលេខសម្គាល់ស្ថាប័នពិតប្រាកដរបស់អ្នក និងសោផ្ទាល់ខ្លួនរបស់អ្នក ហើយដំណើរការសំណើទល់នឹង 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