Skip to content

Set a user's UI preferences ({id} may be "me")

PUT
/api/v1/users/{id}/preferences
curl --request PUT \
--url https://example.com/api/v1/users/example/preferences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "extra": { "additionalProperty": "example" }, "refreshIntervalMs": 1 }'
id
required
string
Media typeapplication/json
object
extra
object
key
additional properties
string
refreshIntervalMs
integer
Examplegenerated
{
"extra": {
"additionalProperty": "example"
},
"refreshIntervalMs": 1
}

OK

Media typeapplication/json
object
extra
object
key
additional properties
string
refreshIntervalMs
integer
Examplegenerated
{
"extra": {
"additionalProperty": "example"
},
"refreshIntervalMs": 1
}

Problem Details (RFC 9457)

Media typeapplication/problem+json
object
code
required
string
detail
string
instance
string
status
required
integer
title
required
string
type
required
string
Examplegenerated
{
"code": "example",
"detail": "example",
"instance": "example",
"status": 1,
"title": "example",
"type": "example"
}