Skip to main content
POST
Criação de oportunidades

Authorizations

Authorization
string
header
required

Chave de integração com prefixo wegly_, enviada em Authorization: Bearer . Não é JWT. A chave deve estar ativa, não excluída e dentro da validade. Com allowed_domain, Origin (ou Referer na ausência de Origin) precisa informar o hostname permitido. A empresa e as permissões são obtidas pela chave.

Headers

x-idempotency-key
string

Chave da tentativa lógica de criação. Tem prioridade sobre idempotency_key no body; mantenha a mesma chave ao repetir uma chamada sem resposta e use uma nova depois de uma criação que falhou após iniciada.

Body

application/json
title
string
required
Required string length: 1 - 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. Se o usuário informado estiver inativo ou arquivado, o registro é atribuído ao usuário master da conta, com nota automática; usuário inexistente ou de outra empresa retorna 400.

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
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[]

Respostas dos campos personalizados. Todos os campos obrigatórios da entidade precisam ser enviados; campos do tipo arquivo não são aceitos nesta rota.

Padrão GRANTED quando omitido na criação.

Available options:
GRANTED,
DENIED,
UNSPECIFIED
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_code, wegly_source, wegly_campaign, wegly_ad_set, wegly_content, wegly_displayed_on, wegly_conversion_tool, utm_*, gclid, fbclid). Em POST e PUT, measurement_consent na URL também é extraído. Valor desconhecido, duplicado divergente ou presente em URL malformada vira UNSPECIFIED; divergência com o body retorna 400. Sem GRANTED, obref é removido da query e o fragmento inteiro da URL completa é descartado; a URL integral nunca é registrada em logs. O alias isolado, um objeto vazio ou somente campos nulos/em branco não constituem aquisição e não criam snapshot/log. Quando wegly_code referencia um tracker válido e não há crm_lead_source_id, a origem do registro é a do tracker. No PUT, os campos enviados corrigem a aquisição atual: omitidos são preservados e null limpa o valor. 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. Se a gravação falhar, a API retorna erro, mas o registro permanece criado.

note
object
idempotency_key
string

Chave da tentativa lógica de criação. O header x-idempotency-key, quando preenchido, tem prioridade. Reutilize a mesma chave para repetir uma chamada sem resposta; depois de uma criação que falhou após iniciada, use uma nova chave.

Maximum string length: 255

Response

Oportunidade criada com sucesso.

Retorno da criação de oportunidade.

id
string<uuid>
code
integer

Código sequencial interno da oportunidade.

title
string

Consentimento para mensuração: GRANTED autoriza, DENIED recusa e UNSPECIFIED registra que não houve decisão informada. Em respostas de registros históricos sem valor canônico oficial, a API usa a decisão oficial do snapshot ativo mais recente; snapshots sem decisão não a sombreiam e a ausência de ambos resulta em UNSPECIFIED, sem backfill.

Available options:
GRANTED,
DENIED,
UNSPECIFIED