Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
User

user.updateInterviewerSettings

Update interviewer settings for a user.

Either limit can be provided, or both can be provided. If only one is provided, the other will remain unchanged. If a limit is provided but set to null, it will be unset.

Requires the organizationWrite permission.

post/user.updateInterviewerSettings

Request body

userIdstring uuid required

The id of the user to update interviewer settings for

dailyLimitinteger nullable

Maximum number of interviews per day for this interviewer

weeklyLimitinteger nullable

Maximum number of interviews per week for this interviewer

Example request

{
  "userId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the user.updateInterviewerSettings endpoint

OR

Example response

{
  "success": true,
  "results": {
    "userId": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
    "dailyLimit": 3,
    "weeklyLimit": 15
  }
}