Theme

Returns the active theme for the specified user group. This can either be an explicitly defined theme or an inherited theme (in which case the theme's id will point to user group that differs from the path parameter).

Path Params

user_group_id stringrequired

Unique identifier of a user group.

theme_type stringrequired

Query Params

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

Update theme settings for user group

Requires authentication via bearer.

Updates the theme settings of a user group. This operation will only affect the specified user group and all it's descendants, that do not have an override. In case of an inherited theme the operation will implicitly create a new theme for the user group, with the inherited theme providing any values missing from the patch.

Path Params

user_group_id stringrequired

Unique identifier of a user group.

theme_type stringrequired

Query Params

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Request Body

favicon string

company_icon string

company_logo string

ai_assistant_icon string

primary object

primary_text object

secondary object

secondary_text_subdued object

active boolean

Response Body

200 OK

Reset theme

Requires authentication via bearer.

Any explicitly defined theme will be deleted, causing the user group to inherit it's theme from it's parent. If this operation is performed on the root user group, the theme will be reset to the Flip defaults.

Path Params

user_group_id stringrequired

Unique identifier of a user group.

theme_type stringrequired

Query Params

embed string[]

Headers

Accept-Language string

The preferred language used when returning localized strings.

Response Body

200 OK

Error Codes

ROOT_THEME_NOT_RESETTABLE