Schedule email to list
Schedule an email to a list for a later time. Set scheduledAt as an ISO 8601 datetime and optionally a timeZone; without a timeZone the time is treated as UTC.
ReferenceView as Markdown
Schedule an email to a list for a later time. Set scheduledAt as an ISO 8601 datetime and optionally a timeZone; without a timeZone the time is treated as UTC.
Schedule an email to a list through Subrite.
POST{baseUrl}/api/v1/communications/email/schedule{
"communicationType": "marketing", // Possible values: "marketing" or "information"
"name": "sample name",
"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",
"emailContent": "<div>hello world</div>",
"scheduledAt": "2025-03-26T05:14:25.064Z", // Set norway time
"timeZone": "Europe/Oslo", // Optional: If not provided, UTC will be used
"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 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: 'Test emails sent successfully',
id: 8987
}The scheduledAt field expects:
2025-03-26T05:14:25.064Z)timeZone is not provided, the system will treat the time as UTCtimeZone is provided, the system will convert the time from the specified timezone to UTCThe timeZone field accepts any valid IANA timezone string supported by the date-fns-tz library. Common examples include:
UTCEurope/OsloEurope/LondonEurope/ParisEurope/BerlinAmerica/New_YorkAmerica/Los_AngelesAsia/TokyoAsia/ShanghaiAustralia/SydneyPacific/AucklandFor a complete list of supported timezones, refer to the .
Example:
{
"scheduledAt": "2025-03-26T05:14:25.064Z",
"timeZone": "Europe/Oslo"
}