PUT /api/v2/users/me/settings
Updates the settings for the currently authenticated user. This includes UI preferences for onboarding, tooltips, keyboard shortcuts, theme preferences, and other feature toggles.
Settings are grouped into:
- Support: Support UI preferences (onboarding, tooltips, shortcuts, theme)
- admin_center: Admin Center UI preferences (navigation, onboarding)
- shared_views_order: Optional array of view IDs for custom ordering
Only the specified settings will be updated. Other settings will remain unchanged.
Allowed For
- Agents
Servers
- https://{subdomain}.{domain}.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
settings |
Object | Yes |
User settings to update |
settings.lotus |
Object | No |
Lotus UI settings for onboarding, tooltips, and feature preferences |
settings.lotus.agent_workspace_theme_preference |
String | No |
Agent workspace theme preference Valid values:
|
settings.lotus.keyboard_shortcuts_enabled |
Boolean | No |
Enable keyboard shortcuts in Lotus |
settings.lotus.macro_shortcuts_enabled |
Boolean | No |
Enable macro shortcuts in Lotus |
settings.lotus.show_onboarding_tooltips |
Boolean | No |
Show tooltips for first-time user |
settings.shared_views_order[] |
Array | No |
Order of shared views (array of view IDs) |
settings.admin_center |
Object | No |
Admin Center UI settings for onboarding and preferences |
settings.admin_center.has_admin_center_side_nav_open |
Boolean | No |
Whether the Admin Center side navigation is open |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.