Skip to main content
Cria uma sub-organização dentro do ecossistema Chargefy. A nova organização é automaticamente vinculada como filha da organização pai identificada pelo token de acesso. Retorna o objeto da sub-organização criada com status HTTP 201 Created.

​
Autenticação

Requer Organization Access Token (OAT) da organização pai via header Authorization: Bearer.

​
Corpo da Requisição

​
name
string
required
Nome da sub-organização.
​
slug
string
required
Identificador desejado em formato de slug (letras minúsculas, números e hífens). Deve ser único globalmente; se já existir, a API grava um slug alternativo no formato slug-12345 (número aleatório curto) e devolve esse valor em suborganization.slug na resposta.
​
email
string
Endereço de e-mail principal da sub-organização.
​
website
string
URL do site da sub-organização.
​
description
string
Descrição da sub-organização.

​
Resposta

Retorna o objeto da sub-organização criada com status 201 Created.
​
suborganization
object
Dados da sub-organização criada.
​
suborganization.id
string
Identificador único da sub-organização criada.
​
suborganization.name
string
Nome da sub-organização.
​
suborganization.slug
string
Slug efetivo da sub-organização (pode diferir do enviado se houve colisão; use sempre este valor nas integrações).
​
suborganization.status
string
Status inicial ("created").
​
status
string
Status do processo de criação ("pending_review").

​
Exemplo

curl -X POST "https://api.chargefy.io/api/v1/sdk/organizations" \
  -H "Authorization: Bearer $CHARGEFY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Vendedor Gamma",
    "slug": "vendedor-gamma",
    "email": "[email protected]"
  }'

​
Resposta de Exemplo

{
  "suborganization": {
    "id": "org_01j9abc333",
    "name": "Vendedor Gamma",
    "slug": "vendedor-gamma",
    "status": "created"
  },
  "status": "pending_review"
}