Skip to content

Create Interview

POST
/sales-coach/interviews

Create an interview round.

Creating it invites nobody. Members are added separately, and only then can an invite go out.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Create an interview round - a scripted practice call a candidate is invited to.

object
audience_id
required

Audience the prospect is drawn from.

string
>= 1 characters
behavior

How the AI prospect behaves. Free-form: the app does not close this set.

string
default: Nay-sayer >= 1 characters
code_ttl_days
Any of:
integer
> 0 <= 365
max_attempts

How many times a member may try.

integer
default: 3 > 0
name
required

What the round is called.

string
>= 1 characters
prospect_id
required

The contact the AI will play.

string
>= 1 characters
prospect_name
Any of:
string

Responses

201

Successful Response

object
data
required

An open envelope for a call, an interview round or an attempt.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string