BAbamboohr
Applicant Tracking
Public API

Create Candidate

Create a new candidate application for a job opening. The authenticated caller 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.

OAuth Scopes: hiring:applications.write

post/api/v1/applicant_tracking/application

Request

Request body multipart/form-data

firstNamestring required

The first name of the candidate.

lastNamestring required

The last name of the candidate.

emailstring email

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

phoneNumberstring

The phone number of the candidate.

sourcestring

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

jobIdinteger required

The id of the job opening for the candidate application.

addressstring

The street address of the candidate.

citystring

The city of the candidate.

statestring

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

zipstring

The zip code or postal code of the candidate.

countrystring

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

linkedinUrlstring uri

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

dateAvailablestring date

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

desiredSalarystring

The desired salary of the candidate.

referredBystring

The person or entity that referred the candidate.

websiteUrlstring uri

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

highestEducation'GED or Equivalent' | 'High School' | 'Some College' | 'College - Associates' | 'College - Bachelor of Arts' | 'College - Bachelor of Fine Arts' | 'College - Bachelor of Science' | 'College - Master of Arts' | 'College - Master of Fine Arts' | 'College - Master of Science' | 'College - Master of Business Administration' | 'College - Doctorate' | 'Medical Doctor' | 'Other'

The highest completed education level of the candidate.

collegeNamestring

The college or university of the candidate.

referencesstring

A list of references supplied by the candidate.

resumestring binary

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.

coverLetterstring binary

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.

Response

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

resultstring

Always 'success' on a successful request

candidateIdinteger

The ID of the newly created candidate

Changes

No recorded changes to this operation across all 2 revisions of this API.