Skip to main content
PUT
/
v1
/
prospects
/
{prospect_id}
Update a Specific Prospect by ID
curl --request PUT \
  --url https://api.trata.ai/v1/prospects/{prospect_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "NEW",
  "name": "John Doe",
  "email": "[email protected]",
  "phoneNumber": "1234567890",
  "externalReference": [
    {
      "providerName": "Google Analytics",
      "id": "GA-123456",
      "providerProps": "abcdefg"
    }
  ],
  "prospectProps": "software"
}
'
{
  "id": "<string>",
  "externalReference": [
    {
      "providerName": "Google Analytics",
      "id": "GA-123456",
      "providerProps": "abcdefg"
    }
  ],
  "status": "<string>",
  "prospectProps": {},
  "orgId": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>",
  "createdBy": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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

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
required
orgId
string
name
string | null
email
string | null
phoneNumber
string | null
createdBy
string
createdAt
string<date-time>
updatedBy
string
updatedAt
string<date-time>