Update a Self-Service Portal Banner

Update the details of an existing Self-Service Portal banner. The API changes only the fields that you include in the request body, at least one. The banner image and its crop settings stay as they are. Requires an Admin user with SysAid Administrator permissions. Concurrent writes are not detected, because the API has no If-Match or ETag, so the last write wins. The name must be unique and cannot be default, in any letter case.

Path Params
integer
required
1 to 2147483647

The unique identifier of the banner in SysAid.

Body Params

The banner properties to change, at least one. Every property left out keeps its current value. Properties not listed are ignored, and a body with none of the listed properties is rejected with 400.

string
length between 1 and 50
\S

The name of the banner. It must be unique and cannot be default, in any letter case.

string
length ≤ 50

The text shown on the banner.

string
enum

The overlay drawn over the banner image.

Allowed:
string
enum

The height of the banner, small, medium or large.

Allowed:
string
^#[0-9a-fA-F]{6}$

The color of the banner text, as a hexadecimal color code.

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