Send fully featured email

from	string Email address with optional sender name. Note: This field is required if `templateId` is not present.
to required	Array of strings <= 1000 Email address of the recipient in a form of `To="john.smith@somecompany.com"`. As optional feature on this field, a specific placeholder can be defined whose value will apply only for this destination. Given `To` value should look like: `To= {"to": "john.smith@somecompany.com","placeholders": {"name": "John"}}` `To= {"to": "alice.grey@somecompany.com","placeholders": {"name": "Alice"}}`. Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.
cc	Array of strings <= 1000 CC recipient email address. As optional feature on this field, a specific placeholder can be defined whose value will apply only for this destination. Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.
bcc	Array of strings <= 1000 BCC recipient email address. As optional feature on this field, a specific placeholder can be defined whose value will apply only for this destination. Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.
subject	string [ 1 .. 1000 ] Message subject. Note: This field is required if `templateId` is not present.
text	string Body of the message.
html	string HTML body of the message. If `html` and `text` fields are present, the `text` field will be ignored and `html` will be delivered as a message body.
ampHtml	string Amp HTML body of the message. If `ampHtml` is present, `html` is mandatory. Amp HTML is not supported by all the email clients. Please check this link for configuring gmail client https://developers.google.com/gmail/ampemail/.
templateId	integer <int64> Template ID used for generating email content. The template is created over Infobip web interface or via the Infobip Templates API. If `templateId` is present, then `html` and `text` values are ignored. Note: `templateId` only supports the value of `Broadcast`. `Content` and `Flow` are not supported.
attachment	Array of strings <binary> File attachment.
inlineImage	Array of strings <binary> Allows for inserting an image file inside the HTML code of the email by using `cid:FILENAME` instead of providing an external link to the image.
intermediateReport	boolean The real-time Intermediate delivery report that will be sent on your callback server.
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 [ 0 .. 4000 ] Additional client data that will be sent on the notifyUrl.
track	boolean Default: true Enable or disable open and click tracking. Passing true will only enable tracking and the statistics would be visible in the web interface alone. This can be explicitly overridden by `trackClicks` and `trackOpens`.
trackClicks	boolean This parameter enables or disables track click feature. Note: Option to disable click tracking per URL is available. For detailed usage, please refer to the documentation.
trackOpens	boolean This parameter enables or disables track open feature.
trackingPixelPosition	string This parameter specifies the position of the open tracking pixel within the email content. Allowed values are `TOP` and `BOTTOM`. If no value is provided, the default is `TOP`.
trackingUrl	string The URL on your callback server on which the open and click notifications will be sent. See Tracking Notifications for details.
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. (Optional Field)
messageId	string The ID that uniquely identifies the message sent to a recipient. (Optional Field)
campaignReferenceId	string The ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns.
replyTo	string Email address to which recipients of the email can reply.
defaultPlaceholders	string General placeholder, given in a form of json example: `defaultPlaceholders={"ph1": "Success"}`, which will replace given key `{{ph1}}` with given value `Success` anywhere in the email (subject, text, html...). In case of more destinations in `To` field, this placeholder will resolve the same value for key `ph1`.
preserveRecipients	boolean Default: false If set to `true`, the `to` recipients will see the list of all other recipients to get the email and the response will return only one `messageId`. Otherwise, each recipient will see just their own email and the response will return a unique `messageId` for each email recipient.
sendAt	string <date-time> To schedule message at a given time. Time provided should be in UTC in the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ` and cannot exceed 30 days in the future.
landingPagePlaceholders	string Personalize opt out landing page by inserting placeholders. Insert placeholder or tag while designing landing page.
landingPageId	string The ID of an opt out landing page to be used and displayed once an end user clicks the unsubscribe link. If not present, default opt out landing page will be displayed. Create a landing page in your Infobip account and use its ID, e.g., `1_23456`.
templateLanguageVersion	string Default: "1" Specifies template language version that will be used in the current message template. Use version 1 for previous version of template language. Use version 2 for features of the new template language. If not present version 1 will be used as default version.
clientPriority	string Adds a priority rating to this email message. Allowed values are `HIGH`, `STANDARD` and `LOW`. Messages with a higher priority value sent by your account are prioritized over messages with a lower priority value sent by your account. If no priority value is provided, messages will be treated with `STANDARD` priority by default.
applicationId	string Required for application use in a send request for outbound traffic. Returned in notification events.
entityId	string Required for entity use in a send request for outbound traffic. Returned in notification events.
headers	string Additional email headers for customization that can be provided in a form of JSON. Example: `headers={"X-CustomHeader": "Header value"}`. There are a few exceptions of headers which are not adjustable through this option: `To`, `Cc`, `Bcc`, `From`, `Subject`,`Content-Type`, `DKIM-Signature`, `Content-Transfer-Encoding`, `Return-Path`, `MIME-Version`

Responses

200

Successful Request

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Request samples

Payload

Content type

multipart/form-data

Example

Send fully featured email using curl

Copy

curl --request POST 'https://{base_url}/email/3/send' \
--header 'Authorization: Basic {username:password}' \
--form 'from="Jane Smith <jane.smith@somecompany.com>"' \
--form 'to="john.smith@somedomain.com"' \
--form 'to="alice.smith@somedomain.com"' \
--form 'to="{\"to\": \"alice.grey@somecompany.com\",\"placeholders\": {\"name\": \"Alice\"}}"' \
--form 'cc="{\"to\": \"jane.grey@somecompany.com\",\"placeholders\": {\"name\": \"Jane\"}}"' \
--form 'replyTo="all.replies@somedomain.com"' \
--form 'subject="Mail subject text and placeholder ph1"' \
--form 'text="Dear {{name}}, this is mail body text with placeholders in body {{ph1}} and {{ph2}}"' \
--form 'html="<h1>Html body</h1><p>Rich HTML message body.</p>"' \
--form 'attachment="@files/image1.jpg"' \
--form 'bulkId="customBulkId"' \
--form 'intermediateReport="true"' \
--form 'defaultPlaceholders="{\"ph1\": \"Success\", \"ph2\": \"Example\"}"' \
--form 'headers="{\"X-CustomHeader\": \"Header value\"}"' \
--form 'notifyUrl="https://www.example.com/email/advanced"' \
--form 'notifyContentType="application/json"' \
--form 'trackClicks="true"' \
--form 'trackOpens="false"' \
--form 'trackingPixelPosition="TOP"' \
--form 'callbackData="DLR callback data"'

Response samples

Content type

application/json

Example

Example for single message

Copy

Collapse all


{"bulkId": "snxemd8u52v7v84iiu69",
"messages": 
[
{"to": "john.smith@somecompany.com",
"messageId": "jgzra46v9zi1ztvd62t5",
"status": 
{"groupId": 1,
"groupName": "PENDING",
"id": 26,
"name": "PENDING_ACCEPTED",
"description": "Message accepted, pending for delivery."
}
}
]
}