Skip to content

Branding object fields

Branding lets a tenant replace the MiaRec look of the web portal with its own logo, colors, and custom CSS. The REST API exposes the same settings as Administration › Customization › Branding.

Branding is a sub-resource of a tenant. It is addressed by the tenant ID:

/api/v2/tenants/<tenant-id>/branding.json
/api/v2/tenants/<tenant-id>/branding/logo/<location>

Example of a branding object:

{
    "branding": {
        "enabled": true,
        "color": "#123456",
        "color2": "",
        "custom_css": ".navbar { border: 0 }",
        "login_page": {
            "logo_type": "logo",
            "logo_text": "",
            "logo": {
                "filename": "logo.png",
                "updated_at": "2026-07-15T10:00:00+00:00",
                "url": "/api/v2/tenants/209e8a10-e250-4824-8567-43f48e07a060/branding/logo/login_page"
            }
        },
        "header_menu": {
            "logo_type": "text",
            "logo_text": "ACME",
            "logo": null
        }
    }
}

Attributes

Attribute Type Description
enabled boolean Whether branding is enabled for the tenant. When false, the web portal shows the default MiaRec look, but the stored settings are kept.
color string Primary branding color in hex format #rrggbb. Empty string when not set.
color2 string Secondary branding color in hex format #rrggbb. Empty string when not set.
custom_css string Custom CSS rules, maximum 4 KB. CSS that contains suspicious constructs (for example, url(...) or @import) is rejected on update. See Update tenant branding.
login_page dictionary Branding of the Sign-In page. See Logo location.
header_menu dictionary Branding of the top navigation bar. See Logo location.

Logo location

Each of the two logo locations (login_page and header_menu) is a dictionary with the following attributes:

Attribute Type Description
logo_type string

What to display at this location. Supported values:

  • default - the product default logo
  • text - the logo_text value
  • logo - the uploaded logo image
logo_text string Text to display when logo_type is text (1 to 32 characters). Required when logo_type is text.
logo dictionary or null

Read-only metadata of the stored logo image, or null when no image is stored. This attribute is ignored in update requests. Upload and delete logo images with the logo endpoints.

Attributes:

  • filename - name of the uploaded image file
  • updated_at - time when the image was uploaded (ISO 8601, UTC)
  • url - download URL of the image, relative to the server root

Permissions

The branding endpoints are guarded by the branding permission resource, which has the view and edit actions. Enable them in the role that the API user is assigned to. See Role object fields.

A tenant administrator can manage the branding of their own tenant only. A request for another tenant's branding returns 404 Not Found.