Skip to main content
POST
/
v1
/
interviews
Post interview
curl --request POST \
  --url https://app.ribbon.ai/be-api/v1/interviews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "interview_flow_id": "<string>",
  "interviewee_email_address": null,
  "interviewee_first_name": null,
  "interviewee_last_name": null
}
'
{
  "interview_id": "<string>",
  "interview_link": "<string>",
  "hint": null
}

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.

Response

OK

​
interview_id
string
required

The ID of the created interview.

​
interview_link
string
required

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

​
hint
string | null

Helpful hint about interview visibility.