Create a new candidate

post

https://recruiter.classet.org/v1/candidates

Creates a candidate and returns a link for a webcall interview.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Initiate an Interview
When creating a candidate, you can also initiate the interview right away either:

Use the webcall_url from the response to share directly through your own communication channels or...

Use our automated messaging assistant to engage and remind candidates via SMS and/or Email by passing in true for sendSms and sendEmail

Body Params

string

required

Email address of the candidate.

job_id

string

required

^[a-zA-Z0-9]{9}$

Job ID in the Classet system.

first_name

string

required

First name of the candidate.

last_name

string

required

Last name of the candidate.

phone

string

Phone number in e164 format (+15555555555).

location

object

answers

array of objects

Json Array of the candidate answers and questions for your knockout application questions that you want us to reconfirm in the interview.

answers

resume_url

string

URL of the candidate's resume to parse and add to their candidate data.

experience_entries

array of objects

experience_entries

education_entries

array of objects

education_entries

skills

array of strings

skills

candidate_summary

string

A brief summary of the candidate's background and qualifications.

send_email

boolean

Send email to the candidate. If you want this to also kickoff the interview flow on candidate creation, set this to true.

send_sms

boolean

Send SMS to the candidate. If you want this to also kickoff the interview flow on candidate creation, set this to true.

force_create

boolean

Force creation of a new candidate even if one with this email and job_id may already exist. Note: This will lead to our system creating a new candidate with the same email. As a result, future API calls may return multiple candidates for the same email.

custom_data

object | null

Customer-defined key-value metadata to attach to the candidate (e.g., application_source, referral_code). Values can be any JSON type. Distinct from interview.interview_custom_data, which is structured data extracted by the AI during the screening call.

Responses

Initiate an Interview

200Candidate created successfully

400Invalid request

401No API key provided

403Invalid API key

409Candidate already exists

500Failed to create candidate