tenancy

PATCH /v1/orgs/{orgId}

Rename an organization.

Alle tenancy-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie org.update beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Waar je organisatie-id komt te staan

Dit eindpunt gebruikt je organisatie-id rechtstreeks in de URL als orgId. Vervang dit in het pad; er is geen header of queryparameter die dit kan overnemen.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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

Parameters

NaamTypeVerplichtWat dit is
orgId (path)UuidJaOrganization ID (UUIDv7).
orgId (path)UuidJa

Aanvraaglichaam

NaamTypeVerplichtWat dit is
namestringJaThe organization's display name. The only editable field.

Reactie

NaamTypeVerplichtWat dit is
idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
typeOrgTypeJaOrganization type in the tenancy tree.
parent_org_idUuid | nullNeeParent in the tenancy tree; null for a top-level org.
namestringJa
brand_idobjectNeeWhite-label brand applied to this org's surfaces.
default_currencyCurrencyCodeJaISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
statusstring<active, suspended, closed>Ja
created_atstringJa

Fouten die dit eindpunt kan retourneren

401 · 403 · 404 · 422 · 429