Create Job Opening

post

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

Create a new job opening. The owner of the API key used 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.

Body Params

postingTitle

string

required

The posting title of the job opening.

jobStatus

string

enum

required

The status of the job opening.

Allowed:

hiringLead

integer

required

The employee id (from the v1/applicant_tracking/hiring_leads endpoint) of the hiring lead for the job opening.

department

string

The department of the job opening.

employmentType

string

required

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

minimumExperience

string

enum

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

Allowed:

compensation

string

The pay rate or compensation for the job opening.

jobLocation

integer

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

jobDescription

string

required

The long-form text description of the job opening.

applicationQuestionResume

string

enum

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

Allowed:

applicationQuestionAddress

string

enum

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

Allowed:

applicationQuestionLinkedinUrl

string

enum

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).

Allowed:

applicationQuestionDateAvailable

string

enum

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).

Allowed:

applicationQuestionDesiredSalary

string

enum

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).

Allowed:

applicationQuestionCoverLetter

string

enum

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).

Allowed:

applicationQuestionReferredBy

string

enum

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

Allowed:

applicationQuestionWebsiteUrl

string

enum

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).

Allowed:

applicationQuestionHighestEducation

string

enum

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

Allowed:

applicationQuestionCollege

string

enum

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

Allowed:

applicationQuestionReferences

string

enum

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

Allowed:

internalJobCode

string

The internal job code for the job opening.

locationType

integer

enum

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.

Allowed:

Responses

200Success. Returns the result status and the new job opening 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.