Add New Candidate

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

Add a new candidate application to a job opening. The owner of the API key used must have access to ATS settings.

Path Params

companyDomain

string

required

The subdomain used to access BambooHR. If you access BambooHR at https://mycompany.bamboohr.com, then the companyDomain is "mycompany"

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.

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

string

The LinkedIn profile url of the candidate.

dateAvailable

string

The available start date of the candidate with the format YYYY-MM-DD.

desiredSalary

string

The desired salary of the candidate.

referredBy

string

The person or entity that referred the candidate.

websiteUrl

string

The personal website, blog, or online portfolio of the candidate.

highestEducation

string

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

string

Resume of the candidate.

coverLetter

string

Cover letter of the candidate.

Responses

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.bamboohr.com/api/gateway.php/companyDomain/v1/applicant_tracking/application \
3
     --header 'accept: application/json' \
4
     --header 'content-type: multipart/form-data'

Click Try It! to start a request and see the response here!

200Success

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.