API Documentation
Prospects
Agents
VoiceModels
Hive
HiveAgentLink
Actions
ActionAgentLink
Products
Conversations
ConversationProspectLink
Prospects
Create a New Prospect
Create a New Prospect
POST
/
v1
/
prospects
Copy
curl --request POST \
--url https://api.trata.ai/v1/prospects \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "John Doe",
"email": "john.doe@example.com",
"phoneNumber": "1234567890",
"externalReference": [
{
"providerName": "Google Analytics",
"id": "GA-123456",
"providerProps": "abcdefg"
}
],
"status": "NEW",
"prospectProps": "software"
}'
Copy
{
"id": "pro.1731301754.OZSMSU1S",
"orgId": "org.1726902940.GZChqlpU",
"name": "Hari",
"phoneNumber": "96260-12778",
"externalReference": [],
"status": "SERVICE_ORDER_PLACED",
"prospectProps": {},
"createdBy": "trata-system",
"createdAt": "2024-11-11T05:09:14.979287",
"updatedBy": "trata-system",
"updatedAt": "2024-11-11T05:09:14.979289"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
Prospect created successfully
Prospects are the potential customers for business
Copy
curl --request POST \
--url https://api.trata.ai/v1/prospects \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "John Doe",
"email": "john.doe@example.com",
"phoneNumber": "1234567890",
"externalReference": [
{
"providerName": "Google Analytics",
"id": "GA-123456",
"providerProps": "abcdefg"
}
],
"status": "NEW",
"prospectProps": "software"
}'
Copy
{
"id": "pro.1731301754.OZSMSU1S",
"orgId": "org.1726902940.GZChqlpU",
"name": "Hari",
"phoneNumber": "96260-12778",
"externalReference": [],
"status": "SERVICE_ORDER_PLACED",
"prospectProps": {},
"createdBy": "trata-system",
"createdAt": "2024-11-11T05:09:14.979287",
"updatedBy": "trata-system",
"updatedAt": "2024-11-11T05:09:14.979289"
}
Assistant
Responses are generated using AI and may contain mistakes.