Add Prospect

Description

Allows the creation of a prospect (potential customer).

NOTE. Available for use with branch access key and also with General ADM access key.

📨 Request Body

Parameter	Type	Description	Required
name	string	Preferred name of the prospect.	Yes
lastName	string	Preferred last name of the prospect.	Yes
email	string	Email of the prospect.	Yes
idBranch	int32	ID of the associated branch. Applicable for multi-location keys; ignored otherwise.	Conditional
cellphone	string	Cell phone number of the prospect.	No
cpf	string	CPF of the prospect.	Conditional. Required if `validateCpf = true`
validateCpf	boolean	Indicates if CPF duplication should be validated by the Federal Revenue Service in Brazil.	No
registerName	string	Registration name of the prospect.	No
registerLastName	string	Registration last name of the prospect.	No
ddi	string	DDI code of the phone (e.g., +55).	No
birthday	date-time	Birth date (ISO 8601 format).	No
gender	string	Gender of the prospect {M, F, P}.	No
visit	int32	Code of the visit/campaign origin.	No
marketingType	string	Associated marketing type.	No
notes	string	Additional notes or observations.	No
currentStep	string	Current step in the conversion funnel.	No
passport	string	Passport number of the prospect.	No
rg	string	RG number of the prospect.	No
address	string	Address of the prospect.	No
city	string	City of the prospect.	No
complement	string	Address complement.	No
neighborhood	string	Neighborhood of the prospect.	No
idState	int32	ID of the state (UF).	No
zipCode	string	ZIP code of the prospect.	No
number	string	Address number.	No
tokenGympass	string	Integration token with Gympass (if applicable).	No
userTokenGoGood	string	Integration token with GoGood (if applicable).	No
additionalFieldName	string	Name of additional custom field.	No
additionalFieldValue	string	Value of additional custom field.	No
validateCpfDuplication	boolean	Indicates if CPF duplication should be validated when creating the prospect.	No
temperature	number	Lead temperature (e.g., internal score).	No
financiallyResponsible	object	Data of the financially responsible party. See below.	No
interests	array[int32]	List of interest IDs of the prospect.	No

🧩 Structure of `financiallyResponsible`

Parameter	Type	Description	Required
idMember	int32	ID of the member linked as financially responsible.	No
name	string	Name of the financially responsible party.	No
email	string	Email of the financially responsible party.	No
cpf	string	CPF of the financially responsible party.	No

📤 Response Structure

Parameter	Type	Description
idProspect	int	Identifier of the created prospect.

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

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

Body Params

application/json-patch+json

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Add prospects

Add Prospect

Description

📨 Request Body

🧩 Structure of `financiallyResponsible`

📤 Response Structure

Request

Request Code Samples

Responses

Add prospects

Add Prospect#

Description#

📨 Request Body#

🧩 Structure of financiallyResponsible#

📤 Response Structure#

Request

Request Code Samples

Responses

Add Prospect

Description

📨 Request Body

🧩 Structure of `financiallyResponsible`

📤 Response Structure