Skip to main content
POST
Issue Screen

Authorizations

x-api-key
string
header
required

Body

application/json
candidateIdentifier
string
required

The identifier of the candidate

problemId
string
required

The identifier of the technical screen or video screen to assign, as returned by the problems endpoints

submitterEmail
string<email>

Email address of the screen submitter (optional)

shouldSendEmail
boolean
default:true

Whether to send an email notification to the candidate

bypassIDCheck
boolean
default:false

Whether to bypass ID verification checks

isSelfServe
boolean

Whether this screen was created via the self-serve flow

inviteEmailLocale
enum<string>
default:en

Language for the invite email. Only takes effect when the problem supports that spoken locale; otherwise English is used.

Available options:
en,
fr

Response

Successfully created screen

success
boolean

Whether the operation was successful

identifier
string

Unique identifier for the newly created screen

message
string

Success or error message