Tenant Branding
Org-wide display name and logo shared by the app UI and email templates. Stored on Tenant.branding, separate from email delivery settings.
What is tenant branding
Branding is the canonical org-level identity for a tenant: display name and logo URL. It is used by:
- The app UI (via
GET /users/me→memberships[].tenant.branding) - Email templates (merged into email settings responses as
fromName/logoUrl)
Branding is stored in Tenant.branding (JSON). Email-specific fields (enabled, replyTo, locale, notification toggles) remain in emailPreferences.
Fields
| Field | Description |
|---|---|
| displayName | Organization name shown in the app and email header (e.g. "Acme Finance") |
| logoUrl | Optional logo URL for app chrome and HTML email templates |
Operations
| Operation | Method | Endpoint |
|---|---|---|
| Get branding | GET | /tenants/:id/branding |
| Update branding | PATCH | /tenants/:id/branding |
Legacy email-settings fields
PATCH /tenants/:id/email-settings still accepts fromName and logoUrl for backward compatibility. Those values are written to Tenant.branding and stripped from persisted emailPreferences. Prefer PATCH /tenants/:id/branding for UI branding screens.
Related
- Email Settings — Notification toggles and reply-to
- Email Transport — SMTP delivery
- Users —
GET /users/meincludes tenant branding on memberships