Administration

Settings

Retrieve and manage user-level settings.

View as Markdown

Settings operations require user credentials. They are not suitable for account credentials.

Settings store user-level preferences and state for the current authenticated user.

Settings are represented as a JSON object. Each top-level key can contain either a string value or a nested settings object. Use nested objects to group related settings.

Retrieve settings

Retrieve the current user’s settings.

GET
/settings
1curl https://api.hi.umnai.com/settings \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "data": [
3    {
4      "id": "ea8b745ead39ec442fc3b4fba359bf98",
5      "name": "Sample Organisation",
6      "status": "ACTIVE",
7      "created_at": "2026-03-11T16:04:19.749000Z",
8      "updated_at": null
9    }
10  ],
11  "pagination": {
12    "total_items": 1,
13    "items_per_page": 10,
14    "current_page": 1,
15    "total_pages": 1
16  }
17}

Update settings

Add or update specific settings without replacing the full settings object.

PATCH
/settings
1curl -X PATCH https://api.hi.umnai.com/settings \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "notifications": {
6    "email": "disabled"
7  },
8  "dashboard": {
9    "refresh_interval_seconds": "120"
10  }
11}'
Response
1{
2  "theme": "dark",
3  "notifications": {
4    "email": "disabled",
5    "in_app": "enabled"
6  },
7  "dashboard": {
8    "default_workspace_id": "fab1fb91d638d6f4abc12597f87b783e",
9    "refresh_interval_seconds": "120"
10  }
11}

Use this when you want to update only part of the settings object and keep the rest unchanged.

Replace settings

Replace the full settings object for the current user.

PUT
/settings
1curl -X PUT https://api.hi.umnai.com/settings \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "theme": "dark",
6  "notifications": {
7    "email": "enabled",
8    "in_app": "enabled"
9  },
10  "dashboard": {
11    "default_workspace_id": "fab1fb91d638d6f4abc12597f87b783e",
12    "refresh_interval_seconds": "300"
13  }
14}'
Response
1{
2  "theme": "dark",
3  "notifications": {
4    "email": "enabled",
5    "in_app": "enabled"
6  },
7  "dashboard": {
8    "default_workspace_id": "fab1fb91d638d6f4abc12597f87b783e",
9    "refresh_interval_seconds": "300"
10  }
11}

PUT /settings replaces the full settings object. Use PATCH /settings when you only need to update specific settings.

Delete settings

Delete settings for the current user.

DELETE
/settings
1curl -X DELETE https://api.hi.umnai.com/settings \
2     -H "Authorization: Bearer <token>"

Pass a prefix query parameter to delete settings under a specific prefix. If no prefix is provided, all user settings are deleted.

Deleting settings can remove user preferences or saved state. Use a prefix when you only want to delete part of the settings object.