---
title: "user.createInterviewerPause"
method: POST
path: "/user.createInterviewerPause"
tags: ["User"]
---

# user.createInterviewerPause

`POST /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`](authentication#permissions-usercreateinterviewerpause) permission.**

## Request body

- UserCreateInterviewerPauseRequest
  - `userId` string, uuid, required — The id of the user to pause.
  - `startsAt` string, date-time, nullable — The start date and time of the pause. Defaults to the current time if not provided.
  - `endsAt` string, date-time, nullable — The end date and time of the pause. If not provided, the pause is indefinite.
  - `comment` string, nullable — An optional comment describing the reason for the pause.

## Response `200`

Responses from the user.createInterviewerPause endpoint

- union
  - UserCreateInterviewerPauseSuccessResponse
    - `success` true, required
    - `results` InterviewerPause, required
      - `id` string, uuid, required — The unique id of the interviewer pause.
      - `userId` string, uuid, required — The id of the user who is paused.
      - `startsAt` string, date-time, required — The start date and time of the pause period.
      - `endsAt` string, date-time, nullable, required — The end date and time of the pause period. If null, the pause is indefinite.
      - `comment` string, nullable, required — An optional comment describing the reason for the pause.
      - `createdAt` string, date-time, required — The date and time when the pause was created.
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)