Send email over API

You can use the Email API (opens in a new tab) as another way of sending emails to your customers.

Prerequisites

To send an email with Infobip, your domain needs to be active in the Infobip system. Verify your email domain on the User Profile in your Infobip account (opens in a new tab).

Send email messages

To send email messages, including sending a simple single message to a single destination or batch sending of personalized messages to many recipients with a single API request, use the Send Email messages (opens in a new tab) API.

Fully-featured email

To send a fully-featured email⁠ - send one or more email messages with attachments to one or more destination addresses. For more details, see Send a Fully Featured Email (opens in a new tab) reference documentation.

Send email to multiple recipients

Send the same email to multiple recipient addresses by including more than one to parameters in the request.

Send an email With multiple attachments

To send an email with more than one attachment, add multiple attachment parameters in the request.

Send email to multiple To, Cc, Bcc recipients

Send the same email to multiple recipient addresses by including more than one to, cc, bcc parameters in the request.

curl


    curl -s --user user:password \
    https://./3/send \
    -F from='Jane Smith ' \
    -F to='[email protected]' \
    -F to='[email protected]' \
    -F cc='[email protected]' \
    -F cc='[email protected]' \
    -F bcc='[email protected]' \
    -F bcc='[email protected]' \
    -F subject='Mail subject text' \
    -F text='Mail body text' \
    --form-string html='Html bodyRich HTML message body.' \
    -F attachment=@files/image1.jpg

Send personalized emails using templates

Send personalized emails by adding placeholder values within the to parameter of the request. If you want to send the message based on a previously defined template, pass the template identifier value in the templateId parameter. To manage Templates, login (opens in a new tab) to the Infobip web interface.

Send email with IP pool ID

IP pool selection allows you to send emails through department-specific IP pools, even when all departments use the same sending domain. This approach offers deliverability, operational, and compliance advantages.

When multiple departments share an IP pool, they also share its sending reputation. If one department’s sending practices harm that reputation, it can affect all other departments. By assigning each department to its own IP pool, you can isolate and protect individual reputations.

To use a specific IP pool for sending, include the ipPoolId parameter in your request to the Send Email Messages (opens in a new tab) API.

Send an email with custom messageID

Send emails with custom messageId by including your unique messageId within the to parameter of the request.

Send emails with dynamic content

There are two supported approaches for sending emails with dynamic content:

Template language (recommended)
1. Use templateLanguageVersion=2 in your API request.
2. Allows more powerful syntax for substitutions, logic, and expressions.
Legacy handlebars helpers
1. Do not set templateLanguageVersion in the API request.
2. Still supported for backward compatibility.

See Send fully featured email (opens in a new tab) API endpoint for the full API reference.

Refer to the sections below to learn more about these two approaches.

Template language

To send emails with dynamic content, use the template language within your HTML content and define placeholder values in the to or default parameter of your request.

You can add any available template language constructs to handle substitutions, conditional statements, or iterations directly in your email template.

For details, see Template language.

Legacy handlebars helpers

Legacy helpers use the familiar {{#helper}} ... {{/helper}} syntax. These are still supported, but we recommend migrating to the new template language for future-proof projects.

Legacy handlebar helper examples

HTML request	To JSON request	Resolved HTML
Helper example: #eq
{{#eq name "Bob"}}    Dear {{name}}   {{else}}   Hi {{name}}   {{/eq}}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob"    }  }	Dear Bob
Helper example: #each
{{#each friends}} Hi {{this}} {{/each}}	{    "to": "[email protected]",    "placeholders": { "friends":["Bob","John","Jack"] }  }	Hi Bob Hi John Hi Jack
Helper example: #unlessEq
{{#unlessEq name "Bob"}} Dear {{name}} {{else}} Hi {{name}} {{/unlessEq}}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob"    }  }	Hi Bob
Helper example: #default
Hi {{name}}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob"    }  }	Hi Bob
Helper example: #gt
{{#gt age 12}} Welcome {{name}}! {{else}} Hey {{name}}, you are under age {{/gt}}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob" , "age":10   }  }	Hey Bob, you are under age
Helper example: #lt
{{#lt age 12}} Welcome {{name}}! {{else}} Sorry {{name}}, This is kids arena {{/lt}}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob" , "age":10   }  }	Welcome Bob!
Helper example: #equalsIgnoreCase
{{#equalsIgnoreCase gender "male"}} Dear Mr {{name}} {{else}} Dear customer {{/equalsIgnoreCase}}	{    "to": "[email protected]",    "placeholders":{    "name": "Bob" , "gender": "MALE"   }  }	Dear Mr Bob
Helper example: #gte
{{#gte age 12}} Welcome {{name}}! {{else}} Hey {{name}}, you are under age {{/gte}}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob" , "age":10   }  }	Hey Bob, you are under age
Helper example: #lte
{{#lte age 12}} Welcome {{name}}! {{else}} Sorry {{name}}, This is kids arena {{/lte}}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob" , "age":10   }  }	Welcome Bob!
Helper example: #compare
{{#compare name "!=" "Bob"}}Hi {{name}}{{else}} Dear Bob{{/compare}}	{    "to": "[email protected]",    "placeholders": {    "name": "Jane" , "age":10   }  }	Hi Jane
Helper example: #equals
{{#equals name "Bob"}}    Dear {{name}}   {{else}}   Hi {{name}}   {{/equals}}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob"    }  }	Dear Bob
Helper example: #lessThan
{{#lessThan age 12}} Welcome {{name}}! {{else}} Sorry {{name}}, This is kids arena {{/lessThan}}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob" , "age":10   }  }	Welcome Bob!
Helper example: #lessThanOrEquals
{{#lessThanOrEquals age 12}} Welcome {{name}}! {{else}} Sorry {{name}}, This is kids arena {{/lte}}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob" , "age":10   }  }	Welcome Bob!
Helper example: #greaterThan
{{#greaterThan age 12}} Welcome {{name}}! {{else}} Hey {{name}}, you are under age {{/greaterThan }}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob" , "age":10   }  }	Hey Bob, you are under age
Helper example: #greaterThanOrEquals
{{#greaterThanOrEquals age 12}} Welcome {{name}}! {{else}} Hey {{name}}, you are under age{{/greaterThanOrEquals }}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob" , "age":10   }  }	Hey Bob, you are under age
Helper example: #when
{{#when name "!=" "Bob"}} Hi {{name}}{{else}}Dear Bob{{/when}}	{    "to": "[email protected]",    "placeholders": {    "name": "Jane" , "age":10   }  }	Hey Jane
Helper example: #contains
{{#contains friends "Bob"}} Hi {{this}} {{/each}}	{    "to": "[email protected]",    "placeholders": { "friends":["Bob","John","Jack"] }  }	Hi Bob
Helper example: #and
{{#and great magnificent}}Bob{{else}}Jane{{/and}}	{    "to": "[email protected]",    "placeholders": { "great": true, "magnificent": true }  }	Hi Bob
Helper example: #formatNumber
{{#formatNumber price}} {{/formatNumber}}	{    "to": "[email protected]",    "placeholders": { "price":10000 }  }	10,000
Helper example: #isTruthy
{{#isTruthy Male}}Hi Bob{{else}}Hi Jane{{/isTruthy}}	{    "to": "[email protected]",    "placeholders": { "Male": true }  }	Hi Bob
Helper example: #isFalsey
{{#isFalsey Male}}Hi Bob{{else}}Hi Jane{{/isFalsey}}	{    "to": "[email protected]",    "placeholders": { "Male": true }  }	Hi Jane
Helper example: #ifEven
{{#ifEven age}}Hi Bob{{else}}Hi Jane{{/ifEven}}	{    "to": "[email protected]",    "placeholders": { "age": 20 }  }	Hi Bob
Helper example: #ifOdd
{{#ifOdd age}}Hi Bob{{else}}Hi Jane{{/ifOdd}}	{    "to": "[email protected]",    "placeholders": { "age": 20 }  }	Hi Jane
Helper example: #ifNth
{{#ifNth age balance}}Hi Bob{{else}}Hi Jane{{/ifNth}}	{    "to": "[email protected]",    "placeholders": { "age": 20, "balance": 20000 }  }	Hi Bob
Helper example: #is
{{#is name "Bob"}}Dear {{name}}{{else}}Hi {{name}}{{/is}}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob" , "age":10   }  }	Dear Bob
Helper example: #isnt
{{#isnt name "Bob"}}Dear {{name}}{{else}}Hi {{name}}{{/isnt}}	{    "to": "[email protected]",    "placeholders": {    "name": "Bob" , "age":10   }  }	Hi Bob
Helper example: #neither
{{#neither great magnificent}}A{{else}}B{{/neither}}	{    "to": "[email protected]",    "placeholders": { great: true, magnificent: false }  }	B
Helper example: #not
{{#not great}}A {{else}} B{{/not}}	{    "to": "[email protected]",    "placeholders": { great: true, magnificent: false }  }	B
Helper example: #or
{{#or great magnificent}}A{{else}}B{{/or}}	{    "to": "[email protected]",    "placeholders": { great: true, magnificent: false }  }	A
Helper example: #unlessGt
{{#unlessGt physics chemistry}}Hi {{name}}your score in Physics :{{physics}}{{else}}Hi {{name}}your score in Chemistry : {{chemistry}}{{/unlessGt}}	{ "to": "[email protected]",    "placeholders": {    "name": "Bob" , "physics": 70 , "chemistry": 75 }  }	Hi Bob your score in Physics : 70
Helper example: #unlessLt
{{#unlessLt physics chemistry}}Hi {{name}}your score in Physics : {{physics}}{{else}}Hi {{name}}your score in Chemistry : {{chemistry}}{{/unlessLt}}	{ "to": "[email protected]",    "placeholders": {    "name": "Bob" , "physics": 70 , "chemistry": 75 }  }	Hi Bob your score in Chemistry : 75
Helper example: #unlessGteq
{{#unlessGteq physics chemistry}}Hi {{name}}your score in Physics : {{physics}}{{else}}Hi {{name}}your score in Chemistry : {{chemistry}}{{/unlessGteq}}	{ "to": "[email protected]",    "placeholders": {    "name": "Bob" , "physics": 70 , "chemistry": 75 }  }	Hi Bob your score in Physics : 70
Helper example: #unlessLteq
{{#unlessLteq physics chemistry}}Hi {{name}}your score in Physics : {{physics}}{{else}}Hi {{name}}your score in Chemistry : {{chemistry}}{{/unlessLteq}}	{ "to": "[email protected]",    "placeholders": {    "name": "Bob" , "physics": 70 , "chemistry": 75 }  }	Hi Bob your score in Chemistry : 75

Send email using MIME format

You can send MIME (Multipurpose Internet Mail Extensions) formatted emails over API. Sending email content using MIME gives you more flexibility for structuring and sending email. For example:

Flexible message formatting
Inline images, HTML, and attachments

To send an email with the content in MIME format, see the Send MIME email (opens in a new tab) API reference documentation.

Email delivery reports

The Email delivery reports (opens in a new tab) method allows you to get one-time delivery reports (DLR) for all sent emails. Email delivery reports provide detailed information and metrics relating to performance all the sent emails. You can set a limit to the number of reports or, for example, target a specific message or campaign.

Delivery reports provide key insights that enable you to optimize workflows, such as creating failover logic or slowing down traffic if delivery performance is not optimal.

Note

The delivery report is returned only once. Additional delivery report requests return an empty collection.

The following are examples to get email delivery reports.

Get reports by Message ID

Use the messageId parameter to specify a specific message.

For example:

GET /email/4/reports?messageId=

Get the initial two delivery reports

Use the limit parameter to define the maximum number of reports.

For example:

GET /email/4/reports?limit=2 HTTP/1.1

Get reports by bulk ID

Use the bulkId parameter to request the unique report.

For example

GET /email/4/reports?bulkId=lrzkq6gatdkxouhrkgni HTTP/1.1

Email messages logs

The Get Email logs (opens in a new tab) method allows you to get logs for email messages. None of the query parameters is mandatory for this request. Any combination of parameters can be used to filter results. Some examples are shown below.

Logs availability

Email logs are available for the last 48 hours only.

Response format

If successful, the response header HTTP status code is 200 OK  and the message logs are returned.

If you try to send a message without authorization, you get a response with HTTP status code 401 Unauthorized.

If you use this method too many times in a short period of time, you receive the 429 Too Many Requests status code. This prevents misusing logs in cases where reports would be more appropriate.

Get logs with multiple message ID filters

The fields from, to, and limit accept a single parameter, which is used to filter response message logs.

Get logs with date range and general status filters

The fields sentSince and generalStatus accept a single parameter, which is used to filter response message logs.

Get logs by bulk ID

To use this method, use the bulkId returned in the response for an email/emails you wish to filter message logs for.

Tracking notifications

Tracking notifications help you monitor how recipients interact with your emails. They provide valuable insights into engagement and deliverability by notifying you about specific events:

Opens - Triggered when a recipient opens your email.
Clicks - Triggered when a recipient clicks any URL within your email.
Unsubscribes - Triggered when a recipient opts out of receiving further emails.
Complaints - Triggered when a recipient marks your email as spam or reports it to their provider.
Late bounces - Triggered when an email that was initially accepted by the recipient’s server later fails delivery.

If you pass a trackingUrl, Infobip will send these notifications back to your system. The notification payload includes structured data about the event, so you can process it automatically and feed it into your reporting, analytics, or suppression workflows.

The following sections show examples of notification payloads for opens, clicks, unsubscribes, complaints, and late bounces.

Open notifications

json

{
  "notificationType": "OPENED",
  "eventId": "8d2f8781-91fc-4473-9b0a-b12b51fafbe6",
  "domain": "some-domain.com",
  "recipient": "[email protected]",
  "sendDateTime": 1704106800000,
  "messageId": "14b734recsf69n8zkao5",
  "bulkId": "ikzzmbhu6223bxkhmyrj",
  "callbackData": "Callback data",
  "recipientInfo": {
    "deviceType": "Phone",
    "os": "iOS 12",
    "deviceName": "Apple"
  },
  "geoLocation": {
    "countryName": "Los Angeles",
    "city": "United States"
  },
  "entityId": "promotional-traffic-entity",
  "applicationId": "marketing-automation-application",
  "campaignReferenceId": "campaign-reference-123"
}

Click notifications

json

 
{
  "notificationType": "CLICKED",
  "eventId": "8d2f8781-91fc-4473-9b0a-b12b51fafbe6",
  "domain": "some-domain.com",
  "recipient": "[email protected]",
  "url": "https://www.somelink.com",
  "sendDateTime": 1704106800000,
  "messageId": "14b734recsf69n8zkao5",
  "bulkId": "ikzzmbhu6223bxkhmyrj",
  "callbackData": "Callback data",
  "recipientInfo": {
    "deviceType": "Phone",
    "os": "iOS 12",
    "deviceName": "Apple"
  },
  "geoLocation": {
    "countryName": "Los Angeles",
    "city": "United States"
  },
  "entityId": "promotional-traffic-entity",
  "applicationId": "marketing-automation-application",
  "campaignReferenceId": "campaign-reference-123"
}

Unsubscribe notifications

json

 
{
  "notificationType": "UNSUBSCRIBED",
  "eventId": "8d2f8781-91fc-4473-9b0a-b12b51fafbe6",
  "domain": "some-domain.com",
  "recipient": "[email protected]",
  "sendDateTime": 1704106800000,
  "messageId": "14b734recsf69n8zkao5",
  "bulkId": "ikzzmbhu6223bxkhmyrj",
  "callbackData": "Callback data",
  "recipientInfo": {
    "deviceType": "Phone",
    "os": "iOS 12",
    "deviceName": "Apple"
  },
  "geoLocation": {
    "countryName": "Los Angeles",
    "city": "United States"
  },
  "entityId": "promotional-traffic-entity",
  "applicationId": "marketing-automation-application",
  "campaignReferenceId": "campaign-reference-123"
}

Complaint notifications

json

 
{
  "notificationType": "COMPLAINED",
  "eventId": "8d2f8781-91fc-4473-9b0a-b12b51fafbe6",
  "domain": "some-domain.com",
  "recipient": "[email protected]",
  "sender": "[email protected]",
  "sendDateTime": 1704106800000,
  "messageId": "14b734recsf69n8zkao5",
  "bulkId": "ikzzmbhu6223bxkhmyrj",
  "callbackData": "Callback data",
  "entityId": "promotional-traffic-entity",
  "applicationId": "marketing-automation-application",
  "campaignReferenceId": "campaign-reference-123"
}

Late bounces notifications

json

 
{
  "notificationType": "LATE_BOUNCE",
  "eventId": "8d2f8781-91fc-4473-9b0a-b12b51fafbe6",
  "domain": "some-domain.com",
  "recipient": "[email protected]",
  "sender": "[email protected]",
  "sendDateTime": 1704106800000,
  "messageId": "14b734recsf69n8zkao5",
  "bulkId": "ikzzmbhu6223bxkhmyrj",
  "callbackData": "Callback data",
  "entityId": "promotional-traffic-entity",
  "applicationId": "marketing-automation-application",
  "campaignReferenceId": "campaign-reference-123"
}

Send email Send email over SMTP