Cadastrar oportunidade

Cadastra UMA oportunidade (negócio de um cliente no funil). Reexecutável: reenviar o mesmo partner_code devolve result: "skipped" com a oportunidade que já existe, sem atualizar nada; duas chamadas simultâneas com o mesmo código resultam em uma created e uma skipped.

Obrigatórios: partner_code, o cliente (lead_partner_code ou lead_id) e realstate_agent_id (corretor ativo da imobiliária). Sem deal_workflow_step_id, a oportunidade entra na primeira etapa em andamento do quadro padrão — veja os quadros em GET /partner/v1/opportunity/workflow. Etapa de negócio ganho ou perdido é recusada.

O cadastro dispara o lembrete da etapa, como no painel: se a etapa tiver lembrete configurado, o corretor responsável recebe um aviso por WhatsApp. Por isso não existe cadastro em lote — cadastre uma por chamada.

Se o cliente ainda não tem corretor responsável, o corretor desta oportunidade passa a ser o dele, o que tira o cliente da fila de distribuição de atendimento. Cliente que já tem responsável nunca é trocado.

Não há atualização, mudança de etapa nem exclusão por esta API: depois de criada, a oportunidade é conduzida no painel. O token de corretor se comporta como nas demais rotas: o recorte é a imobiliária, e o corretor do token não restringe a lista.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "partner_code": "NEG-2210",
    "lead_partner_code": "CLI-8842",
    "purpose": [
        "Residencial"
    ],
    "type": [
        "Apartamento"
    ],
    "contract": [
        "Venda"
    ],
    "dormitorio": [
        2,
        3
    ],
    "banheiro": [
        1
    ],
    "suite": [
        0
    ],
    "garagem": [
        1
    ],
    "expected_closing": "2026-12-01",
    "lead_id": 900,
    "realstate_agent_id": 42,
    "deal_workflow_step_id": 31,
    "min_price": 300000,
    "max_price": 500000,
    "notes": "Quer varanda e vaga coberta."
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Oportunidade criada (created) ou já existente (skipped).

Bodyapplication/json

Example

{
    "result": "created",
    "partner_code": "NEG-2210",
    "opportunity_id": 322
}

Request

Request Code Samples

Responses