Customize the emails we send to your customers on your behalf.
Customize the emails we send to your customers on your behalf.
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 token is valid but the record sits outside 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
| Method | Endpoint | Description |
|---|---|---|
POST | List email types | 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 | List an email's merge fields | Returns the list of supported variable tokens (with sample values) usable in the header/body/footer/signature content for one template type. |
POST | Get an email template | 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 | Save an email template | Create or updates the company's content override for a template type. |
POST | Preview an email | Renders the template with sample variable values and returns the resulting HTML + resolved subject. |
POST | Turn an email type on or off | Enable or disables sending for a template type. |
POST | Choose who sends an email | Switches a template type between Direct Send (email) and Webhook delivery. |
POST | Show or hide your logo in emails | Controls whether the white-label partner logo is shown in the email header for a template type (defaults to visible). |
POST | See email delivery history | Returns a paginated log of all email/webhook delivery attempts for the company, newest first, filterable by type, status, recipient, and date range. |
POST | Reset an email to the default | Clear the company's content overrides (header, body, footer, signature, subject_override) for a type, reverting to system/white-label defaults. |
POST | Send a test email | 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. |