Skip to main content
POST
Post interview

Authorizations

Authorization
string
header
required

Provide your API key UUID in the 'Authorization' header prefixed with 'Bearer '. Example: 'Authorization: Bearer 123e4567-e89b-12d3-a456-426614174000'

Body

application/json
interview_flow_id
string
required

The interview flow ID.

interviewee_email_address
string | null

The interviewee email address. This is used to identify the interviewee on the Ribbon platform. If not provided, this interview will not appear on the Ribbon platform

interviewee_first_name
string | null

The interviewee first name.

interviewee_last_name
string | null

The interviewee last name.

assigned_recruiter_id
string | null

The ID of the team member to assign this interview to. Must belong to the same team as the interview flow. If provided, the returned interview_link will include assignedRecruiterId as a query parameter. Use GET /team-members to retrieve valid team member IDs.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

OK

interview_id
string
required

The ID of the created interview.

The single-use link to begin and conduct the interview.

hint
string | null

Helpful hint about interview visibility.