Update a Callback

Endpoint Description

Updates a specific scheduled callback. Use this endpoint to modify callback properties such as scheduled time, phone number, or agent assignment.

Request Body Examples

[
  {
    "op": "replace",
    "path": "/timeToCall",
    "value": "2022-02-10T09:39:19Z"
  },
  {
    "op": "replace",
    "path": "/phoneNumber",
    "value": "+8613036130259"
  }
]

[
  {
    "op": "replace",
    "path": "/assignType",
    "value": "SPECIFIC_AGENT"
  },
  {
    "op": "replace",
    "path": "/agents",
    "value": ["agent-uuid-1", "agent-uuid-2"]
  }
]

Response Schema

Property	Type	Description
callback_id	string	Unique identifier of the callback.
status	enum	UNATTEMPTED, TO_BE_RETRIED, EXHAUSTED, SUCCESS, CANCELED, INVALID_NUMBER
scheduled_time_to_call	string (ISO8601)	The time the callback is scheduled to occur.
phone_number	string	The phone number that is scheduled to be called.

Response Codes

Status Code	Description
200	Success. Returns the updated callback object.
400	Bad Request. Validation errors in the JSON body.
401	Unauthorized. Missing or invalid Bearer token.
403	Forbidden. Insufficient scopes (schedule-callbacks:write).
404	Not Found. The callback ID does not exist.