iotoms Docs

Update tenant settings

PUT
/api/v1/management/settings

Merges the keys you send into the merchant's stored preferences, leaving other keys untouched, and returns the full merged set. Requires user management access. Keys use letters, digits, dot, dash or underscore (max 100 chars); values are strings up to 2000 chars.

How to use it

  1. Call Get tenant settings to see the keys already stored.
  2. Send only the keys to add or change in settings, as string values; an empty map is refused.
  3. Sent keys are overwritten, other keys are kept, and the full merged set is returned.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

Request Body

application/json
  1. body
settings*

Keys to save and their string values. Keys: letters, digits, dot, dash or underscore, max 100 chars; values max 2000 chars. Must not be empty.

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

The merchant's full set of stored preferences after the call.

Example Request
curl -X PUT 'https://beta.iotoms.com/api/v1/management/settings' \  -H 'Content-Type: application/json' \  -d '{  "settings": {    "property1": "string",    "property2": "string"  }}'
Example Response
{  "status": "string",  "message": "string",  "data": {    "settings": {      "property1": "string",      "property2": "string"    }  }}