Skip to main content
PUT
Use the Edit Interview API to update a Candidate’s interview from your own system, for example to rename the Candidate, move them to a custom stage, or add notes.
Rate limit: 60 requests per minute per API key. Requests over the limit return 429 Too Many Requests.

Request body fields

string
required
The UUID of the interview to update.
string
The Candidate’s name. Must contain 1–255 characters.
string
The Candidate’s email address. At least 5 characters, no spaces. Stored in lowercase.
number
New invitation expiry time, as a Unix timestamp in milliseconds.
string
new or viewed.
string
A stage configured in your Company’s Custom Stages settings. 1–80 characters.
object[]
Replacement custom interview questions. Each item requires question. evaluationCriteria is optional; when you include it, lookingFor, strongAnswer, weakAnswer, weight (1–10) and maxFollowup (0–2) are required.
object
Replacement values for configured Candidate additional fields.
string
Internal notes, up to 5,000 characters.
At least one optional field should be included. Sending a status that is not configured as a custom stage returns 400 Bad Request with “Only stages in your hiring pipeline can be selected for status updates”.

Response

The API key must belong to the same Company as the interview. A missing interview or an interview owned by another Company returns 404 Not Found.