Overview

API calls allow any 3rd party system to interact with our system. There are several ways to make an API call. You can make API calls with programming languages, command line tools, API client frameworks, and others.

In this article, we will be using API client frameworks, which is Postman. You can download Postman here.

Once you have download the software, you will see this screen

Here, you will be making your API calls. To get started right away, click on workspaces > my workspace, or feel free to create a new workspace.

How to start making API calls?

Before you start, In some cases, you would need your token. You can get it by going into settings > LinkedIn account settings > scroll down and you will see Account API token

Hover over the collection name until you see the three dots, click them and click on add request.
After clicking, add request, you will see an interface. Start by placing the URL where we are going to be making the request to. In this case, we will be making the request to https://app.salesflow.io/api/statistics/GetCampaignStatistics but this can change depending on the request.
Once placing the URL, we need to enter the parameters. We are getting campaign statistics, and this request requires accountId, campaignId, and token in the parameters tab. To add the parameters, simply type the name of the parameter in the key field.

So far, it should look like this
After entering those values, click send, and you should get a 200 OK status as below
Once you click send, the info will be shown

What actions can I make with API calls in Salesflow?

Currently, the actions available for API calling are:

Get campaign statistics
Import Member
Update Contact
GetContact (by memberId)
Get Contact (by public identifier)
Delete Contact
ListContacts (by public identifiers)
List Contacts (by campaignID)
List Campaigns

Get Campaign Statistics

This method retrieves campaign statistics for a given campaignId

Endpoint: https://app.salesflow.io/api/statistics/GetCampaignStatistics

Method: GET

Parameters

accountId – selected accountId

campaignId – selected campaignId

token – API token, obtained for selected accountId

Example:

https://app.salesflow.io/api/statistics/GetCampaignStatistics?accountId=56456&campaignId=100706&token=RcchbP2dVNGBxSj3

The result will be

Import Member

This method allows to add a new contact (campaign member) to a given campaign (the same can be done with CSV import feature)

Endpoint: https://mvc.salesflow.io/api/members/Import

Method: GET

Parameters:

accountId – selected accountId

campaignId – selected campaignId

token – API token, obtained for selected accountId

linkedInUrl – LinkedIn profile URL of a contact to be added

(optional): firstName, lastName, occupation, location

The result will be

Update Contact

This method allows to update an existing contact (campaign member), meaning to change the existing details.

Endpoint: https://mvc.salesflow.io/api/members/(insert member ID)

Method: POST

Parameters:

memberId – selected memberId

accountId – selected accountId

token – API token, obtained for selected accountId

Example: https://mvc.salesflow.io/api/members/16659367?accountId=27845&token=mULTzTsfweVofsYYq7

Body Parameters

Result

GetContact (by memberId)

This method allows to get contact (campaign member), and to display all the information about it.

Endpoint: https://mvc.salesflow.io/api/members/{memberId}
Method: GET

Parameters:

memberId – selected memberId
accountId – selected accountId
token – API token, obtained for selected accountId

example: https://mvc.salesflow.io/api/members/161468367?token=mULTzTsdxlVofsYYq7&accountId=27452

The result will be

GetContact (by public identifier)

This method allows to get contact (campaign member), and to display all the information about it, but instead of a memberId it uses the public identifier.

Endpoint: https://mvc.salesflow.io/api/members/
Method: GET