Cadastrar autocontratação

Cadastra cliente, oportunidade e venda em uma única requisição e, quando o produto permite, já retorna o link de autocontratação.

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

Endpoint de orquestração que inicia todo o fluxo de autocontratação em uma única chamada — ideal para formulários e integrações que precisam disparar o processo completo sem chamadas encadeadas.

A partir dos dados do cliente e da oportunidade, ele executa em sequência:

  1. Cliente — localiza a ficha pelo CPF (no escritório do token) ou cria uma nova.
  2. Oportunidade — registra a oportunidade (passagem de bastão) para o cliente.
  3. Venda — cadastra a venda pelo caminho rápido, reaproveitando o produto e a origem informados na oportunidade.
  4. Autocontratação — se o produto estiver habilitado, gera e retorna o link de autocontratação.

Atomicidade (reversão parcial)

O fluxo não é totalmente transacional — entenda o comportamento para tratar as respostas corretamente:

  • Falha antes da oportunidade ser criada: a ficha recém-criada é desfeita e a requisição retorna erro (400). Nada é persistido.
  • Falha a partir da venda: cliente e oportunidade são mantidos. A resposta indica sucesso parcial (207), e a equipe dá continuidade manualmente.

Atenção: em caso de 207, o cliente e a oportunidade já existem — não repita a requisição para não gerar duplicidade.

Observações

  • O escritório da operação é sempre o do usuário autenticado (vinculado ao token informado no header Authorization).
  • A ficha do cliente é deduplicada por CPF + escritório: se já existir, é reutilizada; senão, é criada.
Body Params
string
required

Nome do cliente

string
required

CPF do cliente (exatamente 11 dígitos)

string
required

Email válido do cliente

string

Telefone do cliente

string

CNPJ do cliente

int32
required

ID da fila de distribuição da oportunidade

int32
required

ID da origem (reutilizado como origem da venda)

int32
required

ID do produto (reutilizado como produto da venda)

int32
required

ID do estado inicial da oportunidade

string
required

Observação de aceite registrada na oportunidade

int32

ID de usuário para atribuição direta (ignora a distribuição por fila)

int32

Escritório do contrato da venda. Default: escritório do token

float

Valor acordado da venda (deve ser informado somente se lead_produto == 250)

string

Observação da venda

Headers
string
required
string
required
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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