Required Parameters

Usage

Description

Access Token or API Key

Authorization: Bearer {token} header

Pass the API key in the request header for request authentication.

Recipient

Included email "care@Alendei.com"

In case you would like to send the email to multiple recipients and wish to specify the recipients manually, use the parameter recipients to pass the email addresses of the intended recipients as an array.

ListId

listId (uuid) eg: "3fa85f64-5717-4562-b3fc-2c963f66afa6

In case you wish to send the email to contacts of a particular CRM list, pass the list ID of the desired list as the parameter value. In case you wish to send the email to multiple contact lists, you can pass multiple List IDs as an array.

Sender Name

From Email Name

This parameter specifies the name that you want to display as the sender name for the email. This name helps the email recipients identify who sent them the email.

Sender From

From Email address Example. marketing@yourdomain.com

This parameter specifies the email address you want to display as the sender address for the email and the name that you want to display as the sender name for the email.

These details helps the email recipients identify who sent them the email.

Note: By default, you can only use care@Alendei.com as the sender email for your emails. In case you wish to use your domain address as the sender email, please write to us at care@Alendei.com.

Reply to email

reply-to emails

This parameter specifies the email address at which you would like to receive replies from your email recipients, and the display name that you wish to use for the address.

Subject

Use Nice and catchy Subject lines (you can also use Personalization in your subject lines)

This parameter specifies the text that you would like to appear in the email's subject field.

Preheader

Preheader can be Dynamic using Personalization tags

This parameter specifies the text you would like to appear in the email's preheader area, i.e., the area after the subject line.

Email Campaign ID

Use Email Template ID of your Alendei Platforms Account

If you are using the Alendei Platforms Email Creator to design your email, pass the Email Campaign ID of the email you want to send as the parameter value.

Email Campaign ID is the unique identifier for an email campaign created in your Alendei Platforms account.

HTML Body

Use your own HTML

If you are designing your email in HTML, encode it into Base64 format and pass it as the parameter value.

Webhook URL

Delivery Status

Use this parameter to specify the webhook URL where you want to receive delivery status updates for the email being sent. When the destination email client returns a delivery status, the status is instantly posted to this webhook URL. Using a Webhook enables your application to receive delivery updates as they happen, in an easily parsable JSON format.

Updates will be sent for the following delivery statuses:

+ Processed

+ Dropped

+ Deferred

+ Bounce

+ Delivered

+ Open

+ Click

+ Spam Report

+ Unsubscribe

Optional Parameters

Usage

Description

Personalization Substitution Tags

personalizationSubstitutionTags : { "tagName": "[name]", "tagValue": "Care" }

These tags help you insert dynamic data at the time of email sending. In order to substitute the data at the time of the sending, follow the pattern "substitution_tag":"value” to substitute for the key/value pairs.

-- In case you use the parameter 'recipients' to identify the email recipients, the substitutions will work as specified.

-- In case you use both the parameters listID and recipients to identify the email recipients, and the information passed under recipients is not in conformity with the information stored in the CRM list, data will get substituted on the basis of information passed under the parameter recipients.

-- In case you use the parameter ListID to identify multiple Lists, and a contact exists in both the lists with different information, data will get substituted from either of the lists on a random basis.

ScheduledDate-time

RFC3339 format (Y-m-d\TH:i:sP)

Pass the scheduled date and time of the email distribution in RFC3339 format (Y-m-d\TH:i:sP). The date and time passed in this parameter will be converted as per the offset value specified in your account settings.