Skip to main content
PUT
/
api
/
v1
/
users
/
me
/
settings
/
{key}
Set user setting
curl --request PUT \
  --url https://api.contracting.kukkingu.software/api/v1/users/me/settings/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": {
    "theme": "dark"
  }
}
'
{
  "data": {
    "key": "theme",
    "value": {
      "theme": "dark"
    },
    "createdAt": "2023-10-05T14:48:00.000Z",
    "updatedAt": "2023-10-05T14:48:00.000Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

key
string
required

Unique key of the user setting.

Maximum string length: 255
Example:

"theme"

Body

application/json

Request body used to set the value of a user setting.

Request body used to set the value of a user setting.

value
any
required

JSON value stored for the user setting (string, number, boolean, array, or object).

Example:
{ "theme": "dark" }

Response

Default Response

Standard success response payload wrapped in a data property.

data
object
required

User setting resource returned by the API.