Skip to main content
PATCH
/
config
curl --request PATCH \ --url https://api.roostedhr.com/api/1_12/config \ --header 'Content-Type: application/json' \ --header 'X-API-KEY: <api-key>' \ --data ' { "category": "shift_options", "subcategory": "shift_requests", "item": "active", "value": true } '
{ "value": true }

Documentation Index

Fetch the complete documentation index at: https://docs.roostedhr.com/llms.txt

Use this file to discover all available pages before exploring further.

Updates a single setting using an addressing pattern of category > subcategory > item > value. The response returns only the updated value, not the full configuration object.

​
Valid categories and subcategories

CategorySubcategories
shift_optionsshift_requests, split_shifts, shift_equalizer, shift_visibility, worker_limits
worker_interactionbailouts, availability, time_off, reviews_and_stars, blogs, coworker_display, calendar_sync
worker_communicationautotext, web_checkin, silence_mode, text_communication, custom_messages, invite_to_work, event_updates
admindaily_summary, verbose_emails, list_view_options, list_view_verbose, worker_profile_control, publish_system, bailout_reason
time_trackingtime_tracking, show_workers_hours, client_sign, reimbursements, deductions, personnel_orderables
Boolean settings must be sent as true / false, not 1 / 0. Some settings depend on the company’s premium subscription status and will return an error if the feature is not available.
Use GET /config first to discover the available items within each subcategory and their current values.

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Identifies a single configuration setting to update by its category, subcategory, and item path.

​
category
enum<string>
required

Top-level configuration category.

Available options:
shift_options,
worker_interaction,
worker_communication,
admin,
time_tracking
Example:

"shift_options"

​
subcategory
string
required

Subcategory within the specified category (e.g., shift_requests, autotext, daily_summary).

Example:

"shift_requests"

​
item
string
required

The specific setting name within the subcategory.

Example:

"active"

​
value
any
required

The new value for the setting. Type depends on the specific setting (boolean, integer, or string).

Example:

true

Response

OK

The updated value for the specified setting.

​
value
any

The new value that was set.