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",
  "cpf": "***456789**",
  "pontos": 0,
  "created_at": "2026-03-20T08:15:00Z"
}

​
Criar Cliente

Cadastra um novo cliente vinculado à sua empresa. O nome é obrigatório; email, telefone e CPF são opcionais.

​
Body Parameters

​
nome
string
required
Nome completo do cliente
​
email
string
Email do cliente. Deve ser único dentro da empresa.
​
telefone
string
Telefone do cliente no formato E.164 (ex: +5511999999999)
​
cpf
string
CPF do cliente (apenas dígitos, 11 caracteres)

​
Request

curl -X POST "https://api.indiqai.com/api/v1/public/clients" \
  -H "X-API-Key: indiqai_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "nome": "Maria Oliveira",
    "email": "maria@email.com",
    "telefone": "+5521988887777",
    "cpf": "12345678901"
  }'

​
Response

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

​
Campos da Resposta

​
id
string
ID único do cliente criado (UUID)
​
nome
string
Nome do cliente
​
email
string
Email do cliente (pode ser null)
​
telefone
string
Telefone do cliente (pode ser null)
​
cpf
string
CPF parcialmente mascarado
​
pontos
integer
Saldo inicial de pontos (sempre 0 na criação)
​
created_at
string
Data de cadastro (ISO 8601)

Headers

​
X-API-Key
string
required

Chave de API da empresa

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