Integration

Authentication

Every request to the Mailbindr API requires an API key in the header.

Where to find your API key

The API key will be automatically generated when you create an account. To access your API key, go to Account and then API key.

How to reset your API key

You can reset the API key anytime you want. Click on Create new API key to to generate a new key.

How to use the API key in a request

The header you need to pass is X-Api-Token.

Here is an example of how to use your API key in a request (in Python):

        
import requests
import json

url = "https://backend.mailbindr.app/email/send-email/"

payload = {
    ...
}

headers = {
  'Content-Type': 'application/json',
  'X-Api-Token': 'my_api_key'
}

response = requests.request("POST", url, headers=headers, data=payload)
        
      

API limitations

The API is limited to 5000 requests per minute.

In case you are planing to send more emails then the quote allows, make sure to send the emails in batches and delay further requests by your application.

Plan limits

API requests also vary depending on your plan. Check your plan allowance for the number of API requests on the billing page

Sender limits

Make sure you also read the limitations of your integrated Sender. Mailbindr forwards the requests after processing to you email sender and the limitations of your sender therefore apply as well.

Sending E-Mails

To send an email over the API make sure you set up at least one email sender (see instructions).

For sending emails, you will find in every email template integration instructions with the exact data for the request.

Here is an example how a request could look like (in Python):

        
import requests
import json

url = "https://backend.mailbindr.app/email/send-email/"

payload = json.dumps({
  "identifier": "email_key",
  "receiver": "email@email.com",
  "language": "en",
  "environment": "draft",
  "context": {
    "some_variable": "some_value"
  }
})
headers = {
  'Content-Type': 'application/json',
  'X-Api-Token': 'my_api_key'
}

response = requests.request("POST", url, headers=headers, data=payload)
        
      

In the previous example the environment draft was chosen. This means only emails from members of your team can receive the email for testing purposes. To send emails to the public you have to use either testing or live. For more information about the environment and publishing process see Testing & publishing