tenancy

PATCH /v1/orgs/{orgId}

Rename an organization.

Todos los endpoints de tenancy

Autenticación

Envía una clave de API como token de portador. La clave debe tener el permiso org.update; una clave que no lo tenga se rechazará con un código 403, no 404.

Donde va el ID de tu organización

Este endpoint toma el id de tu organización directamente en la URL, como orgId. Sustitúyelo en la ruta; no hay ninguna cabecera ni parámetro de consulta que sirva para ello.

El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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

Parámetros

NombreTipoObligatorio¿Qué es esto?
orgId (path)UuidOrganization ID (UUIDv7).
orgId (path)Uuid

Cuerpo de la solicitud

NombreTipoObligatorio¿Qué es esto?
namestringThe organization's display name. The only editable field.

Respuesta

NombreTipoObligatorio¿Qué es esto?
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
typeOrgTypeOrganization type in the tenancy tree.
parent_org_idUuid | nullNoParent in the tenancy tree; null for a top-level org.
namestring
brand_idobjectNoWhite-label brand applied to this org's surfaces.
default_currencyCurrencyCodeISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
statusstring<active, suspended, closed>
created_atstring

Errores que este endpoint puede devolver

401 · 403 · 404 · 422 · 429