Homarr
Users

Update header preferences

PATCH/api/users/header-preferences

Replace a user's header layout and display preferences. New board shortcuts must reference boards the target user can view; existing shortcuts may be retained. 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/header-preferences" \  -H "Content-Type: application/json" \  -d '{    "id": "string",    "headerPreferences": {      "version": 3,      "visible": true,      "searchDisplay": "input",      "zones": {        "left": [          {            "type": "builtin",            "id": "logo"          }        ],        "center": [          {            "type": "builtin",            "id": "logo"          }        ],        "right": [          {            "type": "builtin",            "id": "logo"          }        ]      }    }  }'
null

Change widget context menu behavior

Enable or disable opening widget context menus with a right click for a user. Users can update themselves; updating another user requires admin permission.

Change DuckDuckGo bang behavior

Deprecated: use PATCH /api/users/search-preferences instead. Enable or disable DuckDuckGo bangs for a user. Users can update themselves; updating another user requires admin permission.