Clock-out

Clocks the user into work.

This endpoint requires the Agent Impersonator role.

URL

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

Headers

Authorization: Bearer <accessToken>

Request Body

  • clockOutReason (enum): Can be one of the following values: EndOfShift | Other

  • clockOutDescription (text, max 200 chars): A free-text description of the clock-out reason. Required when clockOutReason is "Other".

Response

Success -> 200

Invalid access token --> 401

The "Track Agents Status" feature is disabled -> 403

The user status is not "Away" -> 409, 3301

The unit is not in the current organization, or the user is not allowed to access the selected unit --> 403

Last updated