Criar 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"
}

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

Requisição

string

required

Seu token de autenticação.

Body

string

required

Nome do lead.

string

E-mail do lead.

string

Telefone do lead.

O número deve estar no formato 5547999999999 (código do país + DDD + número, sem espaços, traços ou parênteses). Qualquer outro formato — como 47 999999999 ou (47) 99999-9999 — causará erros nos disparos via WhatsApp.

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

Exemplo:

{
  "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 o accountId.

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

string

header

required

Token de autenticacao gerado na plataforma WavUps CRM.

Body

application/json

name

string

required

Nome do lead.

string

E-mail do lead.

phone

string

Telefone no formato internacional sem simbolos: 5547999999999 (pais + DDD + numero). Outros formatos causarao erros nos disparos via WhatsApp.

Example:

"5547999999999"

taxId

string

CPF ou CNPJ do lead.

Example:

"12345678909"

source

string

Origem do lead (ex: site, instagram, indicacao).

leadOwner

string

ID do usuario responsavel pelo lead.

profileImage

string

URL da imagem de perfil do lead.

zipCode

string

CEP do endereco.

state

string

Estado.

city

string

Cidade.

neighborhood

string

Bairro.

streetAddress

string

Logradouro.

number

string

Numero do endereco.

complement

string

Complemento do endereco.

description

string

Descricao ou observacoes sobre o lead.

leadType

string

Tipo do lead (ex: PF, PJ).

leadTemperature

enum<integer>

Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).

Available options:

1,

2,

3

status

string

Status inicial do lead. Padrao: Lead.

metadata

object | null

Metadados adicionais do lead em formato JSON.

utms

object | null

Parâmetros UTM associados ao lead em formato JSON.

Show child attributes

Response

Lead criado com sucesso.

string

leadOwner

string | null

name

string

string | null

phone

string | null

Telefone no formato 5547999999999 (pais + DDD + numero, sem espacos ou simbolos).

Example:

"5547999999999"

taxId

string | null

CPF ou CNPJ do lead.

Example:

"12345678909"

source

string | null

profileImage

string | null

zipCode

string | null

state

string | null

city

string | null

neighborhood

string | null

streetAddress

string | null

number

string | null

complement

string | null

description

string | null

leadType

string | null

leadTemperature

number | null

Temperatura do lead: 1 (Frio), 2 (Morno), 3 (Quente).

status

string

metadata

object | null

Metadados adicionais do lead em formato JSON.

utms

object | null

Parâmetros UTM associados ao lead em formato JSON.

Show child attributes

createdAt

string<date-time>

Visão Geral

Membros da Conta

Leads

Categorias

Produtos

Atendimentos

Agendamentos

Conversas

Setores do Chat

Pipeline de CRM

Estágios do Pipeline

Negócios do Pipeline

Leads

Categorias

Produtos

Atendimentos

Agendamentos

Conversas

Setores do Chat

Membros da Conta

Pipeline de CRM

Estágios do Pipeline

Negócios do Pipeline

Requisição

Body

Resposta

Exemplos

Authorizations

Body

Response

​Requisição

​Body

​Resposta

​Exemplos

Authorizations

Body

Response

Requisição

Body

Resposta

Exemplos