tenancy

PATCH /v1/orgs/{orgId}

Rename an organization.

Të gjitha pikat e skajshme tenancy

Autentifikimi

Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen org.update; një çelës pa të refuzohet me 403, jo 404.

Ku shkon id i organizatës suaj

Ky endpoint merr ID-në e organizatës suaj direkt në URL, si orgId. Zëvendësoni atë në shteg — nuk ka asnjë kokë (header) apo parametër query që bën punë në vend të kësaj.

ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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

Parametrat

EmriLlojiKërkohetÇfarë është kjo
orgId (path)UuidPoOrganization ID (UUIDv7).
orgId (path)UuidPo

Trupi i kërkesës

EmriLlojiKërkohetÇfarë është kjo
namestringPoThe organization's display name. The only editable field.

Përgjigja

EmriLlojiKërkohetÇfarë është kjo
idUuidPoUUIDv7 identifier — sortable by creation time (docs/02 §8).
typeOrgTypePoOrganization type in the tenancy tree.
parent_org_idUuid | nullJoParent in the tenancy tree; null for a top-level org.
namestringPo
brand_idobjectJoWhite-label brand applied to this org's surfaces.
default_currencyCurrencyCodePoISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
statusstring<active, suspended, closed>Po
created_atstringPo

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 404 · 422 · 429