Need a hand? We've got you covered.

Knowledge Base Home aero-right API aero-right Benchmark Email RESTful APIs

Benchmark Email RESTful APIs

API Updated on August 7, 2019

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

Did this answer your questions?
0 0

Can't find what you're looking for?

Submit a Ticket

view ticket history