User Settings

User settings management

Get user settings

get

https://network.ruuvi.comhttps://testnet.ruuvi.com

/settings

Returns settings for the authenticated user.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

User settings fetched successfully

application/json

resultstring · enumRequiredExample: successPossible values:

401

UNAUTHORIZED - Auth token missing or invalid.

application/json

get

/settings

HTTPcURLJavaScriptPython

GET /settings HTTP/1.1
Host: network.ruuvi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "result": "success",
  "data": {
    "settings": {
      "PROFILE_LANGUAGE_CODE": "en",
      "PROFILE_LANGUAGE_CODE_lastUpdated": 1732187742,
      "UNIT_TEMPERATURE": "C",
      "UNIT_TEMPERATURE_lastUpdated": 1732187742
    }
  }
}

Configure a user setting

post

https://network.ruuvi.comhttps://testnet.ruuvi.com

/settings

Creates or updates a setting for the authenticated user.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestring · max: 80Required

User setting name in snake case, for example UNIT_TEMPERATURE, profile_language_code, or settings_123. Names are stored in uppercase.

Pattern: ^(?!.*_[Ll][Aa][Ss][Tt][Uu][Pp][Dd][Aa][Tt][Ee][Dd]$)(?!.*(?:^|_)[A-Fa-f0-9]{16,}(?:_|$))(?!.*(?:^|_)\d{8,}(?:_|$))[A-Za-z][A-Za-z0-9]*(?:_[A-Za-z0-9]+)+$

valuestring · max: 65535Required

User setting value.

timestampinteger · int64Optional

Optional epoch timestamp for the setting. If missing, it is assumed to be the current time.

Responses

200

Setting stored or updated successfully

application/json

resultstring · enumRequiredExample: successPossible values:

400

INVALID - Missing or malformed fields.

application/json

401

UNAUTHORIZED - Auth token missing or invalid.

application/json

409

CONFLICT - Setting with same or newer timestamp already exists.

application/json

post

/settings

HTTPcURLJavaScriptPython

POST /settings HTTP/1.1
Host: network.ruuvi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "PROFILE_LANGUAGE_CODE",
  "value": "en"
}

{
  "result": "success",
  "data": {
    "action": "updated"
  }
}