Email templates
Every Email templates tool, with the scope it needs, its arguments and the API operation it calls.
8 tools
List email A/B tests
Read onlyatlas_email_ab_tests_list
List every (key, locale) email template that currently has at least one configured A/B variant, with per-variant served / open / click counts + conversion delta vs primary.
- Scope
workspace:read- Calls
- Example prompt
- Which email A/B tests are running?
Arguments
This tool takes no arguments.
Get email A/B tests summary
Read onlyatlas_email_ab_tests_summary_get
Get the A/B test summary for one (key, locale) email template: primary row + each variant with served / open / click counts, openRate, clickRate, and conversionDelta (variant.clickRate - primary.clickRate, in percentage-point form).
- Scope
workspace:read- Calls
- Example prompt
- Show the password reset A/B test summary.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Template key, e.g. "task.assignment" or "contract.reminder". |
locale | string | No | BCP-47-ish locale tag. Defaults to "en". |
List email templates
Read onlyatlas_email_templates_list
List per-tenant email template overrides. Filter by key, locale, or active status.
- Scope
workspace:read- Calls
- Example prompt
- Which transactional email templates have we overridden for this tenant?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
key | string | No | Template key (e.g. "task.assignment", "contract.reminder"). |
locale | string | No | |
isActive | boolean | No |
Preview email templates
Changes dataatlas_email_templates_preview
Render an email template against a sample variables row. Returns subject + HTML + text. If subject/html/text are omitted, the saved override is used.
- Scope
workspace:manage- Calls
- Example prompt
- Preview what the contract reminder email will look like for Ada with renewal next Friday.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Template key (e.g. "task.assignment", "contract.reminder"). |
locale | string | No | BCP-47-ish locale tag. Defaults to "en". |
subject | string | No | |
htmlBody | string | No | |
textBody | string | No | |
variables | object | No |
Set email templates
Changes dataatlas_email_templates_set
Create or update a per-tenant email template override. Upsert is keyed on (key, locale) and bumps version on each save.
- Scope
workspace:manage- Calls
- Example prompt
- Override the task.assignment email subject for our tenant.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Template key (e.g. "task.assignment", "contract.reminder"). |
locale | string | No | BCP-47-ish locale tag. Defaults to "en". |
subject | string | Yes | Subject line. Supports {{var}} substitution. |
htmlBody | string | Yes | HTML body. Supports {{var}} substitution. |
textBody | string | Yes | Plain-text body. Supports {{var}} substitution. |
isActive | boolean | No | Whether this override should be used. Set false to fall back to the default. |
Delete email templates variants
Destructiveatlas_email_templates_variants_delete
Remove one locale variant of a workspace email template. Recipients in that locale then receive the parent template. Returns nothing on success. Requires an owner or administrator. Use this when a translated copy is wrong or no longer wanted.
- Scope
workspace:manage- Calls
- Example prompt
- Remove the French version of the task assignment email template.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
templateId | string | Yes | The workspace email template id whose variant to remove. |
locale | string | Yes | The locale of the variant to remove, such as en, fr or en-GB. |
List email templates variants
Read onlyatlas_email_templates_variants_list
List every per-locale variant attached to a tenant email template. Each variant overrides subject + bodies for a specific recipient locale; the parent template is the fallback.
- Scope
workspace:read- Calls
- Example prompt
- What localized versions exist for the task.assignment email template?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
templateId | string | Yes | TenantEmailTemplate id whose variants you want to list. |
Set email templates variants
Changes dataatlas_email_templates_variants_set
Create or update the per-locale variant of a tenant email template. Upsert is keyed on (templateId, locale). EmailSender picks the variant whose locale matches the recipient (with language-prefix fallback) and falls back to the parent template default otherwise.
- Scope
workspace:manage- Calls
- Example prompt
- Add a Spanish variant for the contract reminder email.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
templateId | string | Yes | TenantEmailTemplate id the variant attaches to. |
locale | string | Yes | Recipient locale tag, e.g. "es" or "en-GB". EmailSender prefers the variant whose locale matches the recipient. |
subject | string | Yes | |
bodyHtml | string | Yes | |
bodyText | string | Yes |