SendBulkEmailTemplate

SendBulkEmailTemplate API sends an email template in bulk manner to more than one recipient.

Body Params

This request is used to send more than one message with one call. The required parameters are as follows:

* TemplateId - the id of the template to be sent
* RcptToList - array of recipients' email addresses
* MessageIdList - array of message id per corresponding email recipient 
* ParamsList - array of parameters' values per corresponding email recipient 

The lenght of these lists must be equal. If there is no parameter on the template, ParamList must be set to null value.

MessageId's in MessageIdList are required to prevent multiple sends to the same recipients. So please be aware that if you set the same MessageId when you are using this function, the API will not send the message! Please set different unique MessageId's in MessageIdList when using this API.

SendId is used to group the messages under one ID like campaign ID or group ID so they can be reported together.

If SaveParams is set to "yes", all parameters per recipient are kept in the database.

If SaveContent is set to "yes", all content (after customization with parameters) per recipient are kept in the database.

string
required

the public id of the template.

RcptToList
array of strings
required

The recipient email list

RcptToList*
MessageIdList
array of strings
required

The message id list for recipients. First string in MessageIdList array is used as a Message Id for the first recipient, the second for the second recipient and so on

If set to null or not set at all, all message ids are auto-generated by rest apis for the recipients.

MessageIdList*
ParamsList
array of strings

Parameters for recipients. First string in ParamsList array is used for as parameters for the first recipient, the second for the second recipient and so on

ParamsList
string

Group send id for the whole batch.

string

If yes, all parameters in Params field will be saved.

Valid parameters yes or no

string

If yes, all content generated for recipients will be saved.

Valid parameters yes or no

Headers
string

The access token.

Responses

403

Please login again to get new token.

Language
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json