v1

latestOpenAPI 3.0.32026-07-246376162.1 KB

Tasks

Create scheduled callback

Creates a scheduled callback for an agent at the specified time.

post/api/v4/tasks/scheduled_callbacks

Request body

user_idinteger required

The unique identifier of the user who will handle the callback.

scheduled_atstring date-time required

Date and time when the callback call is scheduled to be placed (ISO 8601).

caller_id_group_idinteger nullable

Identifier of the caller ID group to use for the callback.

timezonestring nullable

IANA time zone used to interpret scheduled_at when a local time is provided.

notestring nullable

Notes associated with the callback request.

Example request

{
  "user_id": 1,
  "scheduled_at": "2025-12-12T10:00:00Z",
  "caller_id_group_id": 1,
  "timezone": "Europe/Riga",
  "destination": {
    "type": "phone_number",
    "phone_number": "18885658889"
  },
  "note": "Follow up call"
}

Response

Created

Example response

{
  "scheduled_callback": {
    "id": 149,
    "phone_number": "18885658889",
    "scheduled_at": "2025-12-12T12:00:00.000+02:00",
    "user": {
      "id": 1,
      "name": "Jane Doe",
      "email": "jane.doe@contactcenter.com"
    },
    "caller_id_group": {
      "id": 1,
      "name": "Default"
    },
    "note": "Follow up call",
    "related_call": {
      "id": "0b97ce11-b6e0-49b4-8f92-68040aa324bf"
    },
    "source": {
      "system": "zoho",
      "account_id": "ACC01"
    },
    "status": "pending",
    "created_at": "2026-01-15T10:30:00.123000Z",
    "updated_at": "2026-01-20T14:15:00.456000Z"
  }
}