Type Alias BannersAPI

type BannersAPI = {
    clearCache: typeof clearCache;
    getBanners: typeof getBanners;
    upsertBanners: typeof upsertBanners;
}
Index

Properties

clearCache getBanners upsertBanners

Properties

clearCache: typeof clearCache

Clears the cache for banners api requests.

getBanners: typeof getBanners

Retrieves announcement banner configuration for the tenant, including content, scheduling, and link information for display at the top of the client interface.

GetBannersHttpError

upsertBanners: typeof upsertBanners

Sets content, scheduling, and optional action links for the tenant-wide announcement banner. Requires TenantAdmin role.

Param: body

an object with the body content

UpsertBannersHttpError

Settings

Member Visibility

On This Page

Properties