Public
Documentation Settings

Benchmark Email RESTful API v3.0

Why use APIs

APIs can be used to build our service into your pre-existing workflow or platform for getting report data, sending emails, building list and more. Whether you want make API calls yourself to speed up a process on basic information or complex flows that you hand to your developers to implement, our APIs can support your approach.

Prerequisites

  • An HTTP library in your own coding language or an HTTP app such as postman, to make API calls.
  • Use the base path of https://clientapi.benchmarkemail.com.
  • Use your Admin API Token, found here, from your Benchmark Email account. Place it in your request headers, as well as the correct Content-Type header for a respective request (see ex. 01).
    • Any Benchmark Email account type provides free API usage (see limitations below).
    • Don't have an account yet? You can Sign Up For Free.
javascript
// (ex. 01) Example of headers with API Token for a GET request in python3
headers = { 'AuthToken': "{{YOUR_BENCHMARK_EMAIL_API_TOKEN_HERE}}" , 'Content-Type': 'application/json' }

Use Cases and Solutions

For specific solutions, see our github page for Use Cases and Solutions.

Note

You will see some of our endpoint examples, below, using mustaches/curly braces, "{{value}}," in various places. These are placeholders. You will remove and replace the entire placeholder, {{ }} with your actual value for the given scenario/request (see ex. 02)

javascript
// (ex. 02) Our example provided shows:
"AuthToken: {{Authentication Token}}"
// Your actual value, ABC123, will replace the above, but use your Token Value, such as:
"AuthToken: ABC123"

Limitations

Our APIs give you a limit of 500 calls per 2 minutes and 60,000 calls total per day.