Skip to main content
PUT
Atualização de lead

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.

Path Parameters

id
string<uuid>
required

UUID do registro.

Body

application/json

O PUT exige title. Os demais campos são opcionais; campos omitidos são preservados. Use as rotas de seguidores para alterar seguidores.

title
string
required
Required string length: 1 - 150
stage_id
string<uuid>
responsible_id
string<uuid>

Usuário ativo da empresa. Um responsável inativo retorna 400; a substituição pelo master vale apenas na criação.

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

0 = privado; 1 = visível ao time, conforme as regras de acesso do CRM.

Available options:
0,
1
persons_id
object[]

Lista de operações de associação ou remoção de participantes. delete: true remove a pessoa do lead; omita ou envie false para adicionar.

person
object
organization_id
string | null

Organização existente. Envie null para remover a organização atual. Conflita com organization.

organization
object
custom_fields
object[]

Quando enviado com itens, substitui todas as respostas do registro; reenvie o conjunto completo.

Quando omitido, preserva o valor efetivo atual.

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> | null

Origem existente. null remove a origem do registro e da aquisição atual.

Response

Lead atualizado.

Retorno enxuto da atualização.

id
string
code
integer
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
quality_rating
integer | null
quality_reason
string | null
status
enum<integer>

1 = aberto, 2 = ganho, 3 = perdido.

Available options:
1,
2,
3
lost_reason_description
string | null
value
number | null