Update Prospect

Description

Update information of an existing prospect.

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

📨 Request Body

Parameter	Type	Required	Description
idProspect	int32	Yes	ID of the prospect to be updated.
name	string	No	Name of the prospect.
email	string	No	Email of the prospect.
lastName	string	No	Last name of the prospect.
idBranch	int32	No	ID of the associated branch.
ddi	string	No	DDI code of the phone.
cellphone	string	No	Cell phone number of the prospect.
birthday	date-time	No	Birth date (ISO 8601 format).
gender	string	No	Gender of the prospect {M, F, P}.
visit	int32	No	Code of the visit/campaign origin.
marketingType	string	No	Associated marketing type.
notes	string	No	Additional notes about the prospect.
currentStep	string	No	Current step of the prospect in the funnel.
cpf	string	No	CPF of the prospect.
passport	string	No	Passport number of the prospect.
rg	string	No	RG number of the prospect.
address	string	No	Address of the prospect.
city	string	No	City of the prospect.
complement	string	No	Address complement.
neighborhood	string	No	Neighborhood of the prospect.
idState	int32	No	ID of the state (UF).
zipCode	string	No	ZIP code of the prospect.
number	string	No	Address number.
tokenGympass	string	No	Gympass token (if applicable).
userTokenGoGood	string	No	Integration token with GoGood (if applicable).
additionalFieldName	string	No	Name of additional custom field.
additionalFieldValue	string	No	Value of additional custom field.
validateCpfDuplication	boolean	No	Validates CPF duplication before updating the prospect.
temperature	number	No	Lead temperature/classification.
financiallyResponsible	object	No	Data of the financially responsible party. See structure below.
interests	array[int32]	No	List of interest IDs of the prospect.

🧩 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 updated 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

{
    "idProspect": 0,
    "name": "string",
    "email": "string",
    "lastName": "string",
    "registerName": "string",
    "registerLastName": "string",
    "usePreferredName": true,
    "ddi": "string",
    "cellphone": "string",
    "birthday": "2019-08-24T14:15:22.123Z",
    "gender": "string",
    "notes": "string",
    "currentStep": "string",
    "cpf": "string",
    "rg": "string",
    "passport": "string",
    "address": "string",
    "city": "string",
    "complement": "string",
    "neighborhood": "string",
    "idState": 0,
    "zipCode": "string",
    "number": "string",
    "tokenGympass": "string",
    "idBranch": 0,
    "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

Partial update prospect (only provided fields will be updated)

Update Prospect

Description

📨 Request Body

🧩 Structure of `financiallyResponsible`

📤 Response Structure

Request

Request Code Samples

Responses

Partial update prospect (only provided fields will be updated)

Update Prospect#

Description#

📨 Request Body#

🧩 Structure of financiallyResponsible#

📤 Response Structure#

Request

Request Code Samples

Responses

Update Prospect

Description

📨 Request Body

🧩 Structure of `financiallyResponsible`

📤 Response Structure