Skip to main content
POST
Criação de oportunidades

Authorizations

Authorization
string
header
required

Utilize o token de integração no header Authorization: Bearer {token}. O domínio de origem (Origin/Referer) deve respeitar allowed_domain, quando configurado na chave.

Body

application/json
title
string
required
Maximum string length: 150
stage_id
string<uuid>

Etapa do funil de oportunidades. Caso omitido, usa a primeira etapa do funil primário.

responsible_id
string<uuid>

Responsável pela oportunidade. Padrão: criador da chave.

quality_rating
enum<integer>
Available options:
1,
2,
3,
4,
5
quality_reason
string

Motivo da qualificação; obrigatório se o funil exigir.

value
number

Valor monetário com até 2 casas decimais.

expected_close_date
string<date-time>

Data prevista de fechamento.

visibility
enum<integer>

0 = privado (responsável e supervisores), 1 = equipe/responsável, 2 = público.

Available options:
0,
1,
2
temperature
enum<integer>

1 = frio, 2 = morno, 3 = quente.

Available options:
1,
2,
3
tags
string[]

Lista de IDs de tags existentes. IDs inexistentes resultam em erro.

persons_id
object[]

IDs de pessoas já cadastradas que serão associadas.

person
object

Pessoa associada à oportunidade. Envie telefone, e-mail e redes sociais em contacts; phone e email no topo da oportunidade não fazem parte do contrato.

primary_person_id
string<uuid>

Define o participante principal quando múltiplas pessoas são associadas.

organization_id
string<uuid>

Organização existente. Conflita com organization.

organization
object
custom_fields
object[]
marketing
object

Rastreio de marketing. Todos os valores são sanitizados (trim) e campos vazios são ignorados. utm_* são normalizados para wegly_* equivalentes quando estes não forem enviados. utm_term vira utm_search_term se o campo específico não for enviado. url_conversion tem seus parâmetros extraídos automaticamente (wegly_, utm_, gclid, fbclid, conversion_tool_name). Quando wegly_code referencia um tracker válido, a origem do lead é extraída do tracker. Quando não há tracker nem origem explícita, wegly_source ou utm_source busca/cria a origem automaticamente.

crm_lead_source_id
string<uuid>

Origem existente. Única forma aceita para informar origem manual nesta API.

followers
object[]

Seguidores adicionados após a criação da oportunidade. Usuários duplicados na lista são ignorados.

note
object

Response

Oportunidade criada com sucesso.

Retorno da criação de oportunidade.

id
string<uuid>
code
integer

Código sequencial interno da oportunidade.

title
string