Sign in

v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Correspondentes

Cadastra empresa correspondente

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Esta API é responsável por cadastrar empresa correspondente no CV.

post/v2/cadastros/correspondentes-empresas

Headers

emailstring required
Example:email@email.com
tokenstring required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Request body

nomestring required

Nome da empresa

regiaostring required

Sigla da região (NÃO o nome completo). É a sigla cadastrada no CRUD de Regiões (Empreendimentos > Regiões). Ex: "ND" para Nordeste.

telefonestring

Telefone do empresa

estadostring required

Sigla (UF) do estado da empresa (NÃO o nome completo). Ex: "BA" (e não "Bahia").

cidadestring required

Nome da cidade; deve pertencer ao estado (UF) informado.

enderecostring required

Endereço da empresa

emailstring

Email do empresa

dias_agendamentointeger

Quantidade de dias para agendamento

Example request

{
  "nome": "Nome da empresa",
  "regiao": "ND",
  "telefone": "(79) 9999-9999",
  "estado": "BA",
  "cidade": "Salvador",
  "endereco": "Rua das Flores, 123",
  "email": "email@servidor.com.br",
  "dias_agendamento": 3,
  "gerentes": [
    {
      "nome": "Nome do usuário",
      "documento": "12345678910",
      "data_nasc": "03/12/1987",
      "departamento": "Financeiro",
      "funcao": "Gerente",
      "celular": "(79) 9999-9999",
      "telefone": "(79) 9999-9999",
      "estado": "BA",
      "cidade": "Salvador",
      "email": "email@servidor.com.br"
    }
  ]
}

Response

Operação realizada com sucesso

statusstring

Example response

{
  "data": {
    "id": 123
  },
  "status": "success"
}