Send Email Messages

Email address with optional sender name.

Note: This field is required if templateId is not present.

An array of destination objects for where messages are being sent. A valid destination is required.

Note: Maximum number of recipients is 1000 overall including to, cc and bcc field.

Message subject.

Note: This field is required if templateId is not present.

The message's body in HTML format. If both html and text fields are included, the text field will be disregarded, and the message will be sent using the html content.

The message's body in AMP HTML format. If you include ampHtml, you must also include html, which will be displayed if AMP is not supported. Keep in mind that not all email clients support AMP HTML. For guidance on configuring the Gmail client, please visit this link: https://developers.google.com/gmail/ampemail/ .

The Template ID with predefined email content created through the Infobip web interface or API. When templateId is specified, the html and text fields will be disregarded.

Note: templateId only supports the Broadcast value; Content and Flow templates are not supported.

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.

General placeholders: {"ph1": "Success"} will replace the key {{ph1}} with the value Success throughout the email, including the subject, text, and HTML. If there are multiple recipients in the To field, this placeholder will use the same value for the key ph1 for all recipients.

Personalize Opt-Out Landing Page by inserting placeholders. Insert placeholder or tag while designing landing page. Value should be defined as: {"unsubscribe": "Unsubscribe"}

The Opt-Out Landing Page ID specifies the page to be displayed when an end user clicks the unsubscribe link. If the ID is not provided, the default opt-out landing page will be used. Create a landing page over Infobip web interface and use its ID, for example, 1_23456.

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

Platform options. For more details, see documentation.

Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the from property. The exact time of the day to end sending messages can be defined using the to property. Properties from and to should be both provided with the minimum 1 hour difference or omitted.

Preferred delivery report content type, application/json or application/xml.

Email storage options per message.

Set to true to skip passive email storage (long-term storage used for compliance, legal, or audit purposes). If false or not set, the account-level setting is used.

Set to true to skip active email storage (short-term storage used for troubleshooting or support). If false or not set, the account-level setting is used.

Date and time when the message is to be sent. Used for scheduled messages. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ, and can only be scheduled for no later than 5 days in advance.

Sets up URL shortening and tracking feature.

Enable or disable open and click tracking. Passing true will only enable tracking and the statistics will be visible in the web interface alone. This can be explicitly overridden by trackClicks and trackOpens.

The URL on your callback server on which the open and click notifications will be sent. See Tracking Notifications for details.

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.