Skip to main content
PATCH
/
v1
/
leads
/
{id}
curl --request PATCH \
  --url https://api.superlead.app/v1/leads/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "joao@empresa.com",
  "document": "123.456.789-01",
  "cep": "01310-100",
  "address": "Av. Paulista",
  "address_number": "1000",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR"
}
'
{
  "id": "lead_0b5f8a3e-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
  "name": "João Silva",
  "phone": "+5511999999999",
  "source": "Meta Ads",
  "channel": "WhatsApp",
  "entry_point": "ctwa",
  "funnel_stage": "1º Contato",
  "document": "123.456.789-01",
  "document_type": "cpf",
  "cep": "01310-100",
  "address": "Av. Paulista",
  "address_number": "1000",
  "address_complement": null,
  "neighborhood": "Bela Vista",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "created_at": "2026-06-01T12:00:00.000Z"
}
{
  "error": {
    "code": "invalid_request",
    "message": "The request body is invalid.",
    "request_id": "req_01J9X7K2M3N4P5Q6R7S8T9V0W1",
    "details": [
      {
        "path": "to",
        "message": "Required"
      }
    ]
  }
}
{
  "error": {
    "code": "invalid_api_key",
    "message": "Missing or invalid API key. Send it as 'Authorization: Bearer sk_...'.",
    "request_id": "req_01J9X7K2M3N4P5Q6R7S8T9V0W1"
  }
}
{
  "error": {
    "code": "lead_not_found",
    "message": "No lead matches this recipient in your company. The API only messages existing leads.",
    "request_id": "req_01J9X7K2M3N4P5Q6R7S8T9V0W1"
  }
}

Authorizations

​
Authorization
string
header
required

Chave de API da sua empresa (sk_...). Crie no painel Superlead em Integrações → API e envie em toda chamada como Authorization: Bearer sk_.... Veja Autenticação.

Path Parameters

​
id
string
required

Id do lead (lead_...), retornado por POST /v1/leads, GET /v1/leads?phone=... ou GET /v1/leads/{id}.

Body

application/json
​
name
string

Nome do lead, até 200 caracteres. Não aceita null.

Required string length: 1 - 200
Example:

"João Silva"

​
email
string<email> | null

E-mail do lead. Envie null para limpar.

Example:

"joao@empresa.com"

​
notes
string | null

Observações livres, até 2000 caracteres. Envie null para limpar.

Maximum string length: 2000
​
source
string

Origem do lead exibida no painel. Não aceita null.

Required string length: 1 - 120
Example:

"Indicação"

​
channel
string | null

Canal de origem. Envie null para limpar.

Required string length: 1 - 120
Example:

"WhatsApp"

​
entry_point
string | null

Ponto de entrada da conversão. Envie null para limpar.

Required string length: 1 - 120
​
utm_source
string | null

Atribuição: origem da campanha. Envie null para limpar.

Required string length: 1 - 255
Example:

"google"

​
utm_medium
string | null

Atribuição: mídia. Envie null para limpar.

Required string length: 1 - 255
Example:

"cpc"

​
utm_campaign
string | null

Atribuição: campanha. Envie null para limpar.

Required string length: 1 - 255
​
utm_term
string | null

Atribuição: termo de busca. Envie null para limpar.

Required string length: 1 - 255
​
utm_content
string | null

Atribuição: variação do anúncio. Envie null para limpar.

Required string length: 1 - 255
​
document
string | null

CPF ou CNPJ, com ou sem pontuação. Sem document_type, o tipo é inferido pelo tamanho. Envie null para limpar.

Example:

"123.456.789-01"

​
document_type
enum<string> | null

Tipo do documento. Opcional — inferido pelo tamanho de document quando omitido.

Available options:
cpf,
cnpj
​
cep
string | null

CEP do endereço. Envie null para limpar.

Example:

"01310-100"

​
address
string | null

Logradouro. Envie null para limpar.

Required string length: 1 - 200
Example:

"Av. Paulista"

​
address_number
string | null

Número. Envie null para limpar.

Required string length: 1 - 30
Example:

"1000"

​
address_complement
string | null

Complemento. Envie null para limpar.

Required string length: 1 - 120
Example:

"Conjunto 51"

​
neighborhood
string | null

Bairro. Envie null para limpar.

Required string length: 1 - 200
Example:

"Bela Vista"

​
city
string | null

Cidade. Envie null para limpar.

Required string length: 1 - 200
Example:

"São Paulo"

​
state
string | null

Estado (UF). Envie null para limpar.

Required string length: 1 - 50
Example:

"SP"

​
country
string | null

País. Envie null para limpar.

Example:

"BR"

Response

Lead atualizado — cadastro completo após o update.

​
id
string

Id do lead no Superlead (lead_...). Estável — use nas demais chamadas.

Example:

"lead_0b5f8a3e-1a2b-3c4d-5e6f-7a8b9c0d1e2f"

​
name
string | null

Nome do lead.

Example:

"João Silva"

​
phone
string | null

Telefone em E.164. null para leads sem telefone exposto (username do WhatsApp).

Example:

"+5511999999999"

​
source
string | null

Origem do lead exibida no painel.

Example:

"Meta Ads"

​
channel
string | null

Canal de origem.

Example:

"WhatsApp"

​
entry_point
string | null

Ponto de entrada da conversão.

Example:

"ctwa"

​
funnel_stage
string | null

Nome da etapa atual do funil. Para mover, use PUT /v1/leads/{id}/stage.

Example:

"1º Contato"

​
document
string | null

CPF ou CNPJ do lead.

Example:

"123.456.789-01"

​
document_type
enum<string> | null

Tipo do documento.

Available options:
cpf,
cnpj
Example:

"cpf"

​
cep
string | null

CEP do endereço.

Example:

"01310-100"

​
address
string | null

Logradouro.

Example:

"Av. Paulista"

​
address_number
string | null

Número.

Example:

"1000"

​
address_complement
string | null

Complemento.

Example:

"Conjunto 51"

​
neighborhood
string | null

Bairro.

Example:

"Bela Vista"

​
city
string | null

Cidade.

Example:

"São Paulo"

​
state
string | null

Estado (UF).

Example:

"SP"

​
country
string | null

País.

Example:

"BR"

​
created_at
string<date-time>

Data de criação do lead (ISO 8601, UTC).

Example:

"2026-06-01T12:00:00.000Z"