/jobs/{job_id}

put

https://partners.apploi.com/jobs/{job_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

job_id

string

required

the job identification number

Body Params

application_form_template_id

integer

The ID of the application form template to use.

brand_name

string

length ≥ 1

The brand/company name (Company Alias) for the job posting.

city

string

length ≥ 1

The city of the job location

country

string

length ≥ 1

The country of the job location

credentialing_state

string

length ≤ 5

The state for credentialing purposes (e.g., 'CA', 'NY'). Required if credentialing_verification_enabled is true.

credentialing_verification_enabled

boolean

Whether credentialing verification is enabled for this job.

credentialing_when_to_send

string

enum

When to send credentialing verification requests. Required if credentialing_verification_enabled is true.

Allowed:

department_id

integer

The ID of the department this job belongs to.

description

string

length ≥ 1

The job description

interview_guide_id

integer

The ID of the interview guide template to use for this job.

job_attributes

object

Additional custom attributes for the job.

job_confidential

boolean

Whether the job is private (not posted to public job boards).

job_title

string

length ≥ 1

The title/name of the job posting

job_type

string

enum

The type of employment: FullTime, PartTime, Both (full and part time), PerDiem, Shifts, or Temporary

Allowed:

min_education_required

string

enum

The minimum education level required.

number_of_openings

integer

≥ 0

The desired number of open (unfilled) positions. Adds or removes openings to reach this count. Requires the job openings feature to be enabled for the team.

published

boolean

Whether the job is published and visible to applicants

question_template_mappings

array of objects

Optional list of template mapping entries. Each entry must supply template_id, order_num, app_is_completed_here, and is_interview_guide.

question_template_mappings

resume_required

boolean

Whether a resume is required for this job application.

role_type

string

length ≤ 30

The role type for credentialing purposes. Required if credentialing_verification_enabled is true.

salary_max

number

≥ 0

The maximum salary amount. Required when salary_type is RANGE or EXACT_AMOUNT.

salary_min

number

≥ 0

The minimum salary amount. Required when salary_type is RANGE.

salary_rate

string

enum

The salary rate period (e.g., PER_HOUR, PER_YEAR). Required when salary_type is specified.

salary_type

string

enum

The salary type: RANGE requires salary_min, salary_max, and salary_rate. EXACT_AMOUNT requires salary_max and salary_rate. Omit this field to not display salary.

Allowed:

show_company_logo

boolean

Whether to display the company logo on the job posting.

state

string

length ≥ 1

The state/province of the job location

street

string

length ≥ 1

The street address of the job location

years_of_experience

integer

0 to 100

The minimum years of experience required.

zip_code

string

length ≥ 1

The postal/zip code of the job location

Responses

400

400 response

403

403 response

404

404 response

200200 response