v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Correspondentes

Cadastra um usuário 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 um usuário correspondente no CV.

post/v2/cadastros/correspondentes-usuarios

Headers

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

Request body

nomestring required

Nome do usuário

documentostring required

Documento do usuário (CPF)

data_nascstring

Data de nascimento do usuário

departamentostring

Departamento do usuário

funcaostring

Função do usuário

celularstring

Celular do usuário

telefonestring

Telefone do usuário

estadostring required

UF do usuário

cidadestring required
emailstring required

Email do usuário

idempresainteger required

Código identificador da empresa

gerentestring

Informa se é gerente ou não

Example request

{
  "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": "SE",
  "cidade": "Aracaju",
  "email": "email@servidor.com.br",
  "idempresa": 1,
  "gerente": "S"
}

Response

Operação realizada com sucesso

statusstring

Example response

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