curl --request POST \
--url 'https://crm.wavups.com/api/v1/lead' \
--header 'Token: SEU_TOKEN_DE_API' \
--header 'Content-Type: application/json' \
--data '{
"name": "Maria Souza",
"email": "maria@email.com",
"phone": "5511988887777",
"taxId": "12345678909",
"source": "site",
"leadType": "PF",
"leadTemperature": 3,
"utms": {
"utm_source": "fb",
"utm_medium": "paid",
"utm_campaign": "120243645529690704",
"utm_term": "120243645529720704",
"utm_content": "120247590343130704"
},
"status": "Lead"
}'
{
"id": "clxyz5678",
"leadOwner": null,
"name": "Maria Souza",
"email": "maria@email.com",
"phone": "5511988887777",
"taxId": "12345678909",
"source": "site",
"profileImage": null,
"zipCode": null,
"state": null,
"city": null,
"neighborhood": null,
"streetAddress": null,
"number": null,
"complement": null,
"description": null,
"leadType": "PF",
"leadTemperature": 3,
"metadata": null,
"utms": {
"utm_source": "fb",
"utm_medium": "paid",
"utm_campaign": "120243645529690704",
"utm_term": "120243645529720704",
"utm_content": "120247590343130704"
},
"status": "Lead",
"createdAt": "2025-06-15T14:30:00.000Z",
"updatedAt": "2025-06-15T14:30:00.000Z"
}
{
"error": "Error to create lead"
}
Leads
Criar Lead
Cria um novo lead para a conta autenticada.
POST
/
lead
curl --request POST \
--url 'https://crm.wavups.com/api/v1/lead' \
--header 'Token: SEU_TOKEN_DE_API' \
--header 'Content-Type: application/json' \
--data '{
"name": "Maria Souza",
"email": "maria@email.com",
"phone": "5511988887777",
"taxId": "12345678909",
"source": "site",
"leadType": "PF",
"leadTemperature": 3,
"utms": {
"utm_source": "fb",
"utm_medium": "paid",
"utm_campaign": "120243645529690704",
"utm_term": "120243645529720704",
"utm_content": "120247590343130704"
},
"status": "Lead"
}'
{
"id": "clxyz5678",
"leadOwner": null,
"name": "Maria Souza",
"email": "maria@email.com",
"phone": "5511988887777",
"taxId": "12345678909",
"source": "site",
"profileImage": null,
"zipCode": null,
"state": null,
"city": null,
"neighborhood": null,
"streetAddress": null,
"number": null,
"complement": null,
"description": null,
"leadType": "PF",
"leadTemperature": 3,
"metadata": null,
"utms": {
"utm_source": "fb",
"utm_medium": "paid",
"utm_campaign": "120243645529690704",
"utm_term": "120243645529720704",
"utm_content": "120247590343130704"
},
"status": "Lead",
"createdAt": "2025-06-15T14:30:00.000Z",
"updatedAt": "2025-06-15T14:30:00.000Z"
}
{
"error": "Error to create lead"
}
Atribuição de Setor de Atendimento:
Caso você deseje atribuir este lead a um setor de atendimento específico (ex: Vendas, Suporte), utilize o
id retornado nesta criação para chamar o endpoint Criar Conversa informando o accountChatSectorId.Requisição
POST https://crm.wavups.com/api/v1/lead
string
required
Seu token de autenticação.
Body
string
required
Nome do lead.
string
E-mail do lead.
string
Telefone do lead.
Padrão Estrito de Telefone (DDI + DDD + Número)O número deve estar estritamente no formato de dígitos com DDI + DDD/Código de Área + Número (exemplo Brasil:
5547999999999, exemplo EUA: 14155552671), sem espaços, traços, parênteses ou o símbolo +.Qualquer divergência neste formato causará falhas de envio na API do WhatsApp e duplicação de leads no sistema.string
CPF/CNPJ do lead.
string
Origem do lead (ex:
site, instagram, indicacao).string
ID do usuário responsável pelo lead.
string
URL da imagem de perfil do lead.
string
CEP do endereço do lead.
string
Estado do lead.
string
Cidade do lead.
string
Bairro do lead.
string
Logradouro do lead.
string
Número do endereço.
string
Complemento do endereço.
string
Descrição ou observações sobre o lead.
string
Tipo do lead (ex:
PF, PJ).number
Temperatura do lead como valor numérico.
object
Metadados adicionais do lead em formato JSON.
object
Parâmetros UTM associados ao lead em formato JSON. O objeto enviado deve conter as seguintes propriedades:
utm_source(string): Origem do tráfego (ex:fb,google,instagram).utm_medium(string): Meio do tráfego (ex:paid,cpc,organic,story).utm_campaign(string): Identificador ou nome da campanha (ex:120243645529690704).utm_term(string): Termo de pesquisa ou identificador de público/anúncio (ex:120243645529720704).utm_content(string): Conteúdo do anúncio ou identificador do criativo (ex:120247590343130704).
{
"utm_source": "fb",
"utm_medium": "paid",
"utm_campaign": "120243645529690704",
"utm_term": "120243645529720704",
"utm_content": "120247590343130704"
}
string
Status inicial do lead. Padrão:
Lead.Resposta
Retorna o objeto do lead criado com todos os campos, incluindo oaccountId.
string
Identificador único do lead criado.
string
ID da conta à qual o lead pertence.
string | null
ID do usuário responsável.
string
Nome do lead.
string | null
E-mail do lead.
string | null
Telefone do lead.
string | null
CPF/CNPJ do lead.
string | null
Origem do lead.
string | null
URL da imagem de perfil.
string | null
CEP.
string | null
Estado.
string | null
Cidade.
string | null
Bairro.
string | null
Logradouro.
string | null
Número do endereço.
string | null
Complemento.
string | null
Descrição ou observações.
string | null
Tipo do lead.
number | null
Temperatura do lead:
1 (Frio), 2 (Morno) ou 3 (Quente).object | null
Metadados adicionais do lead em formato JSON.
object | null
Parâmetros UTM associados ao lead em formato JSON.
string
Status do lead.
string
Data de criação (ISO 8601).
string
Data da última atualização (ISO 8601).
Exemplos
curl --request POST \
--url 'https://crm.wavups.com/api/v1/lead' \
--header 'Token: SEU_TOKEN_DE_API' \
--header 'Content-Type: application/json' \
--data '{
"name": "Maria Souza",
"email": "maria@email.com",
"phone": "5511988887777",
"taxId": "12345678909",
"source": "site",
"leadType": "PF",
"leadTemperature": 3,
"utms": {
"utm_source": "fb",
"utm_medium": "paid",
"utm_campaign": "120243645529690704",
"utm_term": "120243645529720704",
"utm_content": "120247590343130704"
},
"status": "Lead"
}'
{
"id": "clxyz5678",
"leadOwner": null,
"name": "Maria Souza",
"email": "maria@email.com",
"phone": "5511988887777",
"taxId": "12345678909",
"source": "site",
"profileImage": null,
"zipCode": null,
"state": null,
"city": null,
"neighborhood": null,
"streetAddress": null,
"number": null,
"complement": null,
"description": null,
"leadType": "PF",
"leadTemperature": 3,
"metadata": null,
"utms": {
"utm_source": "fb",
"utm_medium": "paid",
"utm_campaign": "120243645529690704",
"utm_term": "120243645529720704",
"utm_content": "120247590343130704"
},
"status": "Lead",
"createdAt": "2025-06-15T14:30:00.000Z",
"updatedAt": "2025-06-15T14:30:00.000Z"
}
{
"error": "Error to create lead"
}
Authorizations
Token de autenticacao gerado na plataforma WavUps CRM.
Body
application/json
Nome do lead.
E-mail do lead.
Telefone no formato internacional sem simbolos: 5547999999999 (pais + DDD + numero). Outros formatos causarao erros nos disparos via WhatsApp.
Example:
"5547999999999"
CPF ou CNPJ do lead.
Example:
"12345678909"
Origem do lead (ex: site, instagram, indicacao).
ID do usuario responsavel pelo lead.
URL da imagem de perfil do lead.
CEP do endereco.
Estado.
Cidade.
Bairro.
Logradouro.
Numero do endereco.
Complemento do endereco.
Descricao ou observacoes sobre o lead.
Tipo do lead (ex: PF, PJ).
Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).
Available options:
1, 2, 3 Status inicial do lead. Padrao: Lead.
Metadados adicionais do lead em formato JSON.
Parâmetros UTM associados ao lead em formato JSON.
Show child attributes
Show child attributes
Response
Lead criado com sucesso.
Telefone no formato 5547999999999 (pais + DDD + numero, sem espacos ou simbolos).
Example:
"5547999999999"
CPF ou CNPJ do lead.
Example:
"12345678909"
Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).
Metadados adicionais do lead em formato JSON.
Parâmetros UTM associados ao lead em formato JSON.
Show child attributes
Show child attributes
Lista de conversas vinculadas ao lead.
Show child attributes
Show child attributes