API Reference

Create a new candidate

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Email address of the candidate.

string
required

Job ID in the Classet system.

string
required

First name of the candidate.

string
required

Last name of the candidate.

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
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
string

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

boolean

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

boolean

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

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

Updated 27 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 27 days ago