DeploymentBranding

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

DeploymentBranding

FieldTypeRequiredDescription
display_namestring | nullyes

The long-form deployment name shown in the footer, page titles and emails, or null when the short name (or, failing that, the Botree default) is shown.

short_namestring | nullyes

The short name shown as the dashboard wordmark, and as the top bar title on narrow screens, or null when the long-form name (or, failing that, the Botree default) is shown.

logoDeploymentBrandingLogoyes—
support_emailstring | nullyes

The address the public /support pages tell people to write to for help, or null when the default, support@botreeinc.com, is shown.

updated_atstring (date-time)yes—
jsonExample
{
  "display_name": "Acme Corporation Learning Record Storage",
  "short_name": "Acme Corp LRS",
  "logo": {
    "file_name": "string",
    "content_type": "string",
    "url": "/api/branding/logo?v=1735689600000"
  },
  "support_email": "lrs-help@acme.com",
  "updated_at": "2026-01-01T00:00:00.000Z"
}