Referências das Apis

Edita o Pré-cadastro

put
https://{dominiodocliente}.cvcrm.com.br/api/v1/comercial/precadastro/
🔒

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)

Endpoint destinado à atualização de um pré-cadastro, bem como à movimentação de situação (workflow) dentro do CVCRM. Todos os dados do pré-cadastro podem ser editados, com exceção do cliente e dos associados.

A atualização pode ser auxiliada por outros endpoints da plataforma, como empreendimento, corretor, empresas, usuários correspondentes e workflow. A autenticação é realizada via header, utilizando e-mail e token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Parâmetro de busca do pré-cadastro que será atualizado. Aceita o idprecadastro (identificador numérico do pré-cadastro no CVCRM) ou o codigointerno informado no cadastro do pré-cadastro. A busca é feita primeiro pelo idprecadastro e, caso nenhum pré-cadastro seja encontrado, pelo codigointerno. Os valores podem ser obtidos no endpoint GET /v1/comercial/precadastro.

Body Params

Corpo da requisição

integer
integer
integer
integer
string
string
string
string
string
string
string
string
≤ 10

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

string
string
string
string
string
integer

Identificador da intenção de compra do cliente. As opções são cadastradas por cada cliente no CVCRM, em Gestor > Comercial > Intenções de Compra, e por isso variam de ambiente para ambiente (por exemplo: Investimento, Moradia). Atualmente não há endpoint disponível para listar as opções, portanto o identificador deve ser obtido nessa tela do Gestor. O nome correspondente é retornado no campo intencao_compra do endpoint GET /v1/comercial/precadastro.

integer
string
integer
string
integer
string

Resumo do pré-cadastro.

integer

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.

string
enum

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.

Allowed:
Headers
string
required
string
required
Responses

Updated 5 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?