Send an Email

Through Email API, you may send email to multiple contacts, schedule emails and track analytics of such emails. You may use any of the following email content parameters while executing email campaigns:

• Text - plain text content to be sent
• Html - full html content to be sent
• Template – pre-defined templated to be used

Send Simple Text Email

curl -X POST \
'<BASE_URL>&method=email&format=xml&subject=testingemails&to[0][email]=<emailID>&to[0][name]=ABC&from[email]=<emailID>&text=Hi how are you today&from[name]=XYZ'

API Parameter Specifications

The API parameter specifications are described in the following sections.

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Example Responses

1. JSON

{ "status": "OK",
  "data": {
    "0": {
      "id": "1878054-1",
      "email": "xyz@gmail.com",
      "name": ABC,
      "status": "AWAITED-DLR"
    },
    "group_id": 1878054
  },
  "message": "Campaign of 1 emails Submitted successfully."}

2. XML

<api>
    <status>OK</status>
    <data>
        <group_id>1878063</group_id>
        <email>
            <id>1878063-1</id>
            <email>xyz@gmail.com</email>
            <name>abc</name>
            <status>AWAITED-DLR</status>
        </email>
    </data>
    <message>Campaign of 1 emails Submitted successfully.</message>
</api>

• If you have put so many email IDs in a single parameter, then system will pick the last email ID. For eg. To[0][email]= recipient_one@example.com , To[0][email]= recipient_two@example.com To[0][email]= recipient_three@example.com To[0][email]= recipient_four@example.com, then in this case, system will send an email to recipient_four@example.com.
• We need to put email IDs in the following format & sequence only: To[0][email]= recipient_one@example.com , To[1][email]= recipient_two@example.com To[2][email]= recipient_three@example.com To[3][email]= recipient_four@example.com
• Parameters will be be mapped in the following way while sending emails: To[0][email]= recipient_one@example.com & to[0][name]=Recipient One To[1][email]= recipient_two@example.com & to[1][name]=Recipient Two

Send An Email With Attachment

While sending email through the following format, you may also attach files upto 10Mb in either of the formats like xls, pdf, doc, png, jpeg, etc.

curl -X POST \
'<BASE_URL>&method=email&format=xml&subject=testingemails&to[0][email]=<emailID>&to[0][name]=ABC&from[email]=<emailID>&text=Hi how are you today&from[name]=XYZ&files[]=sdfrt12.png'

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Send an Email using Template

Here is an API format to send email using the pre-defined templates created using “Template” feature under Emailer menu. If you use any specific templates, then you may skip Text or HTML parameter i.e. Body of an email as system will pick the template content for body of an email.

curl -X POST \
'<BASE_URL>&method=email&format=xml&subject=testingemails&to[0][email]=<emailID>&to[0][name]=ABC&from[email]=<emailID&from[name]=XYZ&files[]=sdfrt12.png&template[id]=30'

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Send an HTML email

You can apply CSS styles to such HTML content based emails and your outgoing mail will adopt these styles across all recipients.

curl -X POST \
'<BASE_URL>&method=email&format=xml&subject=testingemails&to[0][email]=<emailID>&to[0][name]=ABC&from[email]=<emailID> &from[name]=XYZ&files[]=sdfrt12.png&template[id]=30&html= <div class="form-group"> <label for="password">Password</label> <input type="password" name="password" class="form-control" required="required" placeholder="Enter your password" autocomplete="off" /> <a href="http://alerts.sinfini.com/members/resetpass" id="forgot-password">Forgot?</a> </div>'

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Expected API Error Codes