Sign in

v1

latestOpenAPI 3.1.02026-07-135055368.9 KB
Prospects

Create a New Prospect

Create a New Prospect

post/v1/prospects

Request body

namestring nullable

Name of the prospect

emailstring email nullable

Email of the prospect

phoneNumberstring nullable

Phone number of the prospect

status'NEW' | 'GENERAL_ENQUIRY' | 'SCHEDULED_CALLBACK_WITH_BOT' | 'SCHEDULED_APPOINTMENT_WITH_PERSON' | 'SCHEDULED_APPOINTMENT_FOR_SERVICE' | 'NOT_INTERESTED' | 'PRODUCT_ORDER_PLACED' | 'SERVICE_ORDER_PLACED' required
prospectPropsobject nullable

Props for the prospect

Example request

{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "phoneNumber": "1234567890",
  "externalReference": [
    {
      "providerName": "Google Analytics",
      "id": "GA-123456"
    }
  ]
}

Response

Prospect created successfully

idstring required
orgIdstring
namestring nullable
emailstring nullable
phoneNumberstring nullable
statusstring required
prospectPropsobject nullable required
createdBystring
createdAtstring date-time
updatedBystring
updatedAtstring date-time

Example response

{
  "externalReference": [
    {
      "providerName": "Google Analytics",
      "id": "GA-123456"
    }
  ]
}