Proteside Docs
Referência de endpointsOrganizações

Criar uma organização filha (parceiro)

POST
/organizations

Cria uma organização com parent_org_id = a sua organização. O proprietário recebe um e-mail de convite (tolerante a falhas: veja owner_invite). As políticas de aprovação padrão são criadas. Só é permitido um nível de aninhamento.

Autorização

bearerAuth
headerAutorizaçãoBearer <token>

Token de API criado em Configurações → API. Os escopos ficam vinculados ao token; cada operação lista o escopo exigido em x-scope.

Parâmetros de cabeçalho

Idempotency-Key?string

Reproduz a resposta original por 24 h

Tamanho1 <= length <= 255

Corpo da requisição

application/json
  1. body
name*string
Tamanho2 <= length <= 120
owner_email*string
Formatoemail
plan?string
Padrão"growth"
Valor em"essential""standard""growth""pro""enterprise"
billing_mode?string
Padrão"partner"
Valor em"partner""stripe"

Corpo da resposta

Criada

application/json
  1. response
id?string
Formatouuid
name?string
plan?string
billing_mode?string
Valor em"stripe""partner"
parent_org_id?|
Formatouuid
owner_email?|
Formatoemail
partner_settings?
created_at?string
Formatodate-time
owner_invite?string
Valor em"sent""existing_user""failed""skipped"
curl -X POST "https://example.com/organizations" \  -H "Content-Type: application/json" \  -d '{    "name": "Loja do João",    "owner_email": "joao@lojadojoao.com.br",    "plan": "growth"  }'
{  "id": "7f3c1e2a-0b4d-4c8e-9f10-2a3b4c5d6e7f",  "name": "Loja do João",  "plan": "growth",  "billing_mode": "partner",  "parent_org_id": "a1b2c3d4-0000-4000-8000-000000000001",  "owner_email": "joao@lojadojoao.com.br",  "partner_settings": {},  "created_at": "2026-09-27T10:00:00.000Z",  "owner_invite": "sent"}