tenancy

POST /v1/orgs

Create an organization.

Tous les points de terminaison tenancy

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

Creates a child organization under the caller's org (reseller creating a client, etc.). Send an `Idempotency-Key` so retries never create duplicates (docs/09 §2).

Paramètres

NomTypeObligatoireQu'est-ce que c'est
Idempotency-Key (header)stringNonClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Corps de la requête

NomTypeObligatoireQu'est-ce que c'est
typeOrgTypeOuiOrganization type in the tenancy tree.
parent_org_idUuid | nullNonDefaults to the caller's org when omitted.
namestringOui
default_currencyCurrencyCodeNon

Réponse

NomTypeObligatoireQu'est-ce que c'est
idUuidOuiUUIDv7 identifier — sortable by creation time (docs/02 §8).
typeOrgTypeOuiOrganization type in the tenancy tree.
parent_org_idUuid | nullNonParent in the tenancy tree; null for a top-level org.
namestringOui
brand_idobjectNonWhite-label brand applied to this org's surfaces.
default_currencyCurrencyCodeOuiISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
statusstring<active, suspended, closed>Oui
created_atstringOui

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 409 · 422 · 429