Send Fully Featured Email
Query
Comma-separated response fields to include.
Body
Email address with optional sender name. Note: This field is required if `templateId` is not present.
Email address of the recipient in a form of `To="[email protected]"`. 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": "[email protected]","placeholders": {"name": "John"}}` `To= {"to": "[email protected]","placeholders": {"name": "Alice"}}`. Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.
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 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.
Message subject. Note: This field is required if `templateId` is not present.
Body of the message.
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.
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/.
Template ID used for generating email content. The template is created over Infobip web interface or via the [Infobip Templates API](https://www.infobip.com/docs/api/channels/email/templates). 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.
File attachment.
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.
The real-time Intermediate delivery report that will be sent on your callback server.
The URL on your callback server on which the Delivery report will be sent.
Preferred Delivery report content type. Can be `application/json` or `application/xml`.
Additional client data that will be sent on the notifyUrl.
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`.
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](https://www.infobip.com/docs/email/email-tracking-and-analytics/email-tracking-types#disable-click-tracking-on-urls-url-clicks).
This parameter enables or disables track open feature.
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`.
The URL on your callback server on which the open and click notifications will be sent. See [Tracking Notifications](https://www.infobip.com/docs/email/email-over-api/tracking-notifications) for details.
The ID that uniquely identifies the sent bulk. 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)
The ID that uniquely identifies the message sent to a recipient. (Optional Field)
The ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns.
Email address to which recipients of the email can reply.
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`.
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.
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.
Personalize opt out landing page by inserting placeholders. Insert placeholder or tag while designing landing page.
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`.
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.
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.
Required for application use in a send request for outbound traffic. Returned in notification events.
Required for entity use in a send request for outbound traffic. Returned in notification events.
Additional email headers for customization that can be provided in a form of JSON. For example, you can override List-Unsubscribe header and provide your own custom one: `headers={"List-Unsubscribe": "your unsubscribe link", "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`
The ID of the IP Pool which will be used for sending.
Set to true to skip [passive email storage](https://www.infobip.com/docs/email/email-storage-and-retrieval/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](https://www.infobip.com/docs/email/email-storage-and-retrieval/active-email-storage) (short-term storage used for troubleshooting or support). If `false` or not set, the account-level setting is used.