Skip to main content
POST
Criar cliente

Criar Cliente

Cadastra um novo cliente vinculado à empresa autenticada. O nome é obrigatório; email, telefone e cpf são opcionais no request.

Comportamento atual

  • o request aceita nome, email, telefone e cpf
  • a resposta atual retorna o shape de PublicClientResponse
  • o cpf enviado é persistido no backend, mas não é ecoado pelo response model atual
  • quando email não é enviado, o backend provisiona um email placeholder apenas para o Auth
  • quando o backend não consegue concluir a criação, a rota responde 400

Exemplo de resposta

Status comuns

  • 201 cliente criado com sucesso
  • 400 falha de criação no backend
  • 401 API Key inválida ou revogada
  • 403 plano sem api_access
  • 422 header ou body inválidos
  • 429 limite global da API pública excedido

Headers

X-API-Key
string
required

Chave de API

Body

application/json

Criar/registrar cliente no clube.

nome
string
required
Required string length: 1 - 255
cpf
string | null
Maximum string length: 14
email
string | null
Maximum string length: 255
telefone
string | null
Maximum string length: 20

Response

Successful Response

Dados de um cliente.

id
string
required
nome
string
required
created_at
string<date-time> | null
email
string | null
pontos
integer
default:0
telefone
string | null