Docs
/
/
Platform
Multi-tenancy
Per-tenant branding

Per-tenant branding

Learn how to use tenants to apply custom branding to email notifications on a per-tenant basis.

Per-tenant branding enables you to override your account-level email branding settings for individual tenants. When you trigger a workflow with a tenant, Knock uses any branding settings defined on that tenant in place of your account defaults.

Branding settings

#

Branding settings are stored on the tenant's settings object. You can set them via the tenant API or directly in the dashboard.

PropertyDescription
branding.primary_colorA hex value for the primary color
branding.primary_color_contrastA hex value for the contrasting color to use with the primary color
branding.logo_urlA fully qualified URL for an image to use as the logo of this tenant
branding.icon_urlA fully qualified URL for an image to use as the icon of this tenant

Setting branding via the API

#

Pass branding settings in the settings object when creating or updating a tenant:

Setting branding in the dashboard

#

Navigate to the Tenants page under Recipients in the dashboard sidebar. Click into a tenant, then select the Branding tab to upload a logo, icon, and set primary colors directly from the interface.

Using per-tenant branding

#

Once branding settings are configured on a tenant, pass the tenant id when triggering a workflow with an email step. Knock will automatically apply the tenant's branding to the email layout for that workflow run.

If no branding settings are defined on the tenant, Knock falls back to your account-level branding defaults.

Example

#

Let's say you're a hospitality company with two boutique hotels — "The Black Lodge" and "The Great Northern" — each with its own brand identity for reservation update emails.

Create each hotel as a tenant and configure their branding in the dashboard or via the API. When triggering a reservation reminder, pass the relevant tenant id (e.g. black-lodge) and Knock will style the email with that tenant's logo and colors instead of your account defaults.

New chat