Cubu Docs
S2S API Guide
User GuideReport CenterTechnical GuideRelease NotesS2S API Guide
S2S API Guide
User GuideReport CenterTechnical GuideRelease NotesS2S 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

Occupy a Workstation

Sets the current workspace of the impersonated user. The workspace must be in the user's current unit.

This endpoint requires the Agent Impersonator role.

URL

POST: https://[base-url]/{applicationId}/agents/{userId}/workstations /{workstationId}/actions/occupy

Headers

Authorization: Bearer <accessToken>

Request Body

  • vacateOthers (boolean): When set to true, vacates all other workstations occupied by the user.

Response

Success -> 200

Invalid access token -> 401

The workstation is not in the user's current unit -> 404

The specified workstation is inactive --> 409, 1002

The workstation is occupied by someone else --> 409, 1003

PreviousList WorkstationsNextResolve a Case

Last updated 6 months ago