Schedule Product or Service Review Calls

Api to schedule automated product or service review calls

Endpoint

POST /api/review

Authentication

If applicable, include your API key in the headers:

x-api-key: {your_api_key_here}

---

Request Headers

Header	Required	Description
accept	Yes	Accept header (*/*)
Content-Type	Yes	Must be application/json
x-api-key	Optional	API key for authentication (if required)

---

Request Body

{
  "calls": [
    {
      "agent_name": "string",
      "scheduled_at": "string",
      "custom_prompt": "string",
      "serviceOrProduct": "SERVICE",
      "timezone": "string",
      "prospect": {
        "name": "string",
        "phoneNumber": "string",
        "email": "string",
        "companyName": "string",
        "companySize": "string",
        "industry": "string"
      }
    }
  ]
}

---

Field Descriptions

Field	Type	Required	Description
calls	Array	Yes	List of review calls to be scheduled
agent_name	String	Yes	Name of the agent handling the review call
scheduled_at	String	Yes	Scheduled date and time for the call (ISO 8601 recommended)
custom_prompt	String	No	Optional prompt or notes for the call
serviceOrProduct	String	Yes	Either "SERVICE" or "PRODUCT"
timezone	String	Yes	Timezone of the scheduled call (e.g., "UTC")
prospect	Object	Yes	Details about the prospect

Prospect Details

Field	Type	Required	Description
name	String	Yes	Prospect’s full name
phoneNumber	String	Yes	Prospect’s phone number
email	String	Yes	Prospect’s email address
companyName	String	No	Prospect’s company name
companySize	String	No	Size of the company
industry	String	No	Industry sector

---

Success Response

Status Code: 200 OK

{
  "success": true,
  "message": "Review calls scheduled successfully",
  "data": [
    {
      "message": "Review call scheduled successfully",
      "callId": "682bb905f919c505e9cb8595"
    }
  ],
  "timestamp": "2025-05-20T10:15:00.000Z"
}

---

Error Responses

Status Code	Description
400	Invalid request payload
401	Unauthorized or missing API key
500	Server error

---

Example Curl Request

curl -X POST 'http://localhost:3900/api/review' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: your_api_key_here' \
  -d '{
    "calls": [
      {
        "productOrServiceName": "Customer Success Review",
        "agent_name": "Jane Smith",
        "scheduled_at": "2025-05-25T16:00:00Z",
        "custom_prompt": "Discuss feedback and next steps",
        "serviceOrProduct": "SERVICE",
        "timezone": "America/New_York",
        "prospect": {
          "name": "John Doe",
          "phoneNumber": "[phone]",
          "email": "[e-mail]",
          "companyName": "TechCorp",
          "companySize": "100-200",
          "industry": "Technology"
        }
      }
    ]
  }'