Atualiza campos de um lead existente.

curl --request PUT \
  --url https://api.wegly.com/v1/integrations/external/leads/{id} \
  --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,
  "persons_id": [
    {
      "person_id": "<string>",
      "delete": true
    }
  ],
  "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": "<unknown>",
  "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>"
  }
}
'

{
  "id": "<string>",
  "code": 123,
  "title": "<string>",
  "status": 123,
  "quality_rating": 123,
  "quality_reason": "<string>",
  "lost_reason_description": "<string>"
}

PUT

integrations

external

leads

{id}

Atualiza campos de um lead existente.

curl --request PUT \
  --url https://api.wegly.com/v1/integrations/external/leads/{id} \
  --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,
  "persons_id": [
    {
      "person_id": "<string>",
      "delete": true
    }
  ],
  "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": "<unknown>",
  "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>"
  }
}
'

{
  "id": "<string>",
  "code": 123,
  "title": "<string>",
  "status": 123,
  "quality_rating": 123,
  "quality_reason": "<string>",
  "lost_reason_description": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

ID ou codigo do lead para atualizar.

Body

application/json

Alteracoes permitidas para o lead.

title

string

required

Novo titulo ou palavara-chave para identificar o lead.

Maximum string length: 150

stage_id

string

ID da etapa de destino caso deseje mover o lead.

responsible_id

string

ID do novo responsavel do lead.

quality_rating

integer

Atualizacao da nota de qualidade do lead.

Required range: 1 <= x <= 5

quality_reason

string

Justificativa textual para a classificacao de qualidade.

phone

string

Telefone atualizado.

string

Email atualizado.

visibility

enum<integer>

Visibilidade do lead apos a atualizacao: 0 (somente criador) ou 1 (todos).

Available options:

0,

1

persons_id

object[]

IDs de pessoas a serem adicionadas ou removidas (use delete = true para excluir).

Show child attributes

persons_id.person_id

string

required

ID da pessoa que deve ser associada ao lead.

persons_id.delete

boolean

Indica se a pessoa deve ser removida do lead.

person

object

Dados de pessoa para atualizar ou adicionar aos participantes.

Show child attributes

person.name

string

required

Nome completo da pessoa.

person.birth_date

string<date-time>

Data de nascimento no padrao ISO 8601.

person.gender

integer

Identificador numerico do genero (opcional).

person.notes

string

Observacoes livres relacionadas a pessoa.

person.contacts

object[]

Lista de contatos (telefone, email) para evitar duplicidade.

Show child attributes

person.contacts.value

string

required

Valor do contato (email ou telefone).

person.contacts.type

integer

required

Tipo numerico do contato (segundo definicoes internas).

person.avoid_duplicate

boolean

Quando true, o sistema busca pessoa existente antes de criar.

person.duplicate_check_types

integer[]

Tipos de contato usados para detectar duplicatas (ex: telefone, email).

organization_id

string | null

ID da organizacao; use null para desvincular.

organization

object

Dados para criar ou atualizar a organizacao vinculada.

Show child attributes

organization.name

string

required

organization.legal_name

string

organization.document

string

organization.industry

string

organization.description

string

organization.phone

string

organization.email

string

organization.site

string

custom_fields

object[]

Atualizacao dos valores de campos personalizados.

Show child attributes

custom_fields.id

string

required

ID do campo personalizado.

custom_fields.value

string

Valor textual enviado para o campo.

custom_fields.option_id

string

ID da opcao selecionada quando o campo for do tipo selecao.

custom_fields.option_ids

string[]

Lista de IDs de opcoes para campos multiselecionaveis.

marketing

object

Atualiza as informacoes de rastreamento de marketing.

Show child attributes

marketing.wegly_code

string

Codigo Wegly que identifica a campanha de marketing.

marketing.wegly_campaign

string

Nome da campanha Wegly associada ao lead.

marketing.wegly_ad_set

string

Nome do conjunto de anuncios vinculado.

marketing.wegly_content

string

Conteudo exibido para o lead na campanha.

marketing.wegly_displayed_on

string

Local ou plataforma onde o conteudo foi exibido.

marketing.wegly_conversion_tool

string

Ferramenta de conversao utilizada para gerar o lead.

marketing.wegly_creative

string

Identificador criativo Wegly associado.

marketing.gclid

string

Google Click ID vindo do anuncio.

marketing.fbclid

string

Facebook Click ID enviado pelo pixel.

marketing.url_conversion

string

URL de conversao usada para extrair parametros adicionais.

marketing.utm_search_term

string

Termo de busca registrado pela URL.

marketing.utm_source

string

Origem padrao (utm_source) equivalente a Wegly code.

marketing.utm_campaign

string

Nome da campanha padrao (utm_campaign).

marketing.utm_ad_set

string

Identificador padrao para ad set (utm_ad_set).

marketing.utm_content

string

Conteudo padrao (utm_content) associado.

marketing.utm_term

string

Termo padrao (utm_term) da URL.

marketing.utm_display_on

string

Local de exibicao padrao (utm_display_on).

crm_lead_source_id

string

ID manual da origem quando for alterada.

lead_source

object

Nome alternativo para origem manual do lead.

Show child attributes

lead_source.name

string

required

Nome descritivo da fonte externa do lead.

Response

Lead atualizado com novos dados basicos.

string

required

code

integer

required

title

string

required

status

integer

required

quality_rating

integer | null

quality_reason

string | null

lost_reason_description

string | null

Busca um lead especifico pelo ID ou codigo.

⌘I

API Reference

Authorizations

Path Parameters

Body

Response