Update scheduled callback

Changes a planned Agent callback or a waiting API queue callback. Only provided fields are changed.

Agent callback. Changes the time, the time zone, the note or the Caller ID group. Requires the tasks.scheduled_callbacks.manage scope. With "Enable agent callback" off in System settings, the request answers 403; when the callback's agent no longer has scheduled callbacks enabled, it answers 422, as a booking for that agent does. A new time follows the same rules as the time of a booking; the tries already made stay counted.

API queue callback. Changes the time, the time zone or the note. Requires the tasks.api_queue_callbacks.manage scope. A new time follows the same rules as the time of a booking and starts the tries over.

An In-queue callback, or a callback that is ringing, has ended or is cancelled, gives 422 and stays as it was.

The phone number, the agent and the queue stay as booked: to change them, cancel the callback and book a new one. A request with destination, queue_id or user_id gives 422, and so does caller_id_group_id for an API queue callback.

Path Params
integer
required

Scheduled callback ID

Body Params
date-time

New date and time of the callback (ISO 8601). A time with no offset is read as UTC.

The time must be in the future and no more than 30 days ahead.
In the time zone of the callback, the time must be from 08:00 to 21:59, unless move_to_calling_window moves it. Any minute is accepted.
Seconds must be 00.

string | null

New IANA time zone of the callback. Sent without scheduled_at, it keeps the current time of the callback, and that time must be from 08:00 to 21:59 in the new time zone. Null or not sent keeps the current time zone.

string | null

New note of the callback. Agent Panel and Agent Workspace show the note when the callback rings. Null removes the note.

integer | null

New Caller ID group of an Agent callback. The group must belong to the Callcenter. Null sets the default Caller ID group of the Callcenter. An API queue callback does not take it.

boolean | null
Defaults to false

When true, a time outside 08:00 to 21:59 in the time zone of the callback moves to the next 08:00. The other rules of scheduled_at then apply to the moved time. It takes effect together with scheduled_at or timezone.

Without this field, such a time gives 422.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json