Sign in

v10

latestOpenAPI 3.1.1raw.githubusercontent.com2026-06-261653109.3 KB
Clientes

Criar cliente

Cria um novo cliente associado a sua organizacao.

post/v1/customers

Request body

namestring required

Nome completo do cliente

emailstring required

E-mail do cliente

externalIdstring nullable

Seu identificador interno

documentstring nullable

CPF ou CNPJ (apenas numeros)

documentType'CPF' | 'CNPJ' nullable

Tipo do documento

phonestring nullable

Telefone com codigo do pais. Aceita com ou sem '+' no envio e e salvo apenas com digitos.

metadatastring nullable

Metadados em JSON

Example request

{
  "name": "Joao Silva",
  "email": "joao@email.com",
  "externalId": "cliente_123",
  "document": "12345678900",
  "documentType": "CPF",
  "phone": "5511999998888",
  "metadata": "{\"plano\": \"premium\"}"
}

Response

Cliente criado com sucesso

messagestring nullable

Example response

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "externalId": "cliente_123",
    "name": "Joao Silva",
    "email": "joao@email.com",
    "document": "123.456.789-00",
    "documentType": "CPF",
    "phone": "5511999998888",
    "status": "Active",
    "address": {
      "street": "Rua das Flores",
      "number": "123",
      "complement": "Apto 45",
      "neighborhood": "Centro",
      "city": "Sao Paulo",
      "state": "SP",
      "postalCode": "01234-567",
      "country": "BR"
    },
    "createdAt": "2025-01-15T15:00:00Z"
  },
  "error": {
    "message": "Token invalido ou expirado.",
    "code": "unauthorized"
  }
}