Skip to main content

Request Body

Parameters

NameTypeRequiredSample ValueDescription
fromStringYesabc@gmail.comValid email address
subjectStringYesEmail subjectEmail subject line
bodyTextStringYesPlain text for email bodyText version of email body is displayed when the user's device is not capable of displaying HTML body
bodyHtmlStringYesHTML for email bodyMain content of email in HTML format
sendAtDateTimeNo2024-11-01 11:00:00Datetime format as YYYY-MM-DD HH:mm:ss in UTC timezone. HH → 00-23. Default: Current datetime
uidStringYesabc-123Limit: 40 characters, used for tracking purposes. This uid will be returned in request response. Should be unique for each request.
programIdIntegerYes12345Limit: 6 digits only. Used to bundle multiple requests in single programId. To be used for reporting and billing purposes.
checkOptOutBooleanNotrueDefault: true. Check if the email address is opted out of the from email address. If false, system will bypass the check against the opt-out list.

Refer to the Examples for sample requests.