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 or use it online.
Once you have downloaded 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 will 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
This method retrieves campaign statistics for a given campaignId
Method: GET
Parameters
accountId – selected accountId
campaignId – selected campaignId
token – API token, obtained for selected accountId
isForceRequest = [this value must be true to return the data]
Example:
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)
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
firstName, lastName, occupation, location [Optional]
customFields: Array of strings for custom fields [Optional]
Example: https://mvc.salesflow.io/api/members/Import?campaignId=YOUR_CAMPAIGN_ID&accountId=YOUR_ACCOUNT_ID&token= YOUR_API_TOKEN&linkedInUrl=CONTACT_LINKEDIN_URL&firstName=CONTACT_FIRST_NAME&lastName=CONTACT_LAST_NAME&occupation=CONTACT_OCCUPATION&location=CONTACT_LOCATION&customFields=Custom1&customFields=Custom2&customFields=Custom3
The result will be
Update Contact
This method allows to update an existing contact (campaign member), meaning to change the existing details.
Method: POST
Parameters:
memberId – selected memberId
accountId – selected accountId
token – API token, obtained for selected accountId
Example: https://mvc.salesflow.io/api/members/YOUR_MEMBER_ID?accountId=YOUR_ACCOUNT_ID&token=YOUR_API_TOKEN
Body Parameters
Result
GetContact (by memberId)
This method allows you 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/YOUR_MEMBER_ID?token=YOUR_API_TOKEN&accountId=YOUR_ACCOUNT_ID
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
Parameters:
publicIdentifier – member’s public identifier
accountId – selected accountId
token – API token, obtained for selected accountId
Example:
The result will be
Delete Contact
This method allows to delete contact (campaign member), directly from a campaign.
Endpoint: https://mvc.salesflow.io/api/members
Method: DELETE
Parameters:
memberId – selected memberId
accountId – selected accountId
token – API token, obtained for selected accountId
Example: https://mvc.salesflow.io/api/members/YOUR_MEMBER_ID?accountId=YOUR_ACCOUNT_ID&Token=YOUR_API_TOKEN
The result will be
List Contacts (by public identifiers)
This method allows to get a list of available contacts by provided public identifiers.
Method: POST
Query parameters:
accountId – selected accountId
token – API token, obtained for selected accountId
Body parameters
publicIdentifiers: collection of public identifiers
NOTE: public identifiers can't be null or empty, they can have more than 20 elements.
Example
The result will be
List Contacts (by campaignId)
This method allows to get a list of available contacts (campaign members) for a selected campaign.
Method: GET
Query parameters
accountId – selected accountId
campaignId – selected campaignId
token – API token, obtained for selected accountId
Example
List campaigns
This method allows to get a list of available campaigns
Method: GET
Query parameters
accountId – selected accountId
token – API token, obtained for selected accountId
Example
https://mvc.salesflow.io/api/campaigns/list-campaigns?accountId=YOUR_ACCOUNT_ID&token=YOUR_API_TOKEN
The result will be
Start a Campaign
This method allows you to start a campaign.
Method: POST
Query Parameters
campaignId – selected campaignId
accountId – selected accountId
token – API token, obtained for selected accountId
Example
The result will be
List Accounts
This method allows to get a list of accounts by using the API Token.
Method: GET
Query Parameters
token – API token
Example
The result will be
Create Webhook
This method allows you to create a Webhook.
Method: POST
Query Parameters
accountId – selected accountId
token – API token, obtained for selected accountId
Body Parameters
Name – webhook name, required, maximum length = 255
Url – webhook url, required, maximum length = 511
DisableForMutedContacts – optional, nullable boolean, if true – will not get triggered for muted contacts
Example
Request URL: https://mvc.salesflow.io/api/webhooks/create?token=YOUR_API_TOKEN&accountId=YOUR_ACCOUNT_ID
Request Body:
The result will be
Delete Webhook
This method allows you to delete a Webhook.
Method: DELETE
Query Parameters
webhookId – selected webhookId
accountId – selected accountId
token – API token, obtained for selected accountId
Example
The result will be
List Webhooks
This method allows you to get a list of available Webhooks.
Method: GET
Query Parameters
accountId – selected accountId
token – API token, obtained for selected accountId
Example
The result will look like this
AttachedWebhookCampaigns property is a collection which contain next information:
CampaignId – Campaign identifiers
WebhookCampaignId – WebhookCampaignId identifier. This value should be used to detach integration.
RunOn – Selected event type (
MEMBER_CONNECTED,REPLY_DETECTED,INVITATION_WITHDRAWN)
Attach Webhook
This method allows you to attach a webhook to campaign
Method: POST
Query Parameters
accountId – selected accountId
webhookId – selected webhookId
campaignId – selected campaignId
runOn – selected event type (integer)
token – API token, obtained for selected accountId
Property runOn can have next values
1 –
MEMBER_CONNECTED– the system has identified that a given campaign member changed his status to “CONNECTED”2 –
REPLY_DETECTED– the system has identified an incoming message from a given contact. Not called if a given contact is muted7 –
INVITATION_WITHDRAWN– the system has successfully withdrawn an invitation for a given contact.
Note: Every integration can be attached up to 3 times per campaign, but with different “runOn” parameter.
Example
The result should look like this
List contacts by account ID
This method allows you to get all contacts across all campaigns by account ID
Endpoint: https://mvc.salesflow.io/api/
Method: GET
Resource: members/list-contacts-by-accountid
Query Parameters
token – API token, obtained for selected accountId
accountId – selected accountId
updatedFromDate – optional parameter
If UpdatedFromDate is present, the results will contain only members that were updated after the provided date.
Example:
GET https://mvc.salesflow.io/api/members/list-contacts-by-accountid?token=YOUR_API_TOKEN&accountId=YOUR_ACCOUNT_ID
Get analytics by campaign ID
This method allows you to query analytics data by campaign ID
Endpoint: https://mvc.salesflow.io/api/
Method: GET
Resource: analytics/by-campaignid
Query parameters
token – API token of selected account ID
accountId – Selected account ID
campaignId - Selected campaign ID
from - Date
to - Date
Example:
Get analytics by account ID
This method allows you to query analytics data by account ID
Endpoint: https://mvc.salesflow.io/api/
Method: GET
Resource: analytics/by-accountid
Query parameters
token – API token of selected account ID
accountId – selected account ID
from - Date
to - Date
Example:
List incoming messages by campaign ID
This method allows you to query incoming messages by campaign ID
Endpoint: https://mvc.salesflow.io/api/
Method: GET
Resource: messaging/incoming-messages-by-campaignid
Query parameters
token – API token of selected account ID
accountId – Selected account ID
campaignId – Selected campaign ID
from - Date
Example:
You might be interested in