Skip to main content
PUT
Update a Specific Prospect by ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

prospect_id
string
required

ID of the prospect

Body

application/json
status
enum<string>
required
Available options:
NEW,
GENERAL_ENQUIRY,
SCHEDULED_CALLBACK_WITH_BOT,
SCHEDULED_APPOINTMENT_WITH_PERSON,
SCHEDULED_APPOINTMENT_FOR_SERVICE,
NOT_INTERESTED,
PRODUCT_ORDER_PLACED,
SERVICE_ORDER_PLACED
name
string | null

Name of the prospect

Required string length: 1 - 512
Example:

"John Doe"

email
string<email> | null

Email of the prospect

Required string length: 1 - 512
Example:

"john.doe@example.com"

phoneNumber
string | null

Phone number of the prospect

Required string length: 1 - 512
Example:

"1234567890"

externalReference
ExternalReference · object[] | null

External references for the prospect

prospectProps
Prospectprops · object | null

Props for the prospect

Example:

"software"

Response

Prospect updated successfully

Prospects are the potential customers for business

id
string
required
externalReference
ExternalReference · object[] | null
required
status
string
required
prospectProps
Prospectprops · object | null
required
orgId
string
name
string | null
email
string | null
phoneNumber
string | null
createdBy
string
createdAt
string<date-time>
updatedBy
string
updatedAt
string<date-time>