SendPulse Service REST API

Introduction

Our API interface is used to integrate SendPulse’s distribution service capabilities with client’s personal projects. The API is designed for developers and is accompanied by detailed documentation.

SendPulse’s REST API works over the HTTPS protocol and is essentially a set of methods used to perform requests and receive responses for each operation. All answers return in the form of JSON structures.

All references to API requests in this document include the root URL:

Cross Domain Queries (jQuery Ajax Example) are not allowed. 

SendPulse libraries

The latest versions of SendPulse API client libraries are available at GitHub.

• PHP wrapper
• Python wrapper
• Ruby wrapper
• Java wrapper
• Node.js wrapper
• C# wrapper 
• Go wrapper (third-party solution)

You can also check other third-party solutions on Github.

Authorization

SendPulse API uses Bearer token authentication. You must include the token in the Authorization header of every request:

You can authorize your requests in two ways:

• API Key (Static): A long-lived token generated manually in your account.
• OAuth 2.0 (Dynamic): A temporary access token obtained via Client ID and Client Secret.

API keys

An API key is a permanent authentication token. It remains valid until you manually revoke it, making it ideal for simple integrations where you don't want to implement token refresh logic.

Go to Settings > API > API keys and click Generate. Give your key a name and optionally restrict access to specific IP addresses.

You can create up to 5 independent keys. This allows you to manage different integrations separately and revoke them individually if needed.

OAuth 2.0 (Client Credentials)

This method allows you to programmatically obtain a temporary access token using your Client ID and Client Secret.

The access token is valid for 1 hour. You should request a new token only after the current one expires.

Go to Settings > API > API keys and copy your ID and Secret.

To get the token, send a POST request to:

Request parameters:

Request example:

{
   "grant_type":"client_credentials",
   "client_id":"0aadb081f2f81c05bafe39621910000",
   "client_secret":"a99e7d506d3701c5c04de3db1913eeee"
}

If request is successful, you will receive a response:

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjI5NTQ4NDVjZWJlZjg5Nzk0YmYzMzk4ZDdiNTQ3OTA2MWUzNDQ2N2I5NTUwMmFlNzE1YmViZmU4MDBmNTMxMjIxMTU2MTcyOWM2MjI5NGRjIn0.eyJhdWQiOiIyMzdiNGFmOWM5OWQwZjg5YmRiZDg3NmRjZDVhMDE3ZiIsImp0aSI6IjI5NTQ4NDVjZWJlZjg5Nzk0YmYzMzk4ZDdiNTQ3OTA2MWUzNDQ2N2I5NTUwMmFlNzE1YmViZmU4MDBmNTMxMjIxMTU2MTcyOWM2MjI5NGRjIiwiaWF0IjaaNjI0NTI0OTA0LCJuYmYiOjE2MjQ1MjQ5MDQsImV4cCI6MTYyNDUyODUwNCwic3ViIjoiIiwic2NvcGVzIjpbXSwidXNlciI6eyJpZCI6Njc0MTgwNCwiZ3JvdXBfaWQiOm51bGwsInBhcmVudF9pZCI6bnVsbCwiYXJlYSI6InJlc3QifX0.jiP3Sv7IF1mHGmW0oGIrPAw0oOiIEnC8Tb6wlWu5eVM2UrHL6RZsDlIslLSQNEvL_e50nDlgtgyfX5Qty4qlQ4XyW53FAgjwHbyQG7DJ6iVRAtVBtFNbkFVNbHvKw8zQy7WyxhICpAF8zdF8-gBHBnzuMhKSnASYEosJ9IAPqUkxQXrd8LpUSk-etzjEqcpMkbGj2M7Y0OxO4_BfRhVNU6ZcbiawD09m0A9uWoSnoZKxXw0o64PE3anJta6lFns5SDuyeGxanOtuZSS5I3umI2OOnUVzNG9_5WjCe6LPVQLAPAPt0m8S5WkI35_jCJ0A-gDBBdsgnUudGCvsDcgEog",
  "token_type": "Bearer",
  "expires_in": 3600
}

Account information

To get information about your account, send a GET request to:

If request is successful, you will receive a response:

{
  "id": 7043663,
  "name": "Frodo Baggins",
  "first_name": "Frodo",
  "last_name": "Baggins",
  "email": "frodo.baggins@shire.me",
  "phone": "380680899608",
  "lang": "en:English",
  "avatar": "https://login.sendpulse.com/files/avatars/frodo_ring.png",
  "currency": "USD",
  "country": "NZ",
  "city": "Hobbiton",
  "locale": "Pacific/Auckland",
  "time_zone": "12",
  "team_name": "Fellowship of the Ring",
  "team_avatar": "https://login.sendpulse.com/files/avatars/fellowship.png",
  "phone_confirm": true
}

Invited users

To get information about your team members, send a GET request to:

If request is successful, you will receive a response:

[
    {
        "id": 7043663,
        "firstname": "john",
        "lastname": "harrington",
        "email": "john.harrington@example.com",
        "group_id": null,
        "is_active": true,
        "avatar": "https://example.com/avatars/test-user-1.png",
        "lang": "ua:Українська",
        "locale": "Europe/Kyiv",
        "currency": "UAH",
        "country": "UA",
        "phone": 380671112233
    },
    {
        "id": 8802086,
        "firstname": "amelia",
        "lastname": "rowe",
        "email": "amelia.rowe@example.org",
        "group_id": 6,
        "is_active": true,
        "avatar": null,
        "lang": "en:English",
        "locale": "Europe/Berlin",
        "currency": "EUR",
        "country": "DE",
        "phone": 499876543210
    },
    {
        "id": 8700831,
        "firstname": "william",
        "lastname": "dawson",
        "email": "william.dawson@example.net",
        "group_id": 1,
        "is_active": true,
        "avatar": null,
        "lang": "ua:Українська",
        "locale": "Europe/Berlin",
        "currency": "UAH",
        "country": "DE",
        "phone": 380631234567
    }
]

Balance information

To get detailed balance information, send a GET request to:

If request is successful, you will receive a response:

{
    "balance": {
        "main": "9.36",
        "bonus": "5.00",
        "currency": "USD"
    },
    "email": {
        "tariff_name": "Pay as you go 10 000",
        "finished_time": "2019-04-25 08:03:02",
        "emails_left": 9914,
        "maximum_subscribers": 10000,
        "current_subscribers": 0
    },
    "smtp": {
        "tariff_name": "SMTP Free",
        "end_date": "2018-11-21 15:05:39",
        "auto_renew": 1
    },
    "push": {
        "tariff_name": "White Label",
        "end_date": "2018-11-30",
        "auto_renew": 1
    }
}

Request limits

There are limits and quotas on SendPulse API requests to protect the system from receiving more data than it can handle and ensure an equitable distribution of the system resources. API limits per minute and per day depend on the category of your selected pricing plan

General quota limits

The following quotas apply to sending API requests:

Exceeding quota limits

If you exceed this quota, the API returns the following error:

429 Too many requests

To be able to send more requests, you need to upgrade your current pricing plan.

Error codes