UpdateDeploymentBrandingRequest

A request or response body; the type column links to the schemas it refers to.

UpdateDeploymentBrandingRequest

Field	Type	Required	Description
display_name	string \| null	no	The long-form name to show; send null or an empty string to restore the default. Omit to leave it unchanged. at most 100 characters
short_name	string \| null	no	The short name for the dashboard wordmark and the top bar on narrow screens; send null or an empty string to fall back to the long-form name. Omit to leave it unchanged. at most 40 characters
support_email	string \| null	no	The address the public /support pages tell people to write to for help; stored lowercased. Send null or an empty string to restore the default, support@botreeinc.com. Omit to leave it unchanged. at most 254 characters

Field

Type

Required

Description

display_name

string | null

The long-form name to show; send null or an empty string to restore the default. Omit to leave it unchanged.

at most 100 characters

short_name

string | null

The short name for the dashboard wordmark and the top bar on narrow screens; send null or an empty string to fall back to the long-form name. Omit to leave it unchanged.

at most 40 characters

support_email

string | null

The address the public /support pages tell people to write to for help; stored lowercased. Send null or an empty string to restore the default, support@botreeinc.com. Omit to leave it unchanged.

at most 254 characters

jsonExample

{
  "display_name": "Acme Corporation Learning Record Storage",
  "short_name": "Acme Corp LRS",
  "support_email": "lrs-help@acme.com"
}