Skip to main content
POST

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

organization_id
string
obrigatório

O identificador único da organização proprietária que criará o tenant

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$

Corpo

application/json

Corpo único de criação com campos condicionais por type: se type=tenant, requer tenant_config; se type=organization, requer organization_config.

type
enum<string>
obrigatório

Tipo de criação. tenant para CLIENTE FINAL, organization para PARCEIRO/ATACADISTA.

Opções disponíveis:
tenant,
organization
name
string
obrigatório
Maximum string length: 512
organization_email
string
obrigatório
Maximum string length: 512
organization_language
string
obrigatório
Maximum string length: 512
organization_country
string
obrigatório
Maximum string length: 512
organization_industry
string
obrigatório
Maximum string length: 512
tenant_config
object | null

Configuração específica para type=tenant.

organization_config
object | null

Configuração específica para type=organization.

policy_id
string
Maximum string length: 24
Pattern: ^[0-9a-f]{24}$

Resposta

Tenant e organização associados criados corretamente. Retorna o recurso tenant criado.

id
string
obrigatório
organization_id
string
obrigatório

ID da organização do tenant

created_at
string<date-time>
obrigatório
name
string
obrigatório
region
string
obrigatório
product_id
string | null

ID do produto

policy_id
string | null

ID da política