Skip to main content
PUT
Use this endpoint to update an Interviewer that belongs to your Company. Include only the fields you want to change; omitted fields remain unchanged.
Rate limit: 5 requests per minute per API key. This limit is shared with Create an Interviewer. Requests over the limit return 429 Too Many Requests.
string
required
The UUID of the Interviewer to update.

Request body

The body must contain at least one supported field. Unknown fields are rejected. All fields are optional, but you must provide at least one.
string
Interviewer title. Must contain 1–255 characters.
string
Interviewer role. Must contain 1–255 characters.
string
Interviewer description. Must contain 1–50,000 characters.
string
Instructions for conducting the interview.
string
web_call, phone_only, or both.
boolean
Whether video is required.
boolean
Whether a resume is required.
boolean
Whether Candidates must use a desktop device.
boolean
Whether Candidates see live captions and the transcript during the interview.
boolean
Whether a portfolio is required.
string
public or private.
boolean
Whether the Interviewer appears to Candidates.
boolean
Whether the Interviewer is archived.
string
english, hindi, spanish, french, chinese, german, italian, japanese, korean, portuguese, dutch, ukrainian, malay, indonesian, arabic, or vietnamese.
number
Minimum experience in years. Must be at least 0.
number
Maximum experience in years. Must be at least 0.
string
full-time, part-time, contract, or intern.
string
remote, onsite, or hybrid.
string
Country. Maximum 255 characters.
string
City. Maximum 255 characters.
string
Postal code. Maximum 20 characters.
string
Additional Interviewer context. Maximum 5,000 characters and 200 words. Required when enabling candidateQuestioning.
boolean
Whether the Candidate can ask questions during the interview.
boolean
Whether the Candidate can opt out.
string
Introduction video URL. Maximum 500 characters. Send "" to clear it.
string
Completion redirect URL. Maximum 2,048 characters. Send "" to clear it.
Interview link validity in days. Minimum 1 and maximum 365.
number
Interview duration in minutes. Minimum 10 and maximum 60.
string
Introduction message. Must contain 1–1,000 characters.
string
Ice breaker message. Maximum 500 characters.
string
Closing message. Must contain 1–500 characters.
number
Number of allowed retakes. Minimum 0 and maximum 3.
object[]
Up to 25 tag definitions.
object[]
Replacement custom interview questions.
object
Manual, resume, and skills question configuration.
object[]
Replacement application screening questions.
object[]
Replacement post-interview questions.
object
Team completion email configuration.
object
Team email alert when a Candidate opts out. Same shape as teamCompletionAlert.
Scheduling link sent to Candidates after the interview. Maximum 2,048 characters. Send "" to clear it.
number | null
Minimum score (0–100) a Candidate needs to receive the scheduling link, or null.
number
Hours to wait before sending the scheduling link. Minimum 0 and maximum 720.
boolean
Whether to email the Candidate after completion.
boolean
Whether to include the basic report in that email.
object
Automated rejection email configuration.
object
Custom report summary configuration.
If locationType is onsite or hybrid, the final Interviewer configuration must include country, city, and zipcode. Setting it to remote clears those location fields.

Tags

Each tags item requires:

Custom questions

Each customQuestions item requires question and evaluationCriteria. generationSource is optional.

Question configuration

customQuestionConfig accepts:

Screening and post-interview questions

Each screeningQuestions item accepts id, question, type, idealAnswerType, expectedAnswer, expectedAnswerMax, isRequired, and mustHaveQualification. The required fields are question, type, expectedAnswer, and isRequired. type must be yesno, numeric, or text; idealAnswerType must be min, max, range, or exact. Each postInterviewQuestions item requires question and optionally accepts id. Question text must be 1–200 characters.

Notifications and reports

Response

Successful updates return 200 OK with the complete updated Interviewer in data.

Errors