Call Requests API Fields

Call Requests Fields Reference

A call request has a number of properties represented by fields. This documentation outlines all supported fields and their usage in API requests.

Note: Any field not listed in the table below will be ignored if included in an API request JSON data.

Field Reference

The table below lists all fields supported by the Call Requests API. Fields marked with * are mandatory.

Field Name	Description	Available for Methods	Supported Values
email*	Email of the customer who requested a call. Mandatory if no phone is provided.	GET, POST	string
phone*	The phone number of the customer who requested a call. Mandatory if no email is provided.	GET, POST	string
user_id	ID of the administrator assigned to the call request.	GET, POST, PUT	integer
order_id	ID of the order associated with the call request (placed with `Buy now with 1-click`).	GET, POST, PUT	integer
product_id	ID of a product from the order associated with the call request.	GET, POST	integer
timestamp	Creation timestamp.	GET, POST	A valid timestamp in seconds
status	Status of the call request.	GET, POST, PUT	One of the following strings: `new` `in_progress` `completed` `no_answer`
name	Name of the customer who requested a call.	GET, POST	string
time_from	The beginning of the time period when the customer is ready to answer a call.	GET, POST	string
time_to	The end of the time period when the customer is ready to answer a call.	GET, POST	string
notes	Notes related to the call request.	GET, POST	string
cart_products	An array with the names, IDs quantities and prices of the products in the cart.	GET, POST	array
order_status	Status of the order associated with the call request.	GET	string
product	Name of the product that the user purchased using `Buy now with 1-click`.	GET	string

Field Name

Description

Available for Methods

Supported Values

email*

Email of the customer who requested a call. Mandatory if no phone is provided.

GET, POST

string

phone*

The phone number of the customer who requested a call. Mandatory if no email is provided.

GET, POST

string

user_id

ID of the administrator assigned to the call request.

GET, POST, PUT

integer

order_id

ID of the order associated with the call request (placed with Buy now with 1-click).

GET, POST, PUT

integer

product_id

ID of a product from the order associated with the call request.

GET, POST

integer

timestamp

Creation timestamp.

GET, POST

A valid timestamp in seconds

status

Status of the call request.

GET, POST, PUT

One of the following strings:
new
in_progress
completed
no_answer

name

Name of the customer who requested a call.

GET, POST

string

time_from

The beginning of the time period when the customer is ready to answer a call.

GET, POST

string

time_to

The end of the time period when the customer is ready to answer a call.

GET, POST

string

notes

Notes related to the call request.

GET, POST

string

cart_products

An array with the names, IDs quantities and prices of the products in the cart.

GET, POST

array

order_status

Status of the order associated with the call request.

GET

string

product

Name of the product that the user purchased using Buy now with 1-click.

GET

string

Example Usage

POST /call_requests

Creates a new call request with the specified customer information.

Example Request

{
  "email": "customer@example.com",
  "phone": "+1234567890",
  "name": "John Smith",
  "time_from": "14:00",
  "time_to": "18:00",
  "notes": "Customer has questions about product compatibility",
  "product_id": 123
}

Tip: Either email or phone must be provided. For best customer experience, it's recommended to collect both when possible.

PUT /call_requests/:id

Updates an existing call request with a new status.

Example Request

{
  "status": "completed",
  "user_id": 42
}

Note: Updating a call request's status is important for tracking customer interactions and service quality. Always update the status after each customer contact attempt.