White-label emails
Per-account email-template customization (copy, regions, delivery method, logs, test sends).
Per-account email-template customization (copy, regions, delivery method, logs, test sends).
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The template type is platform-managed, or the email-template section is disabled for your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
POST — List every email-template type from the catalog merged with the company's own override flags (enabled state, delivery method, logo visibility, customised flag).
POST — Returns the list of supported variable tokens (with sample values) usable in the header/body/footer/signature content for one template type.
POST — Loads the full editor payload for one template type: raw override regions (null = inherit), resolved effective content, catalog defaults, theme color, and current settings (enabled, delivery method, logo visibility).
POST — Create or update the company's content override for a template type.
POST — Renders the template with sample variable values and returns the resulting HTML + resolved subject.
POST — Switches a template type between Direct Send (email) and Webhook delivery.
POST — Controls whether the white-label partner logo is shown in the email header for a template type (defaults to visible).
POST — Returns a paginated log of all email/webhook delivery attempts for the company, newest first, filterable by type, status, recipient, and date range.
POST — Clear the company's content overrides (header, body, footer, signature, subject_override) for a type, reverting to system/white-label defaults.
POST — Send a real test email (subject prefixed with [Test] ) to the authenticated user's own email address, using sample variable values and any posted draft regions.
Updated 11 days ago