Crie um novo contato
Cria um novo contato no sistema.
Campos obrigatórios:
users_id- ID do usuário responsável (deve pertencer ao escritório)customers_origins_id- ID da origem do contato (deve pertencer ao escritório)name- Nome do contato
Campos opcionais — Pessoais:
email,identification(CPF/CNPJ),phone,cellphonebirthdate(YYYY-MM-DD),gender,occupation,document
Campos opcionais — Endereço:
street,region,city,state,country,postalcode
Campos opcionais — Trabalhistas:
number_ctps,number_pis,number_cid,notes
Validações importantes:
identification(CPF/CNPJ) é validado com algoritmo real e bloqueia duplicaçãoemailé validado mas permite duplicaçãopostalcodeDEVE ter formatação 99999-999 (não aceita sem hífen)birthdatedeve ser no formato YYYY-MM-DDphoneecellphoneaceitam com ou sem formatação
Authorization
BearerAuth In: header
Request Body
application/json
[Required] ID do usuário responsável (deve existir e pertencer ao escritório)
[Required] ID da origem do contato (deve existir e pertencer ao escritório)
[Required] Nome completo do contato
[Optional] Email do contato. Validado mas permite duplicação.
email[Optional] Número do documento do contato (campo livre, sem validação)
[Optional] CPF ou CNPJ do contato. Aceita com ou sem formatação. Validado com algoritmo real e bloqueia duplicação.
[Optional] Telefone do contato. Aceita com ou sem formatação.
[Optional] Celular do contato. Aceita com ou sem formatação.
[Optional] Data de nascimento no formato YYYY-MM-DD
date[Optional] Profissão ou ocupação do contato
[Optional] CEP no formato 99999-999 (hífen obrigatório)
^\d{5}-\d{3}$[Optional] Cidade do contato
[Optional] Estado do contato (sigla com 2 letras)
[Optional] Observações ou notas adicionais sobre o contato
[Optional] Gênero do contato (ex: M, F)
[Optional] Logradouro do contato (rua, avenida, etc.)
[Optional] Bairro do contato
[Optional] País do contato (ex: BRASIL)
[Optional] Número da Carteira de Trabalho (CTPS)
[Optional] Número do PIS/PASEP
[Optional] Código CID (classificação de doença)
Response Body
application/json
application/json
curl -X POST "https://app.advbox.com.br/api/v1/customers" \ -H "Content-Type: application/json" \ -d '{ "users_id": 123456, "customers_origins_id": 789012, "name": "Maria Silva" }'{
"success": true,
"customers_id": 12345678
}{
"message": "The given data was invalid.",
"errors": {
"name": [
"The customer name field is required"
]
}
}