API Reference

candidate.create

post
https://api.ashbyhq.com/candidate.create

Creates a new candidate

Requires the candidatesWrite permission.

To set values for custom fields on Candidates, use the customFields.setValue endpoint.

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

The first and last name of the candidate to be created.

string

Primary, personal email of the candidate to be created.

string

Primary, personal phone number of the candidate to be created.

string

Url to the candidate's LinkedIn profile. Must be a valid Url.

string

Url to the candidate's Github profile. Must be a valid Url.

string

Url of the candidate's website. Must be a valid Url.

alternateEmailAddresses
array of strings

Array of alternate email address to add to the candidate's profile.

alternateEmailAddresses
uuid

The source to set on the candidate being created.

uuid

The id of the user the candidate will be credited to.

location
object

The location of the candidate.

date-time

An ISO date string to set the candidate's createdAt timestamp. When this value isn't provided, the createdAt timestamp defaults to the time the call was made.

Response

Updated 5 days ago

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

Updated 5 days ago