Skip to main content
PUT
/
users
/
settings
Update user settings
curl --request PUT \
  --url https://api.example.com/users/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "settings": {
    "language": "en",
    "timezone": "<string>",
    "theme": "light",
    "notifications": {
      "email": true,
      "slack": true,
      "discord": true,
      "teams": true,
      "webhook": true
    },
    "preferredNotification": "email",
    "emailConfig": {},
    "slackConfig": {},
    "discordConfig": {},
    "teamsConfig": {},
    "webhookConfig": {}
  }
}
'
{
  "language": "en",
  "timezone": "<string>",
  "theme": "light",
  "notifications": {
    "email": true,
    "slack": true,
    "discord": true,
    "teams": true,
    "webhook": true
  },
  "preferredNotification": "email",
  "emailConfig": {},
  "slackConfig": {},
  "discordConfig": {},
  "teamsConfig": {},
  "webhookConfig": {}
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
settings
object
required

Response

The settings have been successfully updated.

​
language
enum<string>
required
Available options:
en,
es,
fr,
de,
it,
pt,
ru,
zh,
ja,
ko
​
timezone
string
required
​
theme
enum<string>
required
Available options:
light,
dark
​
notifications
object
required
​
preferredNotification
enum<string>
required
Available options:
email,
slack,
discord,
teams,
webhook
​
emailConfig
object
​
slackConfig
object
​
discordConfig
object
​
teamsConfig
object
​
webhookConfig
object