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
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
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", "email": "maria.silva@example.com", "identification": "123.456.789-01", "phone": "(11) 3333-4444", "cellphone": "(11) 98888-7777", "birthdate": "1990-05-15", "occupation": "Advogada", "postalcode": "01234-567", "city": "São Paulo", "state": "SP", "notes": "Contato preferencial" }'{
"success": true,
"customers_id": 12345678
}{
"message": "The given data was invalid.",
"errors": {
"name": [
"The customer name field is required"
]
}
}