POST
cURL

Send transactional mail

Use this endpoint to send transactional email.

Request Body

  • email_content: (Required) The rich HTML or text content of the email.
  • sender: (Required) Email address of the sender.
  • subject: (Required) Subject line of the email.
  • to: (Required) An array of recipient contact objects.

Example Payload

Response fields

Authorizations

Authorization
string
header
required

Use your API key with the 'Bearer ' prefix

Body

application/json
email_content
string
required

Email content

sender
string
required

From email address

subject
string
required

Email subject

to
object[]
required

Array of recipient objects.

reply_to
string

Valid email address.

parameterized_variables
object

Object containing key-value pairs to replace merge tags in the email template

attachments
object[]

Attachment

attachments_remote
object[]

Remote attachments

add_recipient_to_contact
boolean
default:false

Add recipient to contact

scheduled_at
string<date-time>

Date and time when the email should be sent (ISO 8601 format)

allow_click_tracking
boolean
default:true

Enable tracking of link clicks within the email.

allow_open_tracking
boolean
default:true

Enable tracking of email opens using tracking pixels.

ignore_contact_bounce
boolean
default:true

Send emails even to addresses that previously bounced.

ignore_contact_unsubscribe
boolean
default:true

Send emails to recipients even if they have unsubscribed.

enable_view_in_browser
boolean
default:true

Enable view in browser

include_unsubscribe
boolean
default:false

Include unsubscribe link in the email footer

cc
array

Email address of the CC recipient.

tags
string[]

Array of strings to tag the message with.

Response

Email sent successfully.

success
boolean
Example:

true

failed_recipients
string[]
Example:
report
object[]
quotas
object
sender
string
Example:

"sender@example.com"

message
string
Example:

"Transactional mails sent successfully"