Send email to list
Send an email to a list (segment) of members right away. The request sets the sender, list, subject and content, with an optional template and host name for unsubscribe links.
ReferenceView as Markdown
Send an email to a list (segment) of members right away. The request sets the sender, list, subject and content, with an optional template and host name for unsubscribe links.
Send an email to a list through Subrite.
POST{baseUrl}/api/v1/communications/email/send{
"communicationType": "marketing", // Possible values: "marketing" or "information"
"name": "coming from external",
"senderId": 2, // Use sender ID from Step 2 response
"consentId": null,
"segmentId": 1, // Use segment ID from Step 3 response
"subject": "email subject",
"emailPreviewText": "sample",
"templateId": 1, // optional
"emailContent": "<div>hello world</div>",
"hostName": "example.com" // Optional. See "Host name" below.
}In the example, the senderId comes from the step 2 response and the segmentId from the step 3 response on the Setup page.
hostName is optional. When set, unsubscribe links generated for this email use the supplied hostname instead of the tenant's primary hostname. Use it when your tenant serves multiple brand domains so recipients land on the correct brand.
a-z, 0-9, ., -, optional :port); IDN hostnames must be supplied in punycode form.{
"success": true,
"message": "Email sent successfully",
"id": 168
}