Create a Self-Service Portal Theme

Create a Self-Service Portal theme with its colours. The name and the brand colour are required; every other colour is optional and each colour is a "#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. When "companies" is empty or left out, the theme applies to all companies. 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. When "visibleToEndUser" is left out, end users can see the theme. Requires a SysAid administrator (sysadmin) user; any other user receives a 403 error. Returns a 409 error when a theme with the same name already exists.

Body Params

A Self-Service Portal theme to create.

string
required
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
required
^#[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
Defaults to true

Whether end users can see the theme. Defaults to true when left out.

companies
array of integers, unique

The IDs of the companies the theme applies to. An empty list, or leaving it out, means the theme applies to all 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