Email templates
Email templates endpoints of the Zanfia Workspace API, with schemas and code samples.
2 min readLast updated Sep 10, 2026
System emails the platform sends on your behalf (purchase confirmation, access granted, renewal reminders, …) as edited in Site → Emails. GET /email-templates returns every template key with its stock defaults and your workspace overrides (subject, blocks, per language, branding). PATCH /email-templates writes overrides for one or more keys (send only the keys you change; null restores the stock template). POST /email-templates/{key}/test-sends sends the rendered email to the workspace owner so you can check it in a real inbox. Rendering the HTML preview stays dashboard-only. All routes require a Authorization: Bearer header — see Authentication.
List email templates
GET
/email-templatesAuthorization
bearerAuth AuthorizationBearer <token>
API key from Dashboard → Integrations → API, MCP and CLI.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/email-templates"{ "branding": { "logoUrl": "string", "hideLogo": true, "accentColor": "string", "senderName": "string", "replyTo": "string" }, "overrides": { "purchase-confirmation": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "order-awaiting-payment": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "trial-started": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "free-signup": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "access-granted": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "payment-failed": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "access-ending-reminder": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "access-expired": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "login-code": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "login-link": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "direct-message": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "testimonial-request": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "consultation-booked": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "consultation-cancelled": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "certificate-issued": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "certificate-expiring": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "certificate-expired": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-new-post": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-post-comment": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-comment-reply": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-mention": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-post-reaction": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-comment-reaction": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-direct-message": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-connection-request": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "support-ticket-reply": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "support-ticket-resolved": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] } }, "defaults": { "logoUrl": "string", "logoDarkUrl": "string", "accentColor": "string", "senderName": "string", "replyTo": "string", "signature": "string", "hideZanfiaBranding": true, "language": "en" }, "emails": [ { "key": "purchase-confirmation", "group": "purchases", "optional": true, "enabledByDefault": true, "status": "stock", "enabled": true, "customized": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "variables": [ "firstName" ], "linkTargets": [ "sign-in" ], "systemBlocks": [ { "kind": "signature", "required": true } ], "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "bodyCustomized": true, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] } ]}{ "error": "string", "message": "string"}Update email templates
PATCH
/email-templatesAuthorization
bearerAuth AuthorizationBearer <token>
API key from Dashboard → Integrations → API, MCP and CLI.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
PATCH /email-templates — partial update: branding replaces the whole branding section; overrides[key] replaces that email's override, overrides[key] = null resets it to stock, omitted keys are untouched. Validated against the customizable-email registry server-side.
Response Body
application/json
application/json
curl -X PATCH "https://example.com/email-templates" \ -H "Content-Type: application/json" \ -d '{}'{ "branding": { "logoUrl": "string", "hideLogo": true, "accentColor": "string", "senderName": "string", "replyTo": "string" }, "overrides": { "purchase-confirmation": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "order-awaiting-payment": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "trial-started": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "free-signup": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "access-granted": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "payment-failed": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "access-ending-reminder": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "access-expired": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "login-code": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "login-link": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "direct-message": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "testimonial-request": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "consultation-booked": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "consultation-cancelled": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "certificate-issued": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "certificate-expiring": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "certificate-expired": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-new-post": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-post-comment": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-comment-reply": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-mention": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-post-reaction": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-comment-reaction": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-direct-message": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "community-connection-request": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "support-ticket-reply": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] }, "support-ticket-resolved": { "enabled": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "variants": { "property1": {}, "property2": {} }, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] } }, "defaults": { "logoUrl": "string", "logoDarkUrl": "string", "accentColor": "string", "senderName": "string", "replyTo": "string", "signature": "string", "hideZanfiaBranding": true, "language": "en" }, "emails": [ { "key": "purchase-confirmation", "group": "purchases", "optional": true, "enabledByDefault": true, "status": "stock", "enabled": true, "customized": true, "subject": { "en": "string", "pl": "string" }, "headline": { "en": "string", "pl": "string" }, "variables": [ "firstName" ], "linkTargets": [ "sign-in" ], "systemBlocks": [ { "kind": "signature", "required": true } ], "layout": [ { "id": "string", "type": "text", "text": { "en": "string", "pl": "string" } } ], "body": { "en": "string", "pl": "string" }, "bodyCustomized": true, "attachments": [ { "kind": "media", "mediaId": "string", "name": "string", "mimeType": "string", "size": 0, "storagePath": "string", "url": "string" } ] } ]}{ "error": "string", "message": "string"}Send a test email
POST
/email-templates/{key}/test-sendsAuthorization
bearerAuth AuthorizationBearer <token>
API key from Dashboard → Integrations → API, MCP and CLI.
In: header
Path Parameters
key*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
POST /email-templates/:key/test-sends — language defaults to 'pl'.
Response Body
application/json
application/json
curl -X POST "https://example.com/email-templates/string/test-sends" \ -H "Content-Type: application/json" \ -d '{}'{ "status": "queued", "email": "string"}{ "error": "string", "message": "string"}Was this article helpful?
Related articles
Spotted something off? Tell us at support@zanfia.com.