Edit Featured Items

PUT /api/featured-company

This endpoint allows you to edit featured items that are displayed on the stats TV displays.

Security

This endpoint requires authentication. You must include a valid API key in the request header. Permission(s) Required: EDIT_FEATURED_ITEMS

Request Body

[
    {
        "name": string,
        "description": string,
        "link": string,
        "type": "logo" | "basic",
        "backgroundImageUuid": string,
        "logoImageUuid": string
    },
    {...}
]

name

Primary text of the item (company name).

description

Secondary long form text for the item.
Note: longer text may cause layout issues.

link

Readable shortened link.
This will be displayed on the stats TV displays.
It is recommended to leave out schema (http/https) and trailing slashes.

type

Type of card layout.
Logo version contains a logo and a background image.
Basic version contains a background image only.

backgroundImageUuid Optional

UUID of the background image.
This should refer to an image uploaded to the system.
Learn how to upload images

logoImageUuid Optional

UUID of the logo image.
This should refer to an image uploaded to the system.
This will only be used if the type is “logo”.
Learn how to upload images