Skip to main content
POST
/
integrations
/
external
/
leads
Cria um lead a partir de uma integracao externa
curl --request POST \
  --url https://api.wegly.com/v1/integrations/external/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "stage_id": "<string>",
  "responsible_id": "<string>",
  "quality_rating": 3,
  "quality_reason": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "visibility": 0,
  "tags": [
    "<string>"
  ],
  "persons_id": [
    {
      "person_id": "<string>"
    }
  ],
  "person": {
    "name": "<string>",
    "birth_date": "2023-11-07T05:31:56Z",
    "gender": 123,
    "notes": "<string>",
    "contacts": [
      {
        "value": "<string>",
        "type": 123
      }
    ],
    "avoid_duplicate": true,
    "duplicate_check_types": [
      123
    ]
  },
  "organization_id": "<string>",
  "organization": {
    "name": "<string>",
    "legal_name": "<string>",
    "document": "<string>",
    "industry": "<string>",
    "description": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "site": "<string>"
  },
  "custom_fields": [
    {
      "id": "<string>",
      "value": "<string>",
      "option_id": "<string>",
      "option_ids": [
        "<string>"
      ]
    }
  ],
  "marketing": {
    "wegly_code": "<string>",
    "wegly_campaign": "<string>",
    "wegly_ad_set": "<string>",
    "wegly_content": "<string>",
    "wegly_displayed_on": "<string>",
    "wegly_conversion_tool": "<string>",
    "wegly_creative": "<string>",
    "gclid": "<string>",
    "fbclid": "<string>",
    "url_conversion": "<string>",
    "utm_search_term": "<string>",
    "utm_source": "<string>",
    "utm_campaign": "<string>",
    "utm_ad_set": "<string>",
    "utm_content": "<string>",
    "utm_term": "<string>",
    "utm_display_on": "<string>"
  },
  "crm_lead_source_id": "<string>",
  "lead_source": {
    "name": "<string>"
  },
  "followers": [
    {
      "user_id": "<string>",
      "role_id": "<string>",
      "notes": "<string>"
    }
  ],
  "note": {
    "content": "<string>",
    "is_pinned": true
  }
}
'
{
  "id": "<string>",
  "code": 123,
  "title": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Payload com os dados do lead a ser criado.

title
string
required

Titulo/assunto do lead (obrigatorio).

Maximum string length: 150
stage_id
string

ID da etapa onde o lead deve ser criado dentro da empresa (opcional).

responsible_id
string

ID do responsavel do lead; se ausente sera usado o usuario da chave de integracao.

quality_rating
integer

Nota de qualidade do lead (1 = menor, 5 = maior) para analises.

Required range: 1 <= x <= 5
quality_reason
string

Descricao textual sobre a avaliacao de qualidade atribuida ao lead.

phone
string

Telefone principal do lead.

email
string

Email principal de contato do lead.

visibility
enum<integer>

Visibilidade do lead: 0 (somente criador) ou 1 (todos da equipe).

Available options:
0,
1
tags
string[]

Lista de nomes de tags para associar ao lead.

persons_id
object[]

IDs de pessoas ja existentes que devem ser associadas ao lead.

person
object

Dados detalhados para criar uma nova pessoa quando necessario.

organization_id
string

ID da organizacao existente a ser vinculada ao lead.

organization
object

Dados da organizacao a ser criada ou atualizada.

custom_fields
object[]

Conjunto de valores para campos personalizados.

marketing
object

Informacoes de rastreamento de marketing e parametros de URL.

crm_lead_source_id
string

ID manual de origem de marketing (crm_lead_source) para o lead.

lead_source
object

Nome da fonte de lead quando nao ha registro em crm_lead_source.

followers
object[]

Lista de usuarios que serao adicionados como seguidores do lead.

note
object

Nota inicial opcional para o lead.

Response

Lead criado com codigo sequencial.

id
string
required
code
integer
required
title
string
required