Email Content
email_subject
email_subject
Type string
Description
The subject line of the email.
Example
{
"email_subject": "Welcome to Cat Facts"
}
email_body
email_body
Type string
Description
Specifies the body of the email being sent.
Guidance
Required if the template_id
parameter is unset.
Example
{
"email_body": "<html>Welcome to Cat Facts</html>"
}
See Message Personalization to learn how to personalize your message using additional data in the request, Data Tags, or user data.
email_from_name
email_from_name
Type string
Description
Specifies the name the email is sent from.
Guidance
Defaults to the “From Name” setting in Email Settings in the Dashboard.
Example
{
"email_from_name": "Cat Facts"
}
email_from_address
email_from_address
Type string
Description
Specifies the email address the email is sent from.
Example
{
"email_from_address": "[email protected]"
}
email_reply_to_address
email_reply_to_address
Type string
Description
Specifies the email address users reply to.
Example
{
"email_reply_to_address": "[email protected]"
}
email_preheader
email_preheader
Type: string
Description
Preview text displayed after the email subject to provide additional context about the email.
Example
{
"email_preheader": "Welcome to the Daily Cat Facts"
}
disable_email_click_tracking
disable_email_click_tracking
Type bool
Description
If set to true
, the URLs sent within the email will not include link tracking and will be the same as originally set; otherwise, all the URLs in the email will be tracked.
Guidance
- Use if your emails contain Universal Links.
- Defaults to
false
.
Example
{
"disable_email_click_tracking": true
}
More information available on Email Links and Click Tracking.
template_id
template_id
Type string
Description
Identifies a specific template configured within the dashboard. Templates enable standardized notifications across campaigns
Guidance
Provide the UUID of the template, which can be found in the URL when viewing a template on our dashboard.
Example
{
"template_id": "be4a8044-bbd6-11e4-a581-000c2940e62c"
}
include_unsubscribed
include_unsubscribed
Type bool
Description
If set to true
, the notification will also be sent to unsubscribed users.
Guidance
Defaults to false
. Use only for transactional emails.
Example
{
"include_unsubscribed": true
}
More information available at Unsubscribe Links & Email Subscriptions.