Skip to main content
PUT
Edit Interview API
Use the Edit Interview API to update an interview that belongs to your Company.
Rate limit: 60 requests per minute per API key. Requests over the limit return 429 Too Many Requests.

Endpoint

Request body fields

string
required
The UUID of the interview to update.
string
The Candidate’s name.
string
new or viewed.
string
A stage configured in your Company’s Custom Stages settings.
object[]
Replacement custom interview questions.
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.

Example

Success 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.