Sign in

v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB
Leads

Inserir Leads

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 :

post/LeadsAdd

Request body

duplicityValidationboolean
namestring

Referente ao nome da empresa

industrystring

Especifica em qual mercado esta empresa atua

sourcestring

Nome da origem

subSourcestring

Nome da sub-origem

organizationIdstring

Id da organização

sdrEmailstring

E-mail do pré-vendedor que ficará responsável pelo lead em questão

groupstring

Nome do grupo

mktLinkstring

URL do marketing da empresa

ddiPhonestring

DDI do país em questão

phonestring

Telefone da empresa

ddiPhone2string

Segunda opção do DDI do país em questão

phone2string

DDD + Segunda opção de telefone da empresa sem o 0

websitestring

Referente ao site da empresa

leadProductstring

Descrição do produto oferecido pelo lead

addressstring

Endereço da empresa

addressNumberstring

Número do endereço da empresa

addressComplementstring

Complementação do endereço da empresa, caso tenha

neighborhoodstring

Bairro

zipcodestring

Refere-se ao CEP ou o código da região que a empresa se encontra

citystring

A cidade que a empresa se encontra

statestring

O estado desta

countrystring

País que a empresa se localiza

descriptionstring

Qualquer observação que se deseja fazer a respeito do lead que está sendo inserido

cpfcnpjstring

CPF/CNPJ da empresa

funnelIdstring

Id do funil pra qual deseja que o lead seja cadastrado

stagestring

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.

idstring

identificação do campo personalizado

valuestring

valor do campo personalizado

Example request

{
  "lead": {
    "name": "Nome do lead",
    "industry": "Nome do Mercado",
    "source": "Nome da Origem",
    "subSource": "Nome da sub-origem",
    "organizationId": "Id da organização",
    "sdrEmail": "Email do pé-vendedor que vai ser responsavel pelo lead",
    "group": "Nome do grupo",
    "mktLink": "URL do marketing da Empresa",
    "ddiPhone": "55",
    "phone": "48991234567",
    "ddiPhone2": "55",
    "phone2": "4832321234",
    "website": "Web site da Empresa",
    "leadProduct": "Descrição do produto oferecido pelo lead",
    "address": "Endereço da Empresa",
    "addressNumber": "123456",
    "addressComplement": "Complemento do endereço da Empresa",
    "neighborhood": "Bairro do endereço",
    "zipcode": "CEP ou Código da região",
    "city": "Florianópolis",
    "state": "SC",
    "country": "Brasil",
    "cpfcnpj": "21593012000147",
    "description": "Observações diversas acerca do lead",
    "funnelId": 1234,
    "stage": "Nome da etapa"
  }
}

Response

Recurso criado com sucesso

integer required

Example response

175216