Email API

Our Email API supports sending Email messages for Business. The API can handle single or large number of messages.

Fact Sheet

Feature	Support	Remark
Text Messages	Yes	The maximum length of the message must be less than 25 MB including media and must be UTF-8 encoded message
Media	Yes	File Name should end with proper extension. Multiple media files are allowed per message and must be base64 encoded. The size of the media files including the message content should not exceed 25MB.
Media: images	Yes	Maximum size should be less than 25 MB including other attachments and text content.
Media: Audio	No	Audio files are not supported as of now.
Media: Video	No	Video files are not supported as of now.
Media: Documents	Yes	Maximum size should be less than 25 MB including other attachments and text content.
HTML content	Yes	Maximum size of the content should be less than 25MB including other attachments and text content.
Text content	Yes	Maximum size of the content should be less than 25MB including other attachments and text content.
CC	Yes	Maximum number of CCs including To and BCC should be less than 50.
BCC	Yes	Maximum number of BCCs including To and BCC should be less than 50.
To	Yes	Maximum number of Tos including To and BCC should be less than 50.

Sending Emails

Email API uses from (fromName) and to (toAddresses) email address for sending Emails. The API also requires logical account of the consumer (fromAddressId).

The example below shows the simplest Email message request.

{
  "fromAddress": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fromName": "[email protected]",
  "replyToAddress": "",
  "replyToName": "",
  "toAddresses": [
    {
      "toAddress": "[email protected]",
      "toName": "Robert Vadra"
    }
  ],
  "ccs": [
    {
      "emailAddress": "[email protected]"
    }
  ],
  "bccs": [
    {
      "emailAddress": "[email protected]"
    }
  ],
  "subject": "An example test email",
  "htmlBody": "<p>Just a test email</p><img src=\"cid:cat_image\"/>",
  "textBody": "",
  "emailKind": 0,
  "attachments": [
    {
      "fileName": "cat.jpeg",
      "data": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD3+iiigD//2Q==",
      "contentType": "image/jpeg",
      "contentId": "cat_image"
    }
  ],
  "customerReference":""
}