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. Bypasses the enable/suppression gates and writes an EmailDeliveryLog entry for every send.
Auth: Both — authentication + an email-template feature check. company_id scoped by an ownership check; platform-owned types forbidden (403) for non-platform companies. Recipient is always request.user.email; returns 400 if the authenticated account has no email. (Only the reachable companies differ per role; recipient is always the caller's own address.)
Rate limit: No rate limit.
Request
- Body:
| Field | Type | Required | Notes |
|---|---|---|---|
| company_id | integer | Yes | Must be an existing account inside your own account tree. |
| type | string | Yes | Valid EmailTemplateType value. |
| header | string | No | nullable, base64 HTML, max:80000, token-validated. |
| body | string | No | nullable, base64 HTML, max:80000, token-validated. |
| footer | string | No | nullable, base64 HTML, max:80000, token-validated. |
| signature | string | No | nullable, base64 HTML, max:80000, token-validated. |
| subject_override | string | No | nullable, max:255, token-validated. Plain text. |
| template_mode | string | No | nullable, regions or html. |
| custom_html | string | No | nullable, base64 HTML, max:400000. |
| show_logo | boolean | No | Not in rules; read by the controller to override logo visibility for this test send. |
Response — { data. } envelope with nested status + message (message echoes the recipient address).
status(string) —success.message(string) —Test email sent to <recipient>.
Errors: 403 when the template type is platform-managed or the email-template section is disabled for your account.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||