User Preferences

Postman Collection

OpenAPI

For accessing and modifying the user's preferences

Operations

GET/user-preferences POST/user-preferences

GET

Get theme preferences for the user

Should NOT be used for rendering because it might not match the page! Can be used for theme switching and testing.

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

application/json

User theme preferences response

GET/user-preferences

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'http://example.com/rest/atlassian-theme/1/user-preferences' \
  --header 'Accept: application/json'

200Response

{
  "Color mode": {},
  "Dark theme key": {},
  "Light theme key": {}
}

POST

Set theme preferences for the user

Updates individual preferences for the user with what is provided

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

Color mode

string

Dark theme key

string

Light theme key

string

Responses

OK - Everything was updated

application/json

User theme preferences response

POST/user-preferences

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://example.com/rest/atlassian-theme/1/user-preferences' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "Color mode": {},
  "Dark theme key": {},
  "Light theme key": {}
}'

200Response

{
  "Color mode": {},
  "Dark theme key": {},
  "Light theme key": {}
}