Homarr
Users

Update search preferences

PATCH/api/users/search-preferences

Set a user's default search engine, new-tab behavior, and DuckDuckGo bang preference. Users can update themselves; updating another user requires admin permission.

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/users/search-preferences" \  -H "Content-Type: application/json" \  -d '{    "defaultSearchEngineId": "string",    "openInNewTab": true,    "ddgBangsEnabled": true,    "userId": "string"  }'
null

Change the default search engine

Deprecated: use PATCH /api/users/search-preferences instead. Updates the default search engine and supplied DuckDuckGo bang preference while preserving the new-tab preference. Users can update themselves; updating another user requires admin permission.

Change your color scheme

Set the current user's preferred color scheme. Requires authentication.