Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X POST https://api.zinndigital.com/v1/orgs \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "type": <OrgType>, "name": <string> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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).
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
Idempotency-Key (header) | string | Não | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
type | OrgType | Sim | Organization type in the tenancy tree. |
parent_org_id | Uuid | null | Não | Defaults to the caller's org when omitted. |
name | string | Sim | — |
default_currency | CurrencyCode | Não | — |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
type | OrgType | Sim | Organization type in the tenancy tree. |
parent_org_id | Uuid | null | Não | Parent in the tenancy tree; null for a top-level org. |
name | string | Sim | — |
brand_id | object | Não | White-label brand applied to this org's surfaces. |
default_currency | CurrencyCode | Sim | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
status | string<active, suspended, closed> | Sim | — |
created_at | string | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 409 · 422 · 429