Skip to main content
POST
/
api
/
v1
/
public
/
clients
Criar cliente
curl --request POST \
  --url https://api.indiqai.com/api/v1/public/clients \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "nome": "<string>",
  "cpf": "<string>",
  "email": "<string>",
  "telefone": "<string>"
}
'
{
  "id": "660f9500-f39c-52e5-b827-557766551111",
  "nome": "Maria Oliveira",
  "email": "maria@email.com",
  "telefone": "+5521988887777",
  "pontos": 0,
  "created_at": "2026-03-20T08:15:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.indiqai.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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

{
  "id": "660f9500-f39c-52e5-b827-557766551111",
  "nome": "Maria Oliveira",
  "email": "maria@email.com",
  "telefone": "+5521988887777",
  "pontos": 0,
  "created_at": "2026-03-20T08:15:00Z"
}

​
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