ADVBOXAPI ADVBOX
Customers

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, cellphone
  • birthdate (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ção
  • email é validado mas permite duplicação
  • postalcode DEVE ter formatação 99999-999 (não aceita sem hífen)
  • birthdate deve ser no formato YYYY-MM-DD
  • phone e cellphone aceitam com ou sem formatação
POST
/customers

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

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
}
{
  "error": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "users_id": [
      "The responsible user is required"
    ],
    "name": [
      "The customer name field is required"
    ],
    "customers_origins_id": [
      "The customer origin is required"
    ]
  }
}

{
  "message": "Too Many Requests"
}
Empty