Update Settings

patch

https://api.applicant-tracking.com/api/v1/applications/settings

Allows you to update one or multiple settings.

Body Params

allow_apply_with_linkedin

boolean

allow_job_board_applications

boolean

careers_page_cookie_notice

boolean

careers_page_job_order

array

Available options for custom job order are ['category', 'city', 'country', 'job_code', 'posted_at', 'state', 'title', 'updated_at']. If left blank, jobs will be sorted by country, state, city, and updated_at by default.

careers_page_job_order

careers_page_tracking_code

string

default_coverletter_upload_enabled

boolean

default_require_coverletter_upload

boolean

default_require_resume_upload

boolean

default_resume_upload_enabled

boolean

enable_address

boolean

enable_address_completion

boolean

enable_apply_with_qr_code

boolean

enable_auto_hire

boolean

enable_captcha_on_apply

boolean

enable_collect_ssn

boolean

Must be false if enable_auto_hire is false. Must be true if enable_require_ssn is true.

enable_eop_survey

boolean

enable_require_ssn

boolean

Must be false if enable_auto_hire is false.

enable_sms_messaging

boolean

job_categories

array

Job categories allow your administrators to categorize jobs and then presents applicants with the ability to filter your job listings by category. Leave blank to disable.

job_categories

job_category_display_name

string

You can change the terminology used when referring to a category on your hosted careers page. Leave blank for the default.

job_description_app_form_tracking_code

string

onboarding_url

string

Adds a Save and Onboard button to the Mark as Hired dialog, redirecting the user to the set URL. Applicant ID will be appended to whatever URL is set here.

require_address

boolean

require_applicant_privacy_policy

boolean

require_contact_information_on_offer_letter

boolean

If enabled, applicants must provide contact info when signing an offer letter.

require_job_category_field

boolean

Turn this on to make this a required field on the Create/Edit Job page. If this is ON, a job cannot be created without a Job Category

require_referral_question

boolean

show_background_check_options

boolean

show_ofccp_questions

boolean

show_offer_letter

boolean

show_referral_question

boolean

show_social_on_careers_site

boolean

show_video_interview

boolean

thank_you_page_tracking_code

string

Responses

403

Not authorized

500

Internal system error. Please contact support in the event that this occurs.

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Updated the settings.

422Fields were invalid or missing.