Skip to main content
PATCH
The Patch API allows you to update custom fields for a specific interview record. This is highly useful for syncing data, scores, or review flags from your external tools back into InterviewFlowAI.
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.
object
required
Custom fields to update on the Candidate record. Include 1–50 fields. Each value must be a string (up to 1,000 characters), number, boolean, or null. Fields you send are merged with existing values; send null or an empty string to remove a field.

Response

The response returns the interview ID and the Candidate’s full set of additional fields after the update.
A missing interview, or one owned by another Company, returns 404 Not Found.