CreateEmail

post

http://mmpeapi.dengage.com/template/email/create

CreateEmail API is used to create email templates. This is the first step to send batch email messages. First, create an template from either API or Interface and use SendBatch function to send a batch using this template.

poolId, emailFromId and emailReplyId are pre-configured parameters in the admin panel. You can get these parameter's possible values by calling the configuration/sendParams API. emailFromId and emailReplyId are optional, if you nor provide a value the system will use your account's default values.

Body Params

Request body contains all necessary parameters to create an email template. There are some parameters with ids ( poolId, fromId, replyId). These parameters are pre-configured parameter in the admin panel. You can get these parameters and their values by calling configuration/send-params API.

accountId

integer

An api user can be authorized to multiple accounts. If the user which is used to access this api method, have access to multiple accounts, this parameter must be set.

In other words, if this user have only access to a single account, this parameter is optional.

name

string

required

Name of the template given to easily identify when using admin panel.

subject

string

required

This field is the subject of the email.

body

string

required

This is the body of the email. This is may contain 2 type of data which are HTML and CODE. Type of the body may be set via another field which is 'Mode'

poolId

integer

required

This field is used to set which IP pool is going to be used for email delivery. IP pools are pre-configured through the admin panel. Please use configuration/send-params API to get all these configured

mode

string

Defaults to CODE

This field is used to set body type of the template.

jsonData

string

This field contains json data for preview.

publicId

string

This field is used to set template id which is going to be used to select this template via other api methods. It's an optional parameter and if not set, a random unique GUID value will be set and returned.

csvData

string

This field contains column-seperated(CSV) data for preview.

preHeader

string

This field is used to set the preheader for mobile devices for email messages.

emailFromId

integer

This field is used to set which 'From Address' is going to be used for email delivery. This Id can be gathered by calling configuration/send-params API.

emailReplyId

integer

This field is used to set which 'Reply Address' is going to be used for email delivery. This Id can be gathered by calling configuration/send-params API.

Headers

Authorization

string

required

The access token from Login function

string

enum

Defaults to application/json

Generated from available response content types

Responses

403

Please login again to get new token.

200The request is accepted. Your template email template is successfully created by the API.

400Request body has some invalid fields.

401Please login again to get new token.

422Unprocessable entity. Please check error message for further details.