Skip to main content
PUT
Atualização de lead

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.

Path Parameters

id
string
required

UUID do lead a ser atualizado.

Body

application/json
title
string
required
Maximum string length: 150
stage_id
string<uuid>
responsible_id
string<uuid>
quality_rating
enum<integer>
Available options:
1,
2,
3,
4,
5
quality_reason
string
visibility
enum<integer>

0 = privado (responsável, membros dos times do responsável e supervisores), 1 = restrito ao responsável e times relacionados.

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

Pessoa associada ao lead. Envie telefone, e-mail e redes sociais em contacts; phone e email no topo do lead não são aceitos.

organization_id
string<uuid> | null

Organização existente. Envie null para remover a organização atual. 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>

Response

Lead atualizado.

Retorno enxuto da atualização.

id
string
code
integer
title
string
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