Frequently Asked Questions



How do I access the Benchmark Email RESTful API’s?

To access the Benchmark Email RESTful API’s you must have a Benchmark account. Our free plans also allow you to access to the Benchmark RESTful API's.

We assume that you will have the technical skills to use the API's to integrate your application/website with our RESTFful API's. If you don't have the technical expertise, you would need to hire a developer to use the RESTful API’s.

To view or access our RESTful API’s please visit the following URL, if you need to access the Legacy API’s please use the same link and scroll to the bottom of the page.

To view the documentation related to the API's please visit the following URL. http://www.benchmarkemail.com/API/Library

You will need to have your API KEY to use the RESTful API’s, please see instructions below on how to obtain your key.

  1. Log in to your Benchmark account.
  2. Click on your username on the right-side of the page and select Integrations.
  3. On the left-hand side menu, click on API Key.



You have successfully accessed your Benchmark Email API Key.

If you have additional questions, please feel free to contact our support team via Email, LiveChat or Phone.

What are the Benchmark Email Legacy APIs?
The Benchmark Email Legacy API is a powerful tool that allows you to integrate your database programs with our system. Users managing subscriptions or message content on their own system may use the Legacy API to transfer data from their internal system to their Benchmark Email account.

Benefits
  1. Easily push contact information from your website or software to your Benchmark Email contact list
  2. Create and manage contact lists. Easily to export existing contacts to your system
  3. Create campaigns with content from your site. Send test emails to your own accounts without having to actually login to Benchmark Email website
  4. Get performance summaries for your previous email campaigns
  5. Pull data for campaigns and store it on external systems
Also, You can now easily manage your lists, emails and campaign reports using our RESTful API. You can connect into our API using XML-RPC.

The Legacy API is broadly divided into four categories:
  1. Campaign Related Methods
  2. Contact List Related Methods
  3. Reports Related Methods
  4. Security Related Methods
Contact List Related Methods
These functions allow you to create, subscribe, unsubscribe, update and export your contact details.

Campaign Related Methods
These functions allow you to create, copy and update your email campaigns. You can now even schedule and test emails in your account.

Reports Related Methods
These functions allow you to get all the statistics associated with your email campaigns. You can easily pull the data from the opens, bounces and forwarded emails.

Security Related Methods
These functions allow you to generate and manage your tokens. Use these security tokens to access the above methods without having to login to your Benchmark Email account.

View our Legacy API Library for more details. To view our new RESTful API’s Click Here.

For API related questions, see API help.
How do I add contacts from my website to my Benchmark Email contact list?
You can use the API to add a contact from your website to your Benchmark Email list.

We recommend you store the ID of the contact list in your code. You can fetch the contact list ID using the listGet method.

To save contacts from your website/database into your Benchmark Email list use the listAddContacts method.

To remove a contact from the list use the listDeleteEmailContact method.
How can I integrate my application/website with Benchmark Email?
You can now create contact lists, manage your contacts, send emails, view reports from your website/application by using the Benchmark Email APIs. You would have to have some programming experience to implement the API methods.

To know about the API visit the URL http://www.benchmarkemail.com/API/Library
How do I send an email to newly added contacts?
If you want to send a welcome email to your recently added subscribers to your site, you can do so using a combination of our API's and Autoresponders.

You would first need to create a Autoresponder for the contact list you are going to add the contacts to. You then need to create a "zero" day email which you want to send to your subscribers.

When you add the subscribers using the API method listAddContacts, the "zero" day email will be sent to the contacts.

You can also use personalization in the email, if you have given the extra field information when saving the contact using the API.
What is the difference between making global and block changes?

Global colors changes apply to the entire section within an email. This can affect multiple blocks within the same area. For example, "Body Background" will apply the changes to the main area of the email. This could affect all blocks within the area (provided the blocks have not been assigned background colors). Block changes apply only to the block chosen.

Block changes, however, will be given preference over global changes. For example, if the global color for the footer is black, but the footer block is assigned a background of white, the email will appear with the white background instead of the black one.

How do I add additional sections (articles, promotions, etc.) to my emails?
  1. Open the email that you want to add sections to.
  2. Click on the link "Add Sections" on the left-hand side.
  3. Choose the type of section you want to add to your email. Your options will be based on the email template you're using.
  4. Add in the content for your new section.
  5. If you want to create a copy of your section, click on the "Copy" icon in section.
Notes:
  • When you add a section, it will appear in the default stylesheet, along with the font color. If you want to make a copy of the section with all the formatting intact, use the Copy Section option. By using the Copy Section option, the style and font color will be copied over to the new section.
Where do I get additional support?
You can contact us by using this form

Please be as descriptive as possible. We can assist you better if you provide us code examples that you are trying to implement.
Why are contacts not added to my list when I use the listAddContacts method?
Some of the common reasons why the contacts are not added to the list would be:
  • The contact has not clicked on the confirmation email. You can check this by clicking on the "Not Opted-in Yet" link in the contact listing
  • The contact could be in your Master Unsubscribe List
  • The contact could be already present in your list
Why do I get this message: "Too many API calls detected?"
You will receive this error if you have tried to log in with an invalid token/password at least five times within two minutes.

This requires a "cooling" time of 10 minutes, where any attempts to log in will be rejected. Before attempting to log in again, you will have to verify that your login/password is correct.
What are the best practice recommedations for using the API?
We recommend these practices while using the API, which are:
  • Make sure you are using valid tokens. Failure to do so might lead you to be locked out for 10 minutes
  • Try to store authenticated tokens and reuse them, instead of using login() for each method call
  • Please make use of the batch sizes when fetching bulk results. All our bulk fetching methods like emailGet, listGet, reportGet have the option to fetch specific pages of results. Trying to import very large amounts of data might lead to timeouts.
  • Do not try to create email campaigns for an individual contact. This is something we do not encourage.
In case you are facing any technical issues, please feel free to contact us. If you can provide some sample code, it will help us resolve the issues more effectively.
Benchmark Email RESTful APIs
In a wonderful world, all things would be automated and with today’s technology, it’s getting easier to do it. By using API’s you can get information without even login into your Benchmark Account.  Let’s dive in and learn some common terms of API’s.

What is REST


REST is an acronym for REpresentational State Transfer. REST is an architectural style that defines a set of constraints and properties based on HTTP. When HTTP is used, as is most common, the operations available are GET, POST, PATCH, DELETE, and other predefined CRUD HTTP methods. Benchmark’s RESTful API helps all the users to create 3rd party integrations. These integrations can be helpful to get list details, upload lists, push data from your platform to your Benchmark account and even uploading email campaigns. In order to use it, following are the HTTP methods available on the Benchmark’s RESTful Page.

     
GET POST PATCH DELETE
The HTTP GET method is used to read or retrieve a representation of a resource. GET requests must be safe and idempotent, meaning regardless of how many times it repeats with the same parameters, the results are the same. The POST verb is utilized to create new resources. Often POST is used to create a new entity, but it can also be used to update an entity. Update only the specified fields of an entity at a URL. A PATCH request is idempotent too as GET request. Request that a resource be removed, however, the resource does not have to be removed immediately. It could be an asynchronous or long-running request.


If you have the technical expertise to use the API’s we encourage you to do so. However, if you don't have the technical expertise, you would need to hire a developer to use the API’s. The above mentioned HTTP methods or request types are listed on the left hand side of the page in categories along with the methods.



Once a method is selected, details regarding the same are populated with the parameters, and the right side of the page will provide the sample code. There is an option to select the preferred language from the dropdown to get the code.




To test and run the code, developers can use the “Run in Postman” button on the top-right corner.


To visit the API's, please visit the following URL. https://developer.benchmarkemail.com