Skip to main content
PUT
/
integrations
/
external
/
leads
/
{id}
Atualização de lead
curl --request PUT \
  --url https://api.wegly.com.br/integrations/external/leads/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Lead ajustado",
  "persons_id": [
    {
      "person_id": "2c7f0b73-1b5b-4ce0-9b8c-22c55c7cc111"
    },
    {
      "person_id": "9c1de125-7d0a-4e9f-8f8a-8b233c6f6e99",
      "delete": true
    }
  ],
  "organization_id": null,
  "custom_fields": [
    {
      "id": "f0d82e2b-a6b0-48e9-a4f2-6d3d2e6e9d11",
      "value": "Prioritário"
    }
  ]
}
'
{
  "id": "<string>",
  "code": 123,
  "title": "<string>",
  "quality_rating": 123,
  "quality_reason": "<string>",
  "status": 1,
  "lost_reason_description": "<string>"
}

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
​
phone
string
​
email
string
​
visibility
enum<integer>

0 = privado (responsável, membros dos times do responsável e supervisores), 1 = restrito ao responsável e times relacionados, 2 = público para todos na empresa.

Available options:
0,
1,
2
​
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[]
​
marketing
object

Rastreio de marketing. Todos os valores são sanetizados (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.

​
crm_lead_source_id
string<uuid>
​
lead_source
object

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