Skip to main content
POST
Invite candidate
Use this API to invite one candidate at a time. The endpoint creates the interview record and returns the direct interview link.
Rate limit: 100 requests per minute per API key. Requests over the limit return 429 Too Many Requests.

Endpoint

All requests must include your API key.

Request body fields

string
required
Candidate’s full name. Blank names are rejected.
string
required
Candidate’s email address. The value is normalized to lowercase.
string
required
The unique ID of the Interviewer to create the interview under.
string
shortlisted or draft. If omitted, public Interviewers default to shortlisted and private Interviewers default to draft.
string
A publicly accessible URL to the Candidate’s resume (PDF). InterviewFlowAI downloads and stores the file.
string[]
Skill names used to generate skill-based custom interview questions.
object[]
Candidate-specific custom questions to attach to the interview.
object
Custom Candidate fields configured in InterviewFlowAI.
object
External reference data such as ATS IDs or phone number.

Example request

Example response

Behavior

Use this endpoint when your ATS, CRM, or internal system should decide how and when to share the interview link with the candidate.