Skip to main content
POST
/
integrations
/
external
/
leads
Criação de lead
curl --request POST \
  --url https://api.wegly.com.br/integrations/external/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Lead vindo do site",
  "phone": "11988887777",
  "visibility": 0,
  "marketing": {
    "url_conversion": "https://meusite.com/obrigado?wegly_code=ABC123&utm_campaign=lancamento"
  },
  "lead_source": {
    "name": "Formulário do site"
  },
  "person": {
    "name": "Maria Souza",
    "contacts": [
      {
        "type": 0,
        "value": "+55 (11) 98888-7777"
      }
    ],
    "avoid_duplicate": true,
    "duplicate_check_types": [
      0
    ]
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": 123,
  "title": "<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.

Body

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

Estágio alvo. Caso omitido, usa a primeira etapa do funil primário.

responsible_id
string<uuid>

Responsável pelo lead. 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.

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

Origem existente. Conflita com lead_source.

lead_source
object
followers
object[]

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

note
object

Response

Lead criado com sucesso.

id
string<uuid>
code
integer

Código sequencial interno do lead.

title
string