Agregar Prospect

Descripción

Permite la creación de un prospecto (cliente potencial).

OBS. Disponible para uso con clave de acceso de sucursal y también con clave de acceso de ADM General.

📨 Cuerpo de la Solicitud (Request Body)

Parámetro	Tipo	Descripción	Obligatorio
name	string	Nombre preferencial del prospecto.	Sí
lastName	string	Apellido preferencial del prospecto.	Sí
email	string	Correo electrónico del prospecto.	Sí
idBranch	int32	ID de la unidad (sucursal) asociada.	Sí
cellphone	string	Número de celular del prospecto.	Sí
cpf	string	CPF del prospecto.	Sí
registerName	string	Nombre de registro del prospecto.	No
registerLastName	string	Apellido de registro del prospecto.	No
ddi	string	Código DDI del teléfono (ej: +55).	No
birthday	date-time	Fecha de nacimiento (formato ISO 8601).	No
gender	string	Género del prospecto {M, F, P}.	No
visit	int32	Código del origen de la visita/campaña.	No
marketingType	string	Tipo de marketing asociado.	No
notes	string	Notas u observaciones adicionales.	No
currentStep	string	Etapa actual en el embudo de conversión.	No
passport	string	Número de pasaporte del prospecto.	No
rg	string	Número de RG del prospecto.	No
address	string	Dirección del prospecto.	No
city	string	Ciudad del prospecto.	No
complement	string	Complemento de la dirección.	No
neighborhood	string	Barrio del prospecto.	No
idState	int32	ID del estado (UF).	No
zipCode	string	Código postal del prospecto.	No
number	string	Número de la dirección.	No
tokenGympass	string	Token de integración con Gympass (si aplica).	No
userTokenGoGood	string	Token de integración con GoGood (si aplica).	No
additionalFieldName	string	Nombre de campo adicional personalizado.	No
additionalFieldValue	string	Valor del campo adicional personalizado.	No
validateCpfDuplication	boolean	Indica si se debe validar duplicidad de CPF al crear el prospecto.	No
temperature	number	Temperatura del lead (ej.: score interno).	No
financiallyResponsible	object	Datos del responsable financiero. Ver más abajo.	No
interests	array[int32]	Lista de IDs de intereses del prospecto.	No

🧩 Estructura del objeto `financiallyResponsible`

Parámetro	Tipo	Descripción	Obligatorio
idMember	int32	ID de miembro vinculado como responsable financiero.	No
name	string	Nombre del responsable financiero.	No
email	string	Correo electrónico del responsable financiero.	No
cpf	string	CPF del responsable financiero.	No

📤 Estructura de la Respuesta

Parámetro	Tipo	Descripción
idProspect	int	Identificador del prospecto creado.

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",
    "validateCpf": true,
    "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

Agregar Prospect

Descripción

📨 Cuerpo de la Solicitud (Request Body)

🧩 Estructura del objeto `financiallyResponsible`

📤 Estructura de la Respuesta

Requisição

Exemplos de Requisição

Respostas

Add prospects

Agregar Prospect#

Descripción#

📨 Cuerpo de la Solicitud (Request Body)#

🧩 Estructura del objeto financiallyResponsible#

📤 Estructura de la Respuesta#

Requisição

Exemplos de Requisição

Respostas

Agregar Prospect

Descripción

📨 Cuerpo de la Solicitud (Request Body)

🧩 Estructura del objeto `financiallyResponsible`

📤 Estructura de la Respuesta