Cubu Docs
S2S API Guide
S2S API Guide
  • About Cubu Server-to-Server API
  • Accessing the API
  • Agent Impersonation API
    • Call Again
    • Clock-in
    • Clock-out
    • Get Agent Status
    • List Active Cases
    • List Inboxes
    • List Workspaces
    • List Workstations
    • Occupy a Workstation
    • Resolve a Case
    • Select Current Unit
    • Start Processing the Next Case
    • Change Status to Available
    • Change Status to Unavailable
    • Vacate a Workstation
  • Appointments Management API
    • Book Appointment
    • Cancel Appointment
    • List Appointments in Calendar
    • List Calendars of a Service
    • List Vacancies in a Calendar
  • Case Management API
    • Queue Up
  • Customer Management API
    • Create a Customer Record
    • Get Customer Record
    • Update a Customer Record
    • Find a Customer Record
  • Organization API
    • List Back-office tasks
    • List Users
Powered by GitBook
On this page
  • URL
  • Headers
  • Request Body
  • Response
  1. Agent Impersonation API

Change Status to Unavailable

This API changes the status of an Available agent to Unavailable or changes the unavailability reason for an already unavailable agent.

This endpoint requires the Agent Impersonator role.

URL

POST: https://[base-url]/{applicationId}/agents/{userId}/actions/becomeUnavailable

Headers

Authorization: Bearer <accessToken>

Request Body

  • unavailabilityReason: One of the following values: Other | Break | Meeting | BackOfficeWork.

  • unavailabilityDescription (text, max 200 chars): A free-text description of the unavailability reason. Required when unavailabilityReason is "Other".

  • backOfficeTaskId (GUID): The ID of a back-office task.

    Required when unavailabilityReason is "BackOfficeWork".

Response

Success -> 200

"Track Agent Status" is disabled for the organization --> 403

The agent status is not "Unavailable" --> 409, 3304

The agent status is not "Available" or "Unavailable" --> 409, 3303 "Invalid user status"

PreviousChange Status to AvailableNextVacate a Workstation

Last updated 5 months ago