v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Pré-cadastro

Edita o Pré-cadastro

🔒 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)

A interface viabiliza a edição dos dados de um pré-cadastro do sistema CV.

put/v1/comercial/precadastro/[idPrecadastroOuCodigoInterno]

Headers

emailstring required
Example:email@email.com
tokenstring required
Example:2ed820f89afa16cabb6f1585f9a85b4e6bfc80c3

Request body

idempreendimentointeger
idunidadeinteger
idimobiliariainteger
idcorretorinteger
codigointernostring
valor_avaliacaostring
valor_aprovadostring
valor_subsidiostring
utilizar_fgtsstring
valor_fgtsstring
saldo_devedorstring
prazostring

Prazo do pré-cadastro. Deve ser enviado em um formato válido de data.

prazo_financiamentostring
tabelastring
valor_prestacaostring
carta_creditostring
vencimento_aprovacaostring
idintencao_comprainteger
idsituacaointeger
email_usuario_correspondentestring
idusuario_correspondenteinteger
empresa_correspondentestring
idempresa_correspondenteinteger
resumo_insight_apistring

Resumo do pré-cadastro.

id_usuariointeger

Identificador do usuário que está editando o pré-cadastro (gestor, corretor, imobiliária ou correspondente). Campo opcional. Deve ser informado em conjunto com 'painel'; caso apenas um dos dois seja enviado, a requisição será rejeitada com erro 400.

painel'gestor' | 'corretor' | 'imobiliaria' | 'correspondente'

Painel do usuário que está editando o pré-cadastro. Campo opcional. Deve ser informado em conjunto com 'id_usuario'; caso apenas um dos dois seja enviado, a requisição será rejeitada com erro 400. O histórico sempre registra o usuário autenticado pelo token JWT.

Example request

{
  "idempreendimento": 217,
  "idunidade": 46706,
  "idimobiliaria": 2,
  "idcorretor": 6017,
  "codigointerno": "258963",
  "valor_avaliacao": "500000,00",
  "valor_aprovado": "300000,00",
  "valor_subsidio": "20000,00",
  "utilizar_fgts": "S",
  "valor_fgts": "20000,00",
  "saldo_devedor": "160000,00",
  "prazo": "20/06/2022",
  "prazo_financiamento": "Obs. prazo do financiamento.",
  "tabela": "Tabela teste",
  "valor_prestacao": "5000,00",
  "carta_credito": "Carta teste",
  "vencimento_aprovacao": "20/06/2027",
  "idintencao_compra": 3,
  "idsituacao": 9,
  "email_usuario_correspondente": "correspondente@mail.com.br",
  "idusuario_correspondente": 58,
  "empresa_correspondente": "Banco do Brasil",
  "idempresa_correspondente": 1,
  "resumo_insight_api": "Resumindo os principais pontos do pré-cadastro",
  "id_usuario": 42,
  "painel": "gestor"
}

Response

Operação realizada com sucesso.

sucessoboolean
mensagemstring
avisostring

Presente quando id_usuario e painel foram informados mas o usuário não foi encontrado ou está inativo. A atualização é realizada normalmente usando o usuário do token JWT.

Example response

{
  "sucesso": true,
  "mensagem": "Operação realizada com sucesso.",
  "aviso": "usuario_nao_encontrado_ou_inativo"
}