Alterar situação do lead

🔒

Autenticação necessária

Esta API utiliza Bearer Token no header Authorization.
Consulte o tutorial completo antes de fazer sua primeira chamada:
Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)

Altera a situação do lead. Para cancelar, informe a situação de cancelamento do
workflow junto de idMotivoCancelamento (e, quando exigidos pelo motivo,
idSubmotivoCancelamento e descricaoMotivoCancelamento).

Disponível para os painéis Gestor, Imobiliária e Corretor. No painel Gestor exige a
permissão "Modificar situação" (comercial|leads|3) no perfil do usuário.

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

Identificador do lead

Body Params

Situação de destino e, no cancelamento, motivo/submotivo/descrição.

int64
required
≥ 1

Identificador da situação de destino, que precisa estar ativa no workflow de leads.

int64
≥ 1

Identificador do motivo de cancelamento, que precisa estar cadastrado e ativo (ver GET /api/v4/comercial/motivos-cancelamento-lead). Só aceito quando idSituacao é a situação de cancelamento, e obrigatório nesse caso. A API não cadastra motivos.

int64
≥ 1

Identificador do submotivo de cancelamento, que precisa estar cadastrado, ativo e vinculado ao motivo informado. A API não cadastra submotivos.

string

Descrição livre do cancelamento. Obrigatória quando o motivo de cancelamento informado exige descrição.

boolean
Defaults to true

Quando false, impede a reativação de um lead cancelado (a chamada falha com 422 em vez de mover o lead para fora da situação de cancelamento).

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json