Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
User

user.createInterviewerPause

Creates an interviewer pause for a user. While paused, the user will not be scheduled for interviews.

A user can only have one interviewer pause at a time (whether active or scheduled). Attempting to create a pause when one already exists will return an error.

Requires the organizationWrite permission.

post/user.createInterviewerPause

Request body

userIdstring uuid required

The id of the user to pause.

startsAtstring date-time nullable

The start date and time of the pause. Defaults to the current time if not provided.

endsAtstring date-time nullable

The end date and time of the pause. If not provided, the pause is indefinite.

commentstring nullable

An optional comment describing the reason for the pause.

Example request

{
  "userId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "startsAt": "2024-01-15T00:00:00.000Z",
  "endsAt": "2024-02-15T00:00:00.000Z",
  "comment": "On vacation"
}

Response

Responses from the user.createInterviewerPause endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "userId": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "startsAt": "2024-01-15T00:00:00.000Z",
    "endsAt": "2024-02-15T00:00:00.000Z",
    "comment": "On vacation",
    "createdAt": "2024-01-14T10:30:00.000Z"
  }
}