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 with a detailed documentation.

Webhooks are available on request. Please contact us at support@sendpulse.com if you would like to have them enabled for your account.

Wrappers for SendPulse API and code samples

Description

SendPulse’s REST API service works over the HTTP protocol and is essentially a set of methods that are used to perform requests and receive responses for each operation.

All answers return in the form of JSON structures.

Rate limit is 3 requests per second.

SendPulse API wrappers

The latest versions of SendPulse API wrappers are available at GitHub.

• PHP wrapper
• Python wrapper
• Ruby wrapper
• Java wrapper
• Node.js wrapper

Main URL

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

https://api.sendpulse.com

Authorization

Authorization process requires a personal key signing each further API request.

The necessary parameters to obtain the key can be found in the private account settings page found on the following URL 

https://login.sendpulse.com/settings in the API tab.

The following parameters are used:

To get the key you have to send a POST request to:

A sample response: The resulting key is valid for 1 hour and does not require additional requests for each operation. Request for a new key must be sent before the current key expires.

{
  "access_token": "tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc",
  "token_type": "Bearer",
  "expires_in": 3600
}

A sample key:

Authorization: Bearer tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc

Error codes and description