Adicionar Prospect

Descrição

Permite a criação de prospect (potencial cliente)

📨 Corpo da Requisição (Request Body)

Parâmetro	Tipo	Descrição	Obrigatório
name	string	Nome do prospect.	Sim
email	string	E-mail do prospect.	Sim
lastName	string	Sobrenome do prospect.	Sim
idBranch	int32	ID da unidade (filial) associada.	Sim
ddi	string	Código DDI do telefone (ex: +55).	Não
cellphone	string	Número de celular do prospect.	Sim
birthday	date-time	Data de nascimento (formato ISO 8601).	Não
gender	string	Gênero do prospect {M, F, P}.	Não
visit	int32	Código da origem da visita/campanha.	Não
marketingType	string	Tipo de marketing associado.	Não
notes	string	Notas ou observações adicionais.	Não
currentStep	string	Etapa atual no funil de conversão.	Não
cpf	string	CPF do prospect.	Não
passport	string	Número de passaporte do prospect.	Não
rg	string	Número de RG do prospect.	Não
address	string	Endereço do prospect.	Não
city	string	Cidade do prospect.	Não
complement	string	Complemento do endereço.	Não
neighborhood	string	Bairro do prospect.	Não
idState	int32	ID do estado (UF).	Não
zipCode	string	CEP do prospect.	Não
number	string	Número do endereço.	Não
tokenGympass	string	Token de integração com Gympass (se aplicável).	Não
userTokenGoGood	string	Token de integração com GoGood (se aplicável).	Não
additionalFieldName	string	Nome de campo adicional personalizado.	Não
additionalFieldValue	string	Valor do campo adicional personalizado.	Não
validateCpfDuplication	boolean	Indica se deve validar duplicidade de CPF ao criar o prospect.	Não
temperature	number	Temperatura do lead (ex.: score interno).	Não
financiallyResponsible	object	Dados do responsável financeiro. Ver mais abaixo.	Não
interests	array[int32]	Lista de IDs de interesses do prospect.	Não

Estrutura do objeto `financiallyResponsible`

Parâmetro	Tipo	Descrição	Obrigatório
idMember	int32	ID de membro vinculado como responsável financeiro.	Não
name	string	Nome do responsável financeiro.	Não
email	string	E-mail do responsável financeiro.	Não
cpf	string	CPF do responsável financeiro.	Não

📤 Estrutura da Resposta

Parâmetro	Tipo	Descrição
idProspect	int	Identificador do prospect criado.

Requisição

Authorization

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Parâmetros Bodyapplication/json-patch+json

Exemplo

{
    "name": "string",
    "email": "string",
    "lastName": "string",
    "registerName": "string",
    "registerLastName": "string",
    "usePreferredName": true,
    "idBranch": 0,
    "ddi": "string",
    "cellphone": "string",
    "birthday": "2019-08-24T14:15:22.123Z",
    "gender": "string",
    "visit": 0,
    "marketingType": "string",
    "notes": "string",
    "currentStep": "string",
    "cpf": "string",
    "passport": "string",
    "rg": "string",
    "address": "string",
    "city": "string",
    "complement": "string",
    "neighborhood": "string",
    "idState": 0,
    "zipCode": "string",
    "number": "string",
    "tokenGympass": "string",
    "userTokenGoGood": "string",
    "additionalFieldName": "string",
    "additionalFieldValue": "string",
    "validateCpfDuplication": true,
    "temperature": 1,
    "financiallyResponsible": {
        "idMember": 0,
        "name": "string",
        "email": "string",
        "cpf": "string"
    },
    "interests": [
        0
    ]
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Add prospects

Adicionar Prospect

Descrição

📨 Corpo da Requisição (Request Body)

Estrutura do objeto `financiallyResponsible`

📤 Estrutura da Resposta

Requisição

Exemplos de Requisição

Respostas

Add prospects

Adicionar Prospect#

Descrição#

📨 Corpo da Requisição (Request Body)#

Estrutura do objeto financiallyResponsible#

📤 Estrutura da Resposta#

Requisição

Exemplos de Requisição

Respostas

Adicionar Prospect

Descrição

📨 Corpo da Requisição (Request Body)

Estrutura do objeto `financiallyResponsible`

📤 Estrutura da Resposta