Endpoint Examples
Invite candidate
Endpoint Examples
Invite candidate
This endpoint invites candidate to the screening interview.
POST
/
api
/
invite
Body
job_id
string
Unique identifier of a job. Ensures that the same job does not get recreated on every request.
job_title
string
The job position name which the AI should use to conduct the screening.
job_description
string
A high-level job description that the AI should refer to for guidance during the screening process. A detailed description is preferable.
applicant_full_name
string
The name of the candidate to be invited.
applicant_email
string
The email address of the candidate where the invitation link will be sent.
Response
scheduleLink
string
URL where the candidate can schedule the screening interview.