Skip to main content

Request Body

The request body defines the parameters required to send an email via the API.


πŸ“ Parameters​

NameTypeRequiredSample ValueDescription
fromStringβœ… Yesabc@gmail.comValid sender email address.
subjectStringβœ… YesEmail subjectSubject line of the email.
bodyTextStringβœ… YesPlain text for email bodyText version of the email body (displayed if recipient’s device cannot render HTML).
bodyHtmlStringβœ… Yes<p>Hello</p>Main content of the email in HTML format.
sendAtDateTime❌ No2024-11-01 11:00:00Datetime in format YYYY-MM-DD HH:mm:ss (UTC, 24-hour). Defaults to current datetime.
uidStringβœ… Yesabc-123Unique ID (max 40 chars). Returned in response for tracking. Must be unique per request.
programIdIntegerβœ… Yes12345Max 6 digits. Used to group requests for reporting & billing.
checkOptOutBoolean❌ NotrueDefaults to true. If true, validates recipient against opt-out list. If false, bypasses opt-out check.

πŸ”Ž Example JSON Payload​

{
"from": "abc@gmail.com",
"subject": "Welcome to IntelSend",
"bodyText": "Hello, this is the plain text body",
"bodyHtml": "<strong>Hello</strong>, this is the HTML body",
"sendAt": "2024-11-01 11:00:00",
"uid": "abc-123",
"programId": 12345,
"checkOptOut": true
}

Pro Tip πŸ’‘

Use a unique uid for every request to avoid duplication and make tracking easier.

See Also

Refer to the Examples section for complete request/response samples.