The Email API empowers you to send personalized and high-performance email communications—whether for marketing campaigns, transactional messages, or customer engagement workflows.

Designed for reliability and ease of integration, our Email API supports:

  • HTML and plain-text content
  • Verified sender identities
  • Email delivery monitoring and optimization
  • campaign-level reporting

Whether you're sending a single message, the Email API ensures your emails are delivered efficiently and securely.

Built on top of Amazon SES, the API enforces best practices for deliverability and domain authentication, helping you maximize inbox placement and minimize bounce rates.

Email Onboarding

Before you can begin sending emails through the Email API, your sender email address must be verified. This verification is required to ensure compliance with industry standards and improve deliverability.

Step 1: Sender Email Verification

If you plan to send bulk or high-volume emails, you must first verify your sender email address.

To begin this process:

  • Contact our Support Team.
  • Provide the email address you want to use as your sender.
  • The Support Team will initiate the verification process on your behalf.

Step 2: Amazon SES Authorization

Once the verification request is submitted:

  • You will receive an automated email from Amazon Web Services (SES).

  • This email will include a confirmation link to authorize the sender address.



To complete the verification:

  • Open the email from Amazon SES.
  • Click the verification link to confirm your sender address.
  • Once verified, your email address will be approved for sending through the API, and you’ll be ready to deliver messages at scale.

Before sending bulk Emails, we recommend you read the Email Best Practices section, because it's essential that you monitor the number of hard bounces in your email program, and that you remove hard-bouncing email addresses from your recipient lists. When email receivers detect a high rate of hard bounces, they assume you don't know your recipients well. As a result, a high hard bounce rate can negatively impact the deliverability of your email messages. And your account could be suspended from sending more emails when the Bounce Rate is 5% or higher.

Sending Email

Once your sender email address is verified, you're ready to start sending emails using the Email API.

When you send an Email, the request body contains the following data:

HTTP Request : POST / emails

Query ParameterDescription
unsubscribeMsgDefines the display text for the unsubscribe link included in the email body, allowing recipients to opt out from future communications. This text will appear as the clickable anchor in the unsubscribe URL.
{
  "to": "[email protected]",
  "from": "[email protected]",
  "text": "we have a new offer this week",
  "subject": "EliPackage Promo",
  "externalId": "123456789abcde",
  "clientId": "48118112",
  "callbacks": [
    "string"
  ],
  "alias": "New User"
}

The parameters presented in the request body example when sending the Email are the following:

Parameter Required Description
to Yes

Recipient’s email address.

from Yes

Sender's verified email address.

text Yes

Email content (can be plain text or HTML).

subject Yes

Subject line of the email.

externalId No

Alphanumeric identifier used for reporting purposes.

clientId No

Unique user identifier that can be used for reporting purposes. This is an identifier you can use to uniquely identify the destination address in your systems. This is similar to the externalId and will be sent back to you if you are requesting callbacks that contain status changes of the messages you send.

callbacks No

Indicate one or more (separated by comma) webhook URLs to notify about the status of the message delivery.That is, If you want to receive the status of the message you've sent to your subscribers, you need to specify your endpoint.

Your endpoint must have a HTTP POST access method and receive a JSON body.

The URL is the external callback where the events of the Email will be registered and published. Once an email is processed, its status will be posted to your callback URL.

To view the full list and meaning of each status, please refer to the Email Status section.

alias No

Assign a custom label or reference name to the email recipient.

When you send the Email, the response body contains the following data:

{
  "meta": {
    "timestamp": 456787654,
    "transactionId": "1f9ca37b-4d1"
  },
  "data": {
    "id": "67f6bce6cd",
    "to": "[email protected]",
    "from": "[email protected]",
    "userName": "EliPackage",
    "operator": "EliPackage",
    "text": "we ha",
    "status": "QUEUED",
    "subject": "EliPackage Promo",
    "externalId": "123456789abcde",
    "clientId": "48118112",
    "callbacks": [
      "string"
    ],
    "alias": "New User"
  }
}

The parameters presented in the response body example when sending the Email are the following:

Parameter Description
data Data contained in the Email.
data.id Unique identifier of the Email.
data.to

Recipient’s email address.

data.from

Sender's verified email address.

data.userName

Owner or creator of the Email.

data.operator

User who is a member of the owner or creator’s space.

data.text

Email content (can be plain text or HTML).

data.status

It represents the current state of the email within the system.

When an email is sent, the system assigns one of several possible statuses to track its delivery progress.

To view the full list and meaning of each status, please refer to the Email Status section.

data.subject

Subject line of the email.

data.externalId

Alphanumeric identifier used for reporting purposes.

data.clientId

Unique user identifier that can be used for reporting purposes. This is an identifier you can use to uniquely identify the destination address in your systems. This is similar to the externalId and will be sent back to you if you are requesting callbacks that contain status changes of the messages you send.

data.callbacks

Indicate one or more (separated by comma) webhook URLs to notify about the status of the message delivery.That is, If you want to receive the status of the message you've sent to your subscribers, you need to specify your endpoint.

Your endpoint must have a HTTP POST access method and receive a JSON body.

The URL is the external callback where the events of the Email will be registered and published. Once an email is processed, its status will be posted to your callback URL.

To view the full list and meaning of each status, please refer to the Email Status section.

data.alias

Custom label or reference name to the email recipient.


Email best practices

Several factors can lead to your email program's success or failure. Understanding how an email is delivered and following certain best practices can increase your chances of reaching your customers' inboxes. Even when you have customers' interests in mind, you may still encounter situations that impact your messages. The following paragraphs contain some recommendations to ensure your email communications reach your intended audience.

Authentication

  1. Authenticate your domain with SPF. Sender Policy Framework (SPF) is an email validation standard that prevents email spoofing. Domain owners use SPF to tell email providers which servers can send emails from their domains.
  2. Sign your outbound mail with DKIM. DomainKeys Identified Mail (DKIM) is an email security standard designed to ensure that the domain owner authorized an email that claims to have come from a specific domain. It uses public-key cryptography to sign an email with a private key. Recipient servers can then use a public key published to a domain's DNS to verify that parts of the email have not been modified during the transit.

📘

ADDING AN EMAIL SENDER

When adding an email sender to your account, you must contact your account manager or support team to get the TXT Records to authenticate your domain with SPF and DNS Records to sign outbound mail with DKIM.

The procedures for updating DNS records vary depending on which DNS or web hosting provider you use.

  1. Test your authentication settings. Sending an email to an ISP-based email address you own, such as a Gmail or Hotmail account, and inspecting the original message is one way to verify your domain configuration is correct. In the case of Gmail you can proceed as follows. After sending the email from the domain you intend to use to to your gmail account, open it, and see if you received the email from your domain. Check the Inbox as well as the Spam folders. If you find the email message you sent from the domain you intend to use, your email is authenticating. Gmail does not accept emails that do not authenticate. You can confirm this by inspecting the details of the email message.

To do this, open the received email message and on the header of the message, to the far right of the From select the kebab menu (three vertical dots). It will display several options, and you are interested in the Show Original. (See figure below).

This will result in a screen that displays a detailed view of the received message, and most importantly it will display the authentication that was performed on the message and against which domain and IP address. A sample screenshot is shown below.

Note in the figure above that the yourdomain refers to the domain you intend to use for your email messages on the platform. The description above is the desired outcome.

However, if the test email message is not received in your account, it is an indication that the domain is not being authenticated or signed.

Domain and "From" address considerations

  • Think carefully about the addresses you send emails from. The "From" address is one of the first pieces of information your recipients see and, therefore, can leave a lasting first impression. Additionally, some ISPs associate your reputation with your "From" address.
  • Avoid using a no-reply address, such as [email protected], as your "From" or "Reply-to" address. Using a no-reply@ email address sends your recipients a clear message: that you aren't offering them a way to contact you and that you're not interested in their feedback.
  • Ensure that the WHOIS information for your domain is accurate. Maintaining an honest and up-to-date WHOIS record demonstrates that you value transparency and allows users to identify whether or not your domain is legitimate quickly.

Maintain a Clean List

  • Implement a double opt-in strategy. When users sign up to receive an email from you, send them a message with a confirmation link, and wait to start sending them emails until they confirm their address by clicking that link. A double opt-in strategy helps reduce the number of hard bounces resulting from typographical errors. This type of organically grown list is the best bet for keeping a healthy subscription list.
  • Perform minimal validation on addresses collected with a web-based form. For example, ensure that the addresses you collect are well-formed (that is, they are in the format [email protected]) and that they refer to domains with valid MX records.
  • Use caution when allowing user-defined input to be passed unchecked. Forums registrations and form submissions present unique risks because the content is entirely user-generated, and spammers can fill out forms with their content. It's your responsibility to ensure that you only send emails with high-quality content.
  • Avoid sending emails to standard alias (such as postmaster@, abuse@, suppor@, or noc@). Ensure that you only send messages to real people who want to receive them. This rule is especially true for standard aliases, which are customarily reserved for email watchdogs. These aliases can be maliciously added to your list as a form of sabotage to damage your reputation.
  • Periodically purge your list form inactive users to keep your email list and reputation with email service providers healthy.

🚧

HARD BOUNCES

It's essential that you monitor the number of hard bounces in your email program, and that you remove hard-bouncing email addresses from your recipient lists. When email receivers detect a high rate of hard bounces, they assume that you don't know your recipients well. As a result, a high hard bounce rate can negatively impact the deliverability of your email messages.

Your account will be suspended from sending more emails when the Bounce Rate is 5% or higher.