Configure automation email

Configure the email that fires for a registered automation event. Supports three payload shapes:

Toggle — { event, active } enables/disables the automation. On a creator-global save (no mango) it cascades the flag to every per-mango row for the event.
Content save — { event, subject, template } (plus optional mango / active) writes template content. Omit mango to set the creator-global template; provide mango to set a per-mango override.
Per-mango override — any save containing mango auto-enables the creator-global row (so a per-mango override always has a backing enabled event). Callers do not need to pre-toggle the event separately.

Partial updates: subject, template, and active are all optional. Fields absent from the body are preserved on the stored record. At least one of active, template, or subject must be present.

Processing:

HTML sanitization — <script>, <iframe>, event handlers (onclick/onerror/…), and javascript: URLs are rejected. Full HTML documents (<html>/<head>/<body> wrappers) are accepted; wrappers are stripped and any <head><style> blocks are preserved.
Handlebars compile-test — template is compiled against the event's allowed variable catalogue; unknown variables are rejected.
Unlayer design synthesis — a minimal visual-editor design is generated from the HTML so the template remains editable in the dashboard editor.
Cascade writes — creator-global saves cascade active to per-mango rows; per-mango saves auto-enable the creator-global row.

Authorization

bearer

AuthorizationBearer <token>

In: header

Header Parameters

x-whitelabel-host*string

Host name of the dashboard, ex: mydomain.tagmango.com

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

event*string

Event key that this template fires for. Each event has its own set of allowed Handlebars variables (see template field documentation for the full per-event catalogue).

Value in

"mangoPurchase" | "newPostEmail" | "newMangoMailToSubs" | "videoCallSingleSubscriber" | "videoCallMultipleSubscriber" | "sendRescheduleMailSubscriber" | "cancelVideoCallSubscriberMultiple" | "videoCallReminderOneDay" | "videoCallReminderThirtyMinutes" | "videoCallReminderFifteenMinutes" | "videoCallPostFifteenMinutes" | "afterExpiry" | "beforeExpiry" | "creatorTierSubscriptionBeforeExpiry" | "creatorTierSubscriptionAfterExpiry" | "creatorTierSubscriptionAfterExpiryExtended" | "creatorTierSubscriptionAutopayFailed" | "manualExpiredNonPayment" | "tenPercentCourseCompletion" | "fiftyPercentCourseCompletion" | "hundredPercentCourseCompletion" | "incompletePurchase" | "failedPurchase" | "consultationBookingConfirmationToSubscriber" | "consultationBookingReminderToSubscriber" | "consultationBookingCancellationToSubscriber" | "commentOnPost" | "repliedToUserCommentOnPost" | "taggedByUserOnPost" | "likeUserCommentOnPost"

subject?string

Email subject. Handlebars {{{variables}}} supported; allowed variables depend on the event. Omit to keep the existing subject.

template?string

HTML email body. Accepts a body fragment or a full document; outer <html> / <head> / <body> wrappers are stripped. <head><style> blocks are preserved. Dangerous constructs (<script>, <iframe>, event handlers, javascript: URLs) are rejected. Omit to keep the existing template content — useful for toggle-only payloads like {event, active}.

Template variables

Reference a variable with Handlebars triple-brace syntax — e.g. {{{name}}}. Each event exposes its own whitelist of allowed variables; anything else is rejected at save time.

Event	Description	Available variables
afterExpiry	Notification email after subscription expiry	name, creator, mango, mangoLink, recurringType, supportAddress
beforeExpiry	Reminder email 24 hours before subscription expires	name, creator, mango, mangoLink, recurringType, expiryDate, supportAddress
cancelVideoCallSubscriberMultiple	Notification email on workshop cancellation	name, email, phone, creator, mangos, mango, callDate, fromTime, toTime, link, callTitle, callLink, cancelInformation, cancelInformation, supportAddress
commentOnPost	Notification email on post comment	name, postLink, commentedBy
consultationBookingCancellationToSubscriber	Cancellation email on 1-on-1 consultation booking cancel	name, creator, eventTitle, date, time, timezone, callLink, supportAddress
consultationBookingConfirmationToSubscriber	Confirmation email on 1-on-1 consultation booking	name, email, host, creator, eventTitle, date, time, timezone, callLink, supportAddress
consultationBookingReminderToSubscriber	Reminder email 30 minutes before 1-on-1 consultation	name, email, host, creator, eventTitle, date, time, timezone, callLink, supportAddress
creatorTierSubscriptionAfterExpiry	Reminder email after creator tier subscription expiry	name, creator, expiryDate, daysSinceExpiry, expiringDays, renewalLink, supportAddress
creatorTierSubscriptionAfterExpiryExtended	Reminder email after creator tier subscription expiry (restricted access phase)	name, creator, expiryDate, daysSinceExpiry, expiringDays, renewalLink, supportAddress
creatorTierSubscriptionAutopayFailed	Notification email when creator tier subscription AutoPay fails	name, creator, here, supportAddress
creatorTierSubscriptionBeforeExpiry	Reminder email before creator tier subscription expiry	name, creator, daysLeft, expiryDate, renewalLink, supportAddress
failedPurchase	Reminder email on failed purchase	name, mango, phone, mangoLink, creator, supportAddress
fiftyPercentCourseCompletion	Notification email for 50% course completion	name, creator, courseName
hundredPercentCourseCompletion	Notification email for 100% course completion	name, creator, courseName
incompletePurchase	Reminder email on purchase drop-off	name, mango, phone, mangoLink, creator
likeUserCommentOnPost	Notification email on comment like	name, postLink, likedBy
mangoPurchase	Confirmation email on mango purchase	name, email, phone, mango, creator, amount, link, affiliateLink, supportAddress
manualExpiredNonPayment	Reminder email for missed installment payment	name, mango, installmentnomissed, totalinstallmentno, subscribercurrency, installmentamount, duedate, checkoutlink, brandName, supportAddress
newMangoMailToSubs	Promotional email on mango creation	name, email, creator, mango, mangoLink, supportAddress
newPostEmail	Notification email on new post creation	name, email, mango, mangos, creator, postLink, supportAddress
repliedToUserCommentOnPost	Notification email on comment reply	name, postLink, repliedBy
sendRescheduleMailSubscriber	Notification email on rescheduling a workshop	name, email, phone, creator, mangos, mango, link, callTitle, callLink, oldCallInformation, oldCallInformationCreator, newCallInformation, newCallInformation, supportAddress
taggedByUserOnPost	Notification email on being tagged in a comment	name, postLink, taggedBy
tenPercentCourseCompletion	Notification email for 10% course completion	name, creator, courseName
videoCallMultipleSubscriber	Notification email on recurring workshop creation	name, email, phone, creator, mangos, mango, callDate, fromTime, toTime, link, callTitle, callLink, callsInformation, callsInformationCreator, supportAddress
videoCallPostFifteenMinutes	Post-workshop email 15 minutes after workshop	name, email, phone, creator, mangos, callTitle, callDate, fromTime, toTime, link, supportAddress
videoCallReminderFifteenMinutes	Reminder email 15 minutes before workshop	name, email, phone, creator, mangos, callDate, callTitle, callLink, fromTime, toTime, link, creatorTimeZone, subscriberTimeZone, supportAddress
videoCallReminderOneDay	Reminder email 24 hours before workshop	name, email, phone, creator, mangos, callDate, callTitle, callLink, fromTime, toTime, link, creatorTimeZone, subscriberTimeZone, supportAddress
videoCallReminderThirtyMinutes	Reminder email 30 minutes before workshop	name, email, phone, creator, mangos, callDate, callTitle, callLink, fromTime, toTime, link, creatorTimeZone, subscriberTimeZone, supportAddress
videoCallSingleSubscriber	Notification email on single workshop creation	name, email, phone, creator, mangos, mango, callDate, fromTime, toTime, link, callLink, callTitle, callInformation, callInformationCreator, supportAddress

Whitelabel hosts additionally have access to logoEmailHeader, brandName, unsubLink, offeringTitle, offeringTitles on every event.

mango?object

Optional mango id. When provided, the save scopes the configuration to this mango as an override (takes precedence over the creator-global template at send-time). Any per-mango save also auto-enables the creator-global row — a per-mango override only makes sense when the event is enabled globally. Omit to target the creator-global template itself.

active?boolean

Whether the automation is active for this event. Defaults to true on first insert.

Creator-global save (no mango): this flag cascades to every per-mango row for the event.
Per-mango save (with mango): the target per-mango row takes this value; the creator-global row is always auto-enabled (set to true) regardless.

Accepted as the sole content of a toggle payload: { event, active }.

At least one of active, template, or subject must be provided in the body.

Response Body

`application/json`

curl -X POST "https://api-prod-new.tagmango.com/api/v1/external/automations/emails/templates" \  -H "x-whitelabel-host: string" \  -H "Content-Type: application/json" \  -d '{    "event": "mangoPurchase"  }'

{
  "_id": "69c77c57ad85cea56909a95e",
  "creator": "69945193ce0ecef7256a481f",
  "mango": "69bcc993473291fad8e4a7fa",
  "event": "mangoPurchase",
  "subject": "Your {{{mango}}} purchase is confirmed",
  "template": "<p>Hey {{{name}}}, thanks for buying <strong>{{{mango}}}</strong>!</p>",
  "active": true,
  "createdAt": "2026-04-23T11:17:44.000Z",
  "updatedAt": "2026-04-23T11:17:44.000Z"
}

{
  "code": 400,
  "type": "Bad Request",
  "statusMessage": "BAD_REQUEST",
  "errorCode": "AUTOMATION_TEMPLATE_TOO_LARGE",
  "message": "HTML templates are capped at 256 KB after UTF-8 encoding.",
  "result": "HTML templates are capped at 256 KB after UTF-8 encoding.",
  "success": false
}

{
  "code": 401,
  "type": "Unauthorized",
  "statusMessage": "UNAUTHORIZED",
  "message": "Invalid token",
  "success": false
}

{
  "code": 403,
  "type": "Forbidden",
  "statusMessage": "FORBIDDEN",
  "errorCode": "AUTOMATION_USER_NOT_CREATOR",
  "message": "The user has not completed creator onboarding or is not a valid creator account.",
  "result": "The user has not completed creator onboarding or is not a valid creator account.",
  "success": false
}

{
  "code": 404,
  "type": "Not Found",
  "statusMessage": "NOT_FOUND",
  "errorCode": "AUTOMATION_CREATOR_NOT_FOUND",
  "message": "The creator associated with the API key does not exist.",
  "result": "The creator associated with the API key does not exist.",
  "success": false
}

Configure automation email

Authorization

Header Parameters

Request Body

Template variables

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

AUTOMATION_TEMPLATE_TOO_LARGE

AUTOMATION_TEMPLATE_UNSAFE_HTML

AUTOMATION_HANDLEBARS_COMPILE_ERROR

AUTOMATION_USER_NOT_CREATOR

AUTOMATION_UAM_PERMISSION_DENIED

AUTOMATION_MANGO_NOT_OWNED

Template variables

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`