Send Email over API

from

string

Email address with optional sender name. Example: "Jane Doe <[email protected]>".

to

string

Email address of the recipients with optional placeholder values for personalized content.

replyTo

string

Email address to which recipients of the email can reply.

subject

string

Message subject.

text

string

Body of the message.

html

string

HTML body of the message. If html and text fields are present, text field will be ignored and html will be delivered as message body.

templateId

int

Template identifier based on which the email message is generated. Create the template in the web interface. If the templateId is present then html and text values are ignored. This field supports value of broadcast templateId only. Content templateId is not supported.

defaultPlaceholders

string

Default placeholder values used for all recipients. The values are used to generate the email message.

attachment

file

File attachment.

bulkId

string

The ID uniquely identifies the sent Email request. This filter will enable you to query delivery reports for all the messages using just one request. You will receive a bulkId in the response after sending an Email request. If you don't set your own bulkId, unique ID will be generated by our system and returned in the API response.

messageId

string

The ID that uniquely identifies the message sent for a recipient.

sendAt

datetime

Date and time when the message is to be sent. Used for scheduled Email (Email is not sent immediately, but at scheduled time).

intermediateReport

boolean

The real-time Intermediate delivery report that will be sent on your callback server. Can be true or false.

notifyUrl

string

The URL on your callback server on which the Delivery report will be sent.

notifyContentType

string

Preferred Delivery report content type. Can be application/json or application/xml.

callbackData

string

Additional client's data that will be sent on the notifyUrl. The maximum value is 4000 characters.

track

boolean

Enable or disable open and click tracking. Can be true or false.Default value is true. Passing true will only enable tracking and the statistics would be visible in web portal interface alone. This can be explicitly overridden by trackopens and trackclikcs.

trackopens

boolean

This parameter enables or disables track open feature. Can be true or false.

trackclicks

boolean

This parameter enables or disables track click feature. Can be true or false.

trackingUrl

string

The URL on your callback server on which the open and click notifications will be sent. If you are passing this parameter then track=true will be assigned, you don't need to pass track=true separately. See Tracking Notifications for more details.

Helper Example: #eq

 {{#eq name "Bob"}}   

      Dear {{name}}   

{{else}} 

      Hi {{name}}   

{{/eq}} 

{    "to": "[email protected]",    "placeholders": {    "name": "Bob"    }  }

 Dear Bob

Helper Example: #each

 {{#each friends}}

      Hi {{this}}

 {{/each}}

{    "to": "[email protected]",    "placeholders": { "friends":["Bob","John","Jack"]  }  }

 Hi Bob Hi John Hi Jack

Helper Example: #unlessEq

   {{#unlessEq name "Bob"}}

     Dear {{name}}

   {{else}}

    Hi {{name}}

  {{/unlessEq}}

{    "to": "[email protected]",    "placeholders": {    "name": "Bob"    }  }

 Hi Bob

Helper Example: #default

 Hi {{name}}

{    "to": "[email protected]",    "placeholders": {    "name": "Bob"    }  }

Hi Bob

Helper Example: #gt

  {{#gt age 12}}

    Welcome {{name}}!

  {{else}}

    Hey {{name}}, you are under age

  {{/gt}}

{    "to": "[email protected]",    "placeholders": {    "name": "Bob" , "age":10   }  }

  Hey Bob, you are under age

Helper Example: #lt

  {{#lt age 12}}

    Welcome {{name}}!

  {{else}}

    Sorry {{name}}, This is kids arena

  {{/lt}}

{    "to": "[email protected]",    "placeholders": {    "name": "Bob" , "age":10   }  }

  Welcome Bob!

Helper Example: #equalsIgnoreCase

  {{#equalsIgnoreCase gender "male"}}

    Dear Mr {{name}}

  {{else}}

    Dear customer

  {{/equalsIgnoreCase}}

{    "to": "[email protected]",    "placeholders":

{    "name": "Bob" , "gender": "MALE"   }  }

Helper Example: #gte

  {{#gte age 12}}

    Welcome {{name}}!

  {{else}}

    Hey {{name}}, you are under age

  {{/gte}}

{    "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob" , "age":10   }  }

Helper Example: #lte

 {{#lte age 12}}

    Welcome {{name}}!

  {{else}}

    Sorry {{name}}, This is kids arena

  {{/lte}}

{    "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob" , "age":10   }  }

Helper Example: #compare

 {{#compare name "!=" "Bob"}}

Hi {{name}}

{{else}}

 Dear Bob

{{/compare}}

{    "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Jane" , "age":10   }  }

Helper Example: #equals

 {{#equals name "Bob"}}   

      Dear {{name}}   

{{else}} 

      Hi {{name}}   

{{/equals}} 

{    "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob"    }  }

Helper Example: #lessThan

{{#lessThan  age 12}}

    Welcome {{name}}!

  {{else}}

    Sorry {{name}}, This is kids arena

  {{/lessThan}}

{    "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob" , "age":10   }  }

Helper Example: #lessThanOrEquals

{{#lessThanOrEquals age 12}}

    Welcome {{name}}!

  {{else}}

    Sorry {{name}}, This is kids arena

  {{/lte}}

{    "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob" , "age":10   }  }

Helper Example: #greaterThan

{{#greaterThan  age 12}}

    Welcome {{name}}!

  {{else}}

    Hey {{name}}, you are under age

  {{/greaterThan }}

{    "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob" , "age":10   }  }

Helper Example: #greaterThanOrEquals

{{#greaterThanOrEquals age 12}}

    Welcome {{name}}!

  {{else}}

    Hey {{name}}, you are under age

{{/greaterThanOrEquals }}

{    "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob" , "age":10   }  }

Helper Example: #when

{{#when name "!=" "Bob"}}

 Hi {{name}}

{{else}}

Dear Bob

{{/when}}

{    "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Jane" , "age":10   }  }

Helper Example: #contains

{{#contains friends "Bob"}}

      Hi {{this}}

 {{/each}}

{    "to": "[email protected]somedomain.com",    "placeholders": { "friends":["Bob","John","Jack"]  }  }

Helper Example: #and

{{#and great magnificent}}

Bob{{else}}Jane

{{/and}}

{    "to": "[email protected]somedomain.com",    "placeholders": { "great": true, "magnificent": true }  }

Helper Example: #formatNumber

{{#formatNumber price}} {{/formatNumber}}

{    "to": "[email protected]somedomain.com",    "placeholders": { "price":10000 }  }

Helper Example: #isTruthy

{{#isTruthy Male}}

Hi Bob

{{else}}

Hi Jane

{{/isTruthy}}

{    "to": "[email protected]somedomain.com",    "placeholders": { "Male": true }  }

Helper Example: #isFalsey

{{#isFalsey Male}}

Hi Bob

{{else}}

Hi Jane

{{/isFalsey}}

{    "to": "[email protected]somedomain.com",    "placeholders": { "Male": true }  }

Helper Example: #ifEven

{{#ifEven age}}

Hi Bob

{{else}}

Hi Jane

{{/ifEven}}

{    "to": "[email protected]somedomain.com",    "placeholders": { "age": 20 }  }

Helper Example: #ifOdd

{{#ifOdd age}}

Hi Bob

{{else}}

Hi Jane

{{/ifOdd}}

{    "to": "[email protected]somedomain.com",    "placeholders": { "age": 20 }  }

Helper Example: #ifNth

{{#ifNth age balance}}

Hi Bob

{{else}}

Hi Jane

{{/ifNth}}

{    "to": "[email protected]somedomain.com",    "placeholders": { "age": 20, "balance": 20000 }  }

Helper Example: #is

{{#is name "Bob"}}

Dear {{name}}

{{else}}

Hi {{name}}

{{/is}}

{    "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob" , "age":10   }  }

Helper Example: #isnt

{{#isnt name "Bob"}}

Dear {{name}}

{{else}}

Hi {{name}}

{{/isnt}}

{    "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob" , "age":10   }  }

Helper Example: #neither

{{#neither great magnificent}}

A{{else}}B

{{/neither}}

{    "to": "[email protected]somedomain.com",    "placeholders": { great: true, magnificent: false }  }

Helper Example: #not

{{#not great}}

A {{else}} B

{{/not}}

{    "to": "[email protected]somedomain.com",    "placeholders": { great: true, magnificent: false }  }

Helper Example: #or

{{#or great magnificent}}

A

{{else}}

B

{{/or}}

{    "to": "[email protected]somedomain.com",    "placeholders": { great: true, magnificent: false }  }

Helper Example: #unlessGt

{{#unlessGt physics chemistry}}

Hi {{name}}

your score in Physics :{{physics}}

{{else}}

Hi {{name}}

your score in Chemistry : {{chemistry}}

{{/unlessGt}}

{   "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob" , "physics": 70 , "chemistry": 75 }  }

Helper Example: #unlessLt

{{#unlessLt physics chemistry}}

Hi {{name}}

your score in Physics : {{physics}}

{{else}}

Hi {{name}}

your score in Chemistry : {{chemistry}}

{{/unlessLt}}

{   "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob" , "physics": 70 , "chemistry": 75 }  }

Helper Example: #unlessGteq

{{#unlessGteq physics chemistry}}

Hi {{name}}

your score in Physics : {{physics}}

{{else}}

Hi {{name}}

your score in Chemistry : {{chemistry}}

{{/unlessGteq}}

{   "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob" , "physics": 70 , "chemistry": 75 }  }

Helper Example: #unlessLteq

{{#unlessLteq physics chemistry}}

Hi {{name}}

your score in Physics : {{physics}}

{{else}}

Hi {{name}}

your score in Chemistry : {{chemistry}}

{{/unlessLteq}}

{   "to": "[email protected]somedomain.com",    "placeholders": {    "name": "Bob" , "physics": 70 , "chemistry": 75 }  }

bulkId

string

The ID uniquely identifies a group of Email requests. This filter will enable you to query delivery reports for all the messages with the same bulk id using just one request.

messageId

string

Message ID for which report is requested.

limit

int

Maximum number of reports.

GET /email/1/reports