Skip to main content
POST
Create an assessment invite

Authorizations

x-api-key
string
header
required

API key for authentication. Format: ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Body

application/json
assessmentId
string<uuid>
required

ID of the assessment to invite the candidate to

recipientEmail
string<email>
required

Email address of the candidate

questionReplayLimit
integer
default:1

Maximum number of times a candidate can replay each question

Required range: x >= 1
answerRecordLimit
integer
default:1

Maximum number of recording attempts per answer

Required range: x >= 1
expiresInDays
integer
default:30

Number of days until the invite expires

Required range: x >= 1
proctoringSettings
object

Proctoring configuration. All options default to true if omitted.

Response

Invite created successfully

invite
object