NAV
shell javascript

Introduction

Welcome to the SalesBlink API Docs!

You can access SalesBlink API endpoints, to read or add information about sequences and more.

We have language bindings in Shell, and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here" \
  -H "Authorization: your_salesblink_key"

var axios = require('axios');

var config = {
  method: 'get',
  url: 'api_endpoint_here',
  headers: { 
    'Authorization': 'your_salesblink_key'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Make sure to replace your_salesblink_key with your API key.

SalesBlink uses API keys to allow access to the API endpoints.

You can register a new SalesBlink API key from Account Settings.

SalesBlink expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: your_salesblink_key

Lists

Get Lists

curl --location --request GET 'https://run.salesblink.io/api/public/lists' \
--header 'Authorization: your_salesblink_key'

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://run.salesblink.io/api/public/lists',
  headers: { 
    'Authorization': 'your_salesblink_key'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

This endpoint searches for prospect by prospect Email address.

HTTP Request

GET https://run.salesblink.io/api/public/lists

You will receive your lists with their IDs, latest first.

Add Leads to List

curl --location --request POST 'https://run.salesblink.io/api/public/contacts' \
--header 'Authorization: your_salesblink_key' \
--header 'Content-Type: application/json' \
--data-raw '{
  "list_id": "<id_of_list>",
    "contacts": [
        {
            "Email": "[email protected]",
            "First_Name": "John",
            "Last_Name": "Doe"
        },
        {
            "Email": "[email protected]",
            "First_Name": "Jane",
            "Last_Name": "Doe",
            "Phone": "+1 (000) 92899"
        }
    ],
    "remove_duplicates": true
}'

var axios = require('axios');
var data = JSON.stringify({
{
    "list_id": "<id_of_list>",
    "contacts": [
        {
            "Email": "[email protected]",
            "First_Name": "John",
            "Last_Name": "Doe"
        },
        {
            "Email": "[email protected]",
            "First_Name": "Jane",
            "Last_Name": "Doe",
            "Phone_Number": "+1 (000) 92899"
        }
    ],
    "remove_duplicates": true
}
});

var config = {
  method: 'post',
  url: 'https://run.salesblink.io/api/public/contacts',
  headers: { 
    'Authorization': 'your_salesblink_key', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

This endpoint adds a leads to a list.

These fields can be used as variables in your sales outreach sequences.

HTTP Request

POST https://run.salesblink.io/api/public/contacts

Body Parameters

Parameter Description Type
list_id The ID of the list where lead will be added string
contacts Array with leads object
remove_duplicates Default false, it does not add a lead if it exists in list already bool

Remove Lead from List

curl --location --request POST 'https://run.salesblink.io/api/public/contacts/remove' \
--header 'Authorization: your_salesblink_key' \
--header 'Content-Type: application/json' \
--data-raw '{
  "list_id": "<id_of_list>",
    "email": "[email protected]"
}'

var axios = require('axios');
var data = JSON.stringify({
{
    "list_id": "<id_of_list>",
    "email": "[email protected]"
}
});

var config = {
  method: 'post',
  url: 'https://run.salesblink.io/api/public/contacts/remove',
  headers: { 
    'Authorization': 'your_salesblink_key', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

This endpoint removes leads from a list.

HTTP Request

POST https://run.salesblink.io/api/public/contacts/remove

Body Parameters

Parameter Description Type
list_id The ID of the list from where lead should be removed string
email Email Address of the lead to be removed string

Sequences

Get Sequences

curl --location --request GET 'https://run.salesblink.io/api/public/sequences' \
--header 'Authorization: your_salesblink_key'

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://run.salesblink.io/api/public/sequences',
  headers: { 
    'Authorization': 'your_salesblink_key'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

This endpoint retrieves all sequences.

HTTP Request

GET https://run.salesblink.io/api/public/sequences

You will receive a sequence_id for each of the sequence you have access to, you can use this to fetch Activities.

Activity

Get Sent Emails

curl --location --request GET 'https://run.salesblink.io/api/public/sent' \
--header 'Authorization: your_salesblink_key'

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://run.salesblink.io/api/public/sent',
  headers: { 
    'Authorization': 'your_salesblink_key'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

This endpoint retrieves emails sent from your account.

HTTP Request

GET https://run.salesblink.io/api/public/sent

You will receive all sent emails from your account, latest first.

Query Parameters

Parameter Description Type
sequence_id Optional, if provided API returns emails sent from the sequence. string
recipient_email_address Optional, if provided API returns emails sent to the email address. string

Get Opens

curl --location --request GET 'https://run.salesblink.io/api/public/opens' \
--header 'Authorization: your_salesblink_key'

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://run.salesblink.io/api/public/opens',
  headers: { 
    'Authorization': 'your_salesblink_key'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

This endpoint retrieves emails sent from your account.

HTTP Request

GET https://run.salesblink.io/api/public/opens

You will receive all email open logs for your account, latest first.

Query Parameters

Parameter Description Type
sequence_id Optional, if provided API returns email opens from the sequence. string
recipient_email_address Optional, if provided API returns opens for a particular the email address. string

Get Clicks

curl --location --request GET 'https://run.salesblink.io/api/public/clicks' \
--header 'Authorization: your_salesblink_key'

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://run.salesblink.io/api/public/clicks',
  headers: { 
    'Authorization': 'your_salesblink_key'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

This endpoint retrieves emails sent from your account.

HTTP Request

GET https://run.salesblink.io/api/public/replies

You will receive all email open logs for your account, latest first.

Query Parameters

Parameter Description Type
sequence_id Optional, if provided API returns email clicks from the sequence. string
recipient_email_address Optional, if provided API returns clicks by a particular the email address. string

Get Replies

curl --location --request GET 'https://run.salesblink.io/api/public/replies' \
--header 'Authorization: your_salesblink_key'

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://run.salesblink.io/api/public/replies',
  headers: { 
    'Authorization': 'your_salesblink_key'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

This endpoint retrieves emails sent from your account.

HTTP Request

GET https://run.salesblink.io/api/public/clicks

You will receive all email open logs for your account, latest first.

Query Parameters

Parameter Description Type
sequence_id Optional, if provided API returns email replies from the sequence. string
recipient_email_address Optional, if provided API returns replies by a particular the email address. string

Errors

The SalesBlink API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The request is hidden for administrators only.
404 Not Found -- The specified kitten could not be found.
405 Method Not Allowed -- You tried to access SalesBlink with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
429 Too Many Requests -- You're requesting too many kittens! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.
shell javascript