BAbamboohr
Applicant Tracking
Public API

Create Job Opening

Create a new job opening. The authenticated caller must have access to ATS settings. Use the Get Company Locations and Get Hiring Leads endpoints to obtain valid IDs for jobLocation and hiringLead. On success, returns the new job opening ID.

post/api/v1/applicant_tracking/job_opening

Request

Request body multipart/form-data

postingTitlestring required

The posting title of the job opening.

jobStatus'Draft' | 'Open' | 'On Hold' | 'Filled' | 'Canceled' required

The status of the job opening.

hiringLeadinteger required

The internal employee ID of the hiring lead for the job opening. Use employeeId from Get Hiring Leads (get-hiring-leads).

departmentstring

The department of the job opening.

employmentTypestring required

The type of employment offered in the job opening, e.g. Full-Time, Part-Time, Contractor, etc.

minimumExperience'Entry-level' | 'Mid-level' | 'Experienced' | 'Manager/Supervisor' | 'Senior Manager/Supervisor'' | 'Executive' | 'Senior Executive'

The minimum experience level that qualifies a candidate for the job opening.

compensationstring

The pay rate or compensation for the job opening.

jobLocationinteger

The location id (from the v1/applicant_tracking/locations endpoint) of the job opening. Omit this parameter for a remote job location.

jobDescriptionstring required

The long-form text description of the job opening.

applicationQuestionResume'true' | 'false' | 'Required'

Whether the job opening application has a standard question for resume (true) or not (false) or if uploading a resume is mandatory (required).

applicationQuestionAddress'true' | 'false' | 'Required'

Whether the job opening application has a standard question for address (true) or not (false) or if entering an address is mandatory (required).

applicationQuestionLinkedinUrl'true' | 'false' | 'Required'

Whether the job opening application has a standard question for LinkedIn profile url (true) or not (false) or if entering a LinkedIn profile url is mandatory (required).

applicationQuestionDateAvailable'true' | 'false' | 'Required'

Whether the job opening application has a standard question for availability date (true) or not (false) or if entering an availability date is mandatory (required).

applicationQuestionDesiredSalary'true' | 'false' | 'Required'

Whether the job opening application has a standard question for desired salary (true) or not (false) or if entering a desired salary is mandatory (required).

applicationQuestionCoverLetter'true' | 'false' | 'Required'

Whether the job opening application has a standard question for cover letter (true) or not (false) or if uploading a cover letter is mandatory (required).

applicationQuestionReferredBy'true' | 'false' | 'Required'

Whether the job opening application has a standard question for referred by (true) or not (false) or if entering referred by is mandatory (required).

applicationQuestionWebsiteUrl'true' | 'false' | 'Required'

Whether the job opening application has a standard question for website url (true) or not (false) or if entering a website url is mandatory (required).

applicationQuestionHighestEducation'true' | 'false' | 'Required'

Whether the job opening application has a standard question for highest education (true) or not (false) or if entering highest education is mandatory (required).

applicationQuestionCollege'true' | 'false' | 'Required'

Whether the job opening application has a standard question for college (true) or not (false) or if entering a college is mandatory (required).

applicationQuestionReferences'true' | 'false' | 'Required'

Whether the job opening application has a standard question for references (true) or not (false) or if entering references is mandatory (required).

internalJobCodestring

The internal job code for the job opening.

locationType0 | 1 | 2

The location type for the job opening. 0 = on-site (requires jobLocation), 1 = remote (no jobLocation), 2 = hybrid (requires jobLocation). Defaults to 1 if omitted and no jobLocation is provided, or 0 if jobLocation is provided.

Response

Success. Returns the result status and the new job opening ID.

resultstring

Always 'success' on a successful request

jobOpeningIdstring

The ID of the newly created job opening

Changes

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