Exploring Our API

At ActiveCampaign we want our users to interact with the software in any way they wish. Although we work hard to make our standard interface as usable and friendly as possible, sometimes there are things that are missing or not as easy to configure. With software development it is difficult to please every user.

Our API allows developers to craft their own interface, processes, and experience that utilize the power of ActiveCampaign within their own applications and websites. To make this easier, we are creating an “API Explorer” that users can access within the software and fully interact with the API using real data and examples.

Check it out under your settings, API section:

Screenshot of API Explorer

You can simulate API requests through this simple interface which also shows you all relevent information you’ll need to make API requests through your own applications and websites.

The basic idea is to choose a method and supply the necessary parameters. Then hit the “View API Response” button to see the actual response, or to test it (which only shows the parameters you would include with the request, in case you don’t want to update live data).

Screenshot of API Explorer

Below is some more information and screenshots for each section.

Request URL: The URL you request/submit to when getting or posting data.

Screenshot of API Explorer

You can use this URL in any programming language where you can submit HTTP requests (to send or receive data from other servers).

Method Parameters: All available parameters that can be included with the request.

Screenshot of API Explorer

Parameters are the specific settings or values needed to achieve the request. Think of them as the same fields you fill out in our standard admin interface when creating a campaign. For example: campaign name, type, lists, message used, etc.

Response: The actual response that comes back from the server after submitting a request.

Screenshot of API Explorer

The response always contains a result_code which tells you whether the request succeeded or failed. It also includes extra information related to the request, such as the new unique ID created (for example, when creating a subscriber or campaign), which you can use in subsequent requests.

Also, above we are receiving JSON-formatted data back. You can also receive XML or serialized data.

Request and Parse: Example using our PHP library on how to make the request and parse the response.

Screenshot of API Explorer

We provide the exact code needed to make the request and read the response. You can copy all (or portions) of this into your own application for getting set up very quickly.

Our goal with the API is to get developers up and running quickly, while providing extensive documentation and examples so issues or problems can be discovered and fixed easily.

Stay tuned for future developments and changes to our API Explorer as we continue to improve the interface and add new API methods and parameters. Let us know if you have any questions or problems.

Enjoy this post? Subscribe to be notified of future posts.

Connect