Create scheduled callback

post deprecated

https://{defaultHost}/api/task/v1/scheduled_callbacks

Create a scheduled callback.

Body Params

contact_number

string

required

Phone number for the callback.

agent

string

required

The email address of the agent handling the callback.

scheduled_time

date-time

required

The time of the scheduled callback.

The time must be specified in UTC and formatted according to ISO 8601 (2025-01-01T10:30:00Z).
Hours must be between 08 and 22 after converting to the specified time_zone.
For most time zones, only 00 and 30 are accepted for minutes. For time zones with a 15-minute offset (e.g., Asia/Kathmandu, Australia/Eucla, Pacific/Chatham), only 15 and 45 are accepted.
Seconds must be 00.

time_zone

string

The contact's time zone.

If the time_zone is not specified, the contact's time zone is assumed to be the same as the agent's time zone.

context_notes

string

length ≤ 64

Information about the call for the agent.

cid_group

string

The Caller ID group for the callback.

The default Caller ID for the contact center is used unless a different one is specified.

related_call_id

uuid

The UUID of a call related to the callback.

external_contact_id

string

The ID of the contact in an external CRM.

external_system_id

string

The name of the external CRM.

Responses

201Created

401Unauthorized

403Forbidden

422Unprocessable Entity