REST API

Adding New REST API Key #

A REST API (also known as RESTful API) is an application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services. FluentCRM provides REST API to manage various kinds of tasks and access FluentCRM data as well. In this tutorial, we will learn about Fluent CRM REST API Management.

Go to FluentCRM Dashboard ➜ REST API ➜ Add New Key

If this is a fresh installation of FluentCRM or you did not add any managers yet you will see a popup saying create a manager similar to below screenshot:

To Add New Manager please visit this documentation: Add a New Manager

Now When you are done adding a FluentCRM Manager and note the email address and then Add a New Key by providing the name of the key and then associating the FluentCRM Manager to it.

After clicking on the Create Button you will be provided with an API Username and an API Password like the below screenshot:

Please keep note of this which will be needed to use the REST API as credentials.

Testing API #

Now we will be testing this REST API access and a few methods below.

We will use a free tool Postman for this testing. Firstly, we need to add authorization and the type is Basic Auth for the authorization where we will be providing the Username and Password generated while creating the REST API key.

Now are ready to go ahead and test our FluentCRM REST API. The API Base URL: https://yourdomain.com/wp-json/fluent-crm/v2

Now we will be listing all the contacts of the FluentCRM by the HTTP Request: GET https://yourdomain.com/wp-json/fluent-crm/v2/subscribers

Now Clicking on Send or requesting the data will send JSON formatted response data like the below screenshot. You will see a status code of 200 OK for a successful request.

Now we will be adding a contact into the FluentCRM by the HTTP Request: https://yourdomain.com/wp-json/fluent-crm/v2/subscribers?first_name=Ibrahim&last_name=Sharif&[email protected]&status=subscribed which provides a few parameters regarding the information of the contact.

This also sends a JSON formatted response giving a message saying that “Successfully added the subscriber.“

To learn more and deep about FluentCRM REST API please visit: https://rest-api.fluentcrm.com/