Docs
/
/

TenantRequest

A tenant to be set in the system. You can supply any additional properties on the tenant object.

TenantRequest

A tenant to be set in the system. You can supply any additional properties on the tenant object.

Attributes

The channel data for the tenant.

id
string

The unique identifier for the tenant.

name
string

An optional name for the tenant.

The preferences for the tenant.

settings
object

The settings for the tenant. Includes branding and preference set.

branding
object

The branding for the tenant.

icon_url
string

The icon URL for the tenant. Must point to a valid image with an image MIME type.

logo_url
string

The logo URL for the tenant. Must point to a valid image with an image MIME type.

primary_color
string

The primary color for the tenant, provided as a hex value.

primary_color_contrast
string

The primary color contrast for the tenant, provided as a hex value.

preference_set

The preference set for the tenant. Used to override the default preference set.

*
object(any)

Any additional custom properties.

New chat