Pular para o conteúdo principal

Criar Cliente

POST /customer/create

HTTP
POST /customer/create HTTP/1.1
Host: {{URL}}
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{token}}

Rota unica para criação de cliente. O objeto endereco não é obrigatório, caso não seja enviado, o cliente será criado sem endereço.

Atributos para criação de cliente

CampoTipoDescriçãoObrigatório
nome_completostringNome completo do cliente.
cpfstringCPF do cliente, necessário ser um CPF válido.
data_nascimentostringData de nascimento do cliente, o formato deverá ser AAAA-MM-DD.
sexostringSexo do cliente, valores válidos são "Masculino" ou "Feminino".
estado_civilstringEstado civil do cliente, valores válidos são "Solteiro", "Casado", "Separado", "Divorciado" ou "Viúvo".
nacionalidadestringPaís de origem do cliente, exemplo: "Brasil".
celularstringNúmero de celular do cliente, o formato deverá ser (99) 99999-9999.
telefone_fixostringNúmero de telefone fixo do cliente, o formato deverá ser (99) 9999-9999.
emailstringEmail do cliente, deve ser um email válido.
profissaostringProfissão do cliente. Exemplo: "Outros"
salarionumberSalário do cliente, o formato deverá ser o valor direto em formato de inteiro, exemplo: 165200 para R$1.652,00. Caso não tenha, pode ser enviado 0
trabalhandobooleanFlag para informar se o cliente está trabalhando ou não.
servidor_publicobooleanFlag para informar se o cliente é servidor público ou não.
pepbooleanFlag para informar se o cliente é uma pessoa politicamente exposta ou não.
afastadobooleanFlag para informar se o cliente está afastado ou não.
medicamentobooleanFlag para informar se o cliente está tomando algum medicamento ou não.
medicamento_descricaostringDescrição dos medicamentos que o cliente está tomando, caso aplicável.
e_analfabetobooleanFlag para informar se o cliente é analfabeto ou não.
enderecoobjectEste é o objeto referente aos dados de endereço do cliente.
endereco.cepstringCEP do endereço do cliente, o formato deverá ser XXXXXXXX.
endereco.enderecostringEndereço do cliente, exemplo: "Rua A".
endereco.numeronumberNúmero do endereço do cliente, exemplo: 13.
endereco.bairrostringBairro do endereço do cliente, exemplo: "Veneza".
endereco.cidadestringCidade do endereço do cliente, exemplo: "Belo Horizonte".
endereco.estadostringEstado do endereço do cliente, o formato deverá ser a abreviação do estado, exemplo: MG.
endereco.complementostringComplemento do endereço do cliente, exemplo: "Apto 101".

Requisição

Body
{
"cliente": {
"nome_completo": "Whitney Crist",
"cpf": "44346175678",
"data_nascimento": "1998-04-17T00:00:00.000Z",
"sexo": "Masculino",
"estado_civil": "Solteiro",
"nacionalidade": "Brasil",
"celular": "(31) 99714-6206",
"telefone_fixo": null,
"email": "Khalid20@example.net",
"profissao": "Vendedores Ambulantes de Produtos Não Comestíveis",
"salario": 141200,
"trabalhando": true,
"servidor_publico": false,
"pep": false,
"afastado": false,
"medicamento": false,
"medicamento_descricao": null,
"e_analfabeto": false
},
"endereco": {
"cep": "31810547",
"endereco": "Rua A",
"numero": 13,
"bairro": "Veneza",
"cidade": "Belo Horizonte",
"estado": "MG",
"complemento": null
}
}

Resposta

201
[
{
id: 4391036,
alterado_por: 'vendas.online@vileve.com.br',
criado_em: '2025-06-25T16:22:53.327Z',
alterado_em: '2025-06-25T16:22:53.327Z',
nome_completo: 'Lucas Mayer',
cpf: '65458423747',
data_nascimento: '1998-04-17',
celular: '(31) 99714-6206',
telefone_fixo: null,
email: 'Ryleigh7@example.org',
salario: 141200,
trabalhando: true,
servidor_publico: false,
pep: false,
afastado: false,
medicamento: false,
medicamento_descricao: null,
key_cliente: null,
status: 'NOVO',
e_analfabeto: false,
codigo_jave: null,
cargo_politico: null,
id_endereco: null,
ecommerce_customer_id: null,
},
];

Errors

CódigoReferênciaExplicação
400BAD REQUESTO servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Este é um erro genérico.
401UNAUTHORIZEDO servidor não autorizou a requisição. Access Token inválido.
403FORBIDDENO servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso.
404NOT FOUNDO servidor não encontrou o recurso ou não está disposto a divulgar sua existência.
422UNPROCESSABLE ENTITYO servidor não conseguiu processar as informações contidas na requisição.