Update a Self-Service Portal Theme

Change a Self-Service Portal theme. Send only the fields to change; every field left out keeps its current value, and the request needs at least one field. A colour cannot be cleared, only replaced with another "#RRGGBB" hex code. The name is trimmed of surrounding spaces, is 1 to 150 characters, cannot be blank, cannot be "default" in any letter case, and cannot contain emoji or other characters above U+FFFF; otherwise the request fails with a 400 error. The name must be unique among the themes: uniqueness is case-insensitive and ignores surrounding spaces, and a theme can keep its own name. When "companies" is sent, it replaces the theme's companies, and an empty list means the theme applies to all companies; when it is left out, the companies are not changed. The company IDs are not checked: an unknown ID is stored as given and the theme is then visible to no one, and SysAid does not report a failed company write. On an account with companies turned off, SysAid reads no companies, so any update there resets the theme to all companies. The response is the updated theme, built from the values written, so its "lastModifiedTime" may differ from a later get request in its milliseconds. Requires a SysAid administrator (sysadmin) user; any other user receives a 403 error. Returns a 404 error when the theme does not exist, and a 409 error when a built-in theme is updated or when another theme already has the name. The update has no ETag or "If-Match" header: SysAid does not detect concurrent updates of the same theme, so the last one wins.

Path Params
integer
required
1 to 2147483647

The unique identifier of the theme in SysAid.

Body Params

The fields of a Self-Service Portal theme to change. Fields left out keep their current value.

string
length between 1 and 150

The name of the theme. It is trimmed of surrounding spaces and cannot be blank, cannot be "default" in any letter case, and cannot contain emoji or other characters above U+FFFF. It must be unique: uniqueness is case-insensitive and ignores surrounding spaces.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

string
^#[0-9A-Fa-f]{6}$

A colour as a hex code. SysAid leaves a colour out when it is not set or is not a valid hex code.

boolean

Whether end users can see the theme.

companies
array of integers, unique

The IDs of the companies the theme applies to. An empty list means the theme applies to all companies; leaving it out keeps the current companies. The IDs are not checked: an unknown ID is stored as given and the theme is then visible to no one, and SysAid does not report a failed company write.

companies
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json