Send an email
POST/v1/email/send
This endpoint sends an email using the connected ESP
Request
- application/json
Body
required
Email Payload
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
attachments
object[]
Attachments are optional
Base64 content is required
Filename is required
Possible values: [application/pdf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/vnd.ms-powerpoint, text/plain, text/csv, text/html, text/xml, text/calendar, text/css, application/xml, application/json, application/rtf, application/octet-stream, image/jpeg, image/png, image/gif, image/svg+xml, image/webp, image/bmp, image/tiff, audio/mpeg, audio/wav, audio/ogg, video/mp4, video/x-msvideo, video/quicktime, video/webm, application/zip, application/x-tar, application/gzip, application/vnd.rar, application/x-7z-compressed, message/rfc822]
bcc
object[]
BCC recipients are optional
Email is required and must be a valid email format
Name is optional
Default value: NIL
Campaign ID is optional
cc
object[]
CC recipients are optional
Email is required and must be a valid email format
Name is optional
content
object[]
Email content is required when template_id is not provided
Possible values: [text/html, text/plain]
MIME type required
Email content is required
custom_args
object
from
object
required
Email is required and must be a valid email format
Name is optional
headers
object
Headers are optional
Mailer ID is required // Custom arguments are optional
Possible values: [1, 0]
Default value: 0
Process email in bulk is optional
Reply-to email is optional but must be valid if provided
settings
object
required
click_tracking
object
Click tracking settings
Optional boolean value
IP pool to use for sending emails
open_tracking
object
Open tracking settings
Optional boolean value
phishing_protection
object
Phishing protection settings
Optional boolean value
unsubscribe
object
Unsubscribe settings
Optional boolean value
validate
object
Email validation settings
Optional boolean value
Subject is required when template_id is not provided
substitutions
object
property name*
object
Template ID is optional
to
object[]
required
At least one "to" recipient is required
Email is required and must be a valid email format
Name is optional
Responses
- 200
- 400
Email sent
- application/json
- Schema
- Example (from schema)
Schema
{
"ref_id": "01JC3BBW8S9YGX2VNKG5MD7BTA",
"success": true
}
from address does not exist with the provided mailer_id
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"success": false
}