Skip to main content
POST
Cadastra um novo cliente com validação automática de dados. O sistema gera automaticamente um código único se não fornecido.
Você precisa de uma API key válida no header x-api-key para usar este endpoint.

Headers

string
required
application/json
string
required
API key de autenticação

Body

string
required
Nome ou razão social do clienteMínimo: 3 caracteres
Máximo: 255 caracteres
string
required
Email do clienteDeve ser um email válido e único no sistema
string
required
Telefone do clienteAceita diversos formatos:
  • (11) 98765-4321
  • 11987654321
  • +5511987654321
string
required
Cidade do cliente
string
required
Estado do cliente (sigla com 2 letras)Exemplos: SP, RJ, MG, RS
string
CNPJ ou CPF do clienteAceita com ou sem formatação:
  • CNPJ: 12.345.678/0001-90 ou 12345678000190
  • CPF: 123.456.789-10 ou 12345678910
string
Endereço completo do cliente
string
Código personalizado do clienteSe não fornecido, será gerado automaticamente no formato: CLI + número sequencial
boolean
default:"true"
Define se o cliente está ativo

Response

Sucesso

boolean
Indica se a operação foi bem-sucedida
object
Dados do cliente criado

Erro

string
Mensagem de erro descritiva

Validações

O sistema aplica as seguintes validações:Campos obrigatórios:
  • nome: Mínimo 3 caracteres
  • email: Deve ser válido e único
  • telefone: Aceita vários formatos
  • cidade: Não pode ser vazio
  • estado: Sigla com 2 letras
Validações adicionais:
  • Email não pode estar duplicado
  • CNPJ/CPF são validados quando fornecidos
  • Telefone é normalizado automaticamente

Códigos de Cliente

Se o campo codigo não for fornecido, o sistema gera automaticamente:
  • Formato: CLI + número sequencial
  • Exemplos: CLI001, CLI002, CLI003…
  • O código é único por empresa
  • Você pode fornecer seu próprio código personalizado