Save a color theme

PUT /api/2.0/settings/colortheme

Request

Saves the portal color theme specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Portal theme settings

themeobject
idintegerformat: int32

Theme ID

namestring

Theme name

mainobject
accentstring

Accent color

buttonsstring

Button color

textobject
accentstring

Accent color

buttonsstring

Button color

selectedintegerformat: int32

Selected or not

Examples

PUT /api/2.0/settings/colortheme HTTP/1.1
Accept: application/json
Content-Length: 222
Content-Type: application/json
Host: example.com

{
  "theme": {
    "id": 1,
    "name": "blue",
    "main": {
      "accent": "#4781D1",
      "buttons": "#5299E0"
    },
    "text": {
      "accent": "#4781D1",
      "buttons": "#5299E0"
    }
  },
  "selected": 1234
}
curl --request PUT \
  --url https://example.com/api/2.0/settings/colortheme \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "theme": {
    "id": 1,
    "name": "blue",
    "main": {
      "accent": "#4781D1",
      "buttons": "#5299E0"
    },
    "text": {
      "accent": "#4781D1",
      "buttons": "#5299E0"
    }
  },
  "selected": 1234
}'

Responses

200

Portal theme settings

themesarray of object

Themes

idintegerformat: int32

Theme ID

namestring

Theme name

mainobject
accentstring

Accent color

buttonsstring

Button color

textobject
accentstring

Accent color

buttonsstring

Button color

selectedintegerformat: int32

Selected

limitintegerformat: int32

Limit

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).