---
title: "Inserir Leads"
method: POST
path: "/LeadsAdd"
tags: ["Leads"]
---

# Inserir Leads

`POST /LeadsAdd`

## Request

- Base URL: `https://api.exactspotter.com/v3`
- URL: `https://api.exactspotter.com/v3/LeadsAdd`
- Auth: API key in header `token_exact`

Esta seção está atrelada ao cadastro de um lead na empresa, fazendo referência aos dados que deverão ser inseridos no ato da criação. Também é possível neste momento fazer a criação de campos personalizados para este lead, caso o cliente desejar. *Temos a internacionalização dos telefones agora inserir o DDI no campo ddiPhone e o número com DDD sem o zero conforme abaixo: + Campos utilizados para realizar a inserção do lead: + Campos utilizados para o Custom Fields (campos personalizados) Obs: quando o campo personalizado for do tipo que contenha mais de uma opção, o usuário pode entrar com o value, o identificador da opção ou ambos. Qualquer uma das situações são aceitáveis + Campo obrigatório: + Campo de parametrização: Caso contrário, se for false, ignora a validação e permite o cadastro com duplicidade. + Campos que o sistema valida a duplicidade :

## Request body

- object
  - `duplicityValidation` boolean
  - `lead` object
    - `name` string
    - `industry` string
    - `source` string
    - `subSource` string
    - `organizationId` string
    - `sdrEmail` string
    - `group` string
    - `mktLink` string
    - `ddiPhone` string
    - `phone` string
    - `ddiPhone2` string
    - `phone2` string
    - `website` string
    - `leadProduct` string
    - `address` string
    - `addressNumber` string
    - `addressComplement` string
    - `neighborhood` string
    - `zipcode` string
    - `city` string
    - `state` string
    - `country` string
    - `cpfcnpj` string
    - `description` string
    - `funnelId` integer
    - `stage` string
    - `customFields` object[]
      - `id` string
      - `value` string
      - `options` unknown[]
        - unknown
  - `name` string: Referente ao nome da empresa
  - `industry` string: Especifica em qual mercado esta empresa atua
  - `source` string: Nome da origem
  - `subSource` string: Nome da sub-origem
  - `organizationId` string: Id da organização
  - `sdrEmail` string: E-mail do pré-vendedor que ficará responsável pelo lead em questão
  - `group` string: Nome do grupo
  - `mktLink` string: URL do marketing da empresa
  - `ddiPhone` string: DDI do país em questão
  - `phone` string: Telefone da empresa
  - `ddiPhone2` string: Segunda opção do DDI do país em questão
  - `phone2` string: DDD + Segunda opção de telefone da empresa sem o 0
  - `website` string: Referente ao site da empresa
  - `leadProduct` string: Descrição do produto oferecido pelo lead
  - `address` string: Endereço da empresa
  - `addressNumber` string: Número do endereço da empresa
  - `addressComplement` string: Complementação do endereço da empresa, caso tenha
  - `neighborhood` string: Bairro
  - `zipcode` string: Refere-se ao CEP ou o código da região que a empresa se encontra
  - `city` string: A cidade que a empresa se encontra
  - `state` string: O estado desta
  - `country` string: País que a empresa se localiza
  - `description` string: Qualquer observação que se deseja fazer a respeito do lead que está sendo inserido
  - `cpfcnpj` string: CPF/CNPJ da empresa
  - `funnelId` string: Id do funil pra qual deseja que o lead seja cadastrado
  - `stage` string: Nome da etapa que deseja que o lead seja cadastrado. Necessário informar o funnelId. Caso não informar o funnelId, o lead será cadastrado na primeira etapa do funil padrão, ignorando a etapa informada.
  - `id` string: identificação do campo personalizado
  - `value` string: valor do campo personalizado

## Response `201`

Recurso criado com sucesso

- integer

## Other responses

- `401`: Token inválido ou ausente

---

[API](https://skmtc.dev/rdstation/apis/exact-spotter-api-v3.md) - [All operations](https://skmtc.dev/rdstation/apis/exact-spotter-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/rdstation/apis/exact-spotter-api-v3/revisions/9dfdc43e5249?raw)
