API Reference

user.createInterviewerPause

post
https://api.ashbyhq.com/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.

Body Params
uuid
required

The id of the user to pause.

date-time

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

date-time

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

string

An optional comment describing the reason for the pause.

Response

Updated about 2 months ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago