CVcvcrm
Situação do Lead

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.

patch/leads/{idLead}/situacao

Request

  • Base URL
    https://integracao.cvcrm.com.br/api/v4/comercial
  • URL
    https://integracao.cvcrm.com.br/api/v4/comercial/leads/{idLead}/situacao
  • Auth
    HTTP bearer

Path parameters

idLeadinteger required

Identificador do lead

Request body

idSituacaointeger required

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

idMotivoCancelamentointeger

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.

idSubmotivoCancelamentointeger

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

descricaoMotivoCancelamentostring

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

reativarLeadboolean

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

Example request

{
  "idSituacao": 12,
  "idMotivoCancelamento": 55,
  "idSubmotivoCancelamento": 1,
  "descricaoMotivoCancelamento": "Cliente não atingiu a renda mínima exigida."
}

Response

Situação do lead alterada

statusstring
codeinteger

Example response

{
  "status": "success",
  "code": 200,
  "data": {
    "idLead": 48213,
    "situacaoDe": {
      "id": 5,
      "nome": "Em atendimento",
      "corBg": "#ad014b",
      "corNome": "#8879d2"
    },
    "situacaoPara": {
      "id": 5,
      "nome": "Em atendimento",
      "corBg": "#ad014b",
      "corNome": "#8879d2"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.