Create Candidate

post

https://{companyDomain}.bamboohr.com/api/v1/applicant_tracking/application

Create a new candidate application for a job opening. The owner of the API key used must have access to ATS settings. On success, returns the new candidate ID. Only fields required by the target job opening's standard questions need to be provided beyond firstName, lastName, and jobId.

Body Params

firstName

string

required

The first name of the candidate.

lastName

string

required

The last name of the candidate.

string

The email address of the candidate. Must be a valid email address.

phoneNumber

string

The phone number of the candidate.

source

string

The source of the candidate application, e.g. LinkedIn, Indeed, etc.

jobId

integer

required

The id of the job opening for the candidate application.

address

string

The street address of the candidate.

city

string

The city of the candidate.

state

string

The state or province of the candidate. Accepts state name, abbreviation, or ISO code.

zip

string

The zip code or postal code of the candidate.

country

string

The country of the candidate. Accepts country name or ISO code.

linkedinUrl

uri

The LinkedIn profile URL of the candidate. Must match https?://(.*\.)?linkedin.com/....

dateAvailable

date

The available start date of the candidate. Format: Y-m-d (e.g. 2024-06-01).

desiredSalary

string

The desired salary of the candidate.

referredBy

string

The person or entity that referred the candidate.

websiteUrl

uri

The personal website, blog, or online portfolio of the candidate. Must be a valid URL.

highestEducation

string

enum

The highest completed education level of the candidate.

collegeName

string

The college or university of the candidate.

references

string

A list of references supplied by the candidate.

resume

file

Resume file for the candidate. Accepted MIME types: application/pdf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plain, application/rtf, image/jpeg, image/gif, image/png, image/tiff, image/bmp.

coverLetter

file

Cover letter file for the candidate. Accepted MIME types: application/pdf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plain, application/rtf, image/jpeg, image/gif, image/png, image/tiff, image/bmp.

Responses

200Success. Returns the result status and the new candidate ID.

401Unauthorized. Invalid API credentials.

403Insufficient user permissions or API access is not turned on.

404Bad request url.

422Unprocessable entity. One or more parameters failed validation.