tenancy

PATCH /v1/orgs/{orgId}

Rename an organization.

Toate punctele finale tenancy

Autentificare

Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea org.update; o cheie care nu o are va fi respinsă cu 403, nu 404.

Unde merge ID-ul organizației tale

Acest punct final preia ID-ul organizației tale direct în URL, sub forma orgId. Înlocuiește-l în cale — nu există niciun antet sau parametru de interogare care să țină locul acestuia.

ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

⛔ 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.

Parametri

NumeTipObligatoriuCe este
orgId (path)UuidDaOrganization ID (UUIDv7).
orgId (path)UuidDa

Corp cerere

NumeTipObligatoriuCe este
namestringDaThe organization's display name. The only editable field.

Răspuns

NumeTipObligatoriuCe este
idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
typeOrgTypeDaOrganization type in the tenancy tree.
parent_org_idUuid | nullNuParent in the tenancy tree; null for a top-level org.
namestringDa
brand_idobjectNuWhite-label brand applied to this org's surfaces.
default_currencyCurrencyCodeDaISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
statusstring<active, suspended, closed>Da
created_atstringDa

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422 · 429