SendPulse service REST API

  1. Home
  2. Integrations
  3. 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.

Web hooks are available by request. Please contact us at support@sendpulse.com if you want 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 come back in the form of JSON structures.

 

SendPulse API wrappers

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

 

Main URL

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

https://api.sendpulse.com

 

Authorization

The authorization process is only possible when preceded by a private key, which, in future, should be referenced in each request to the API.

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:

grant_type has to be equal to client_credentials
client_id your ID (API)
client_secret your secret (API)

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

https://api.sendpulse.com/oauth/access_token

A sample response:The resulting key is valid for 1 hour and does not require additional requests with each operation. At the end of the license period (1 hour), you must send a request to obtain a new key.

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

A sample key:

Authorization: Bearer tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc

 

Error codes and description

Error code Description
8 Empty data
10 Empty sender email address
11 Can’t find recipients addresses
13 Empty email message content field
14 Can’t find email address with a specified ID
17 Can’t find email address
19 Email address already exists
20 You are not allowed to use free mail services
21 Can’t find email address on activation
97 Invalid email address type. You are not allowed to use free mail services.
201 Empty mailing list name
203 This mailing list name already exists
303 Can’t find email addresses in the mailing list
400 Can’t find such SMTP user. Please, create SMTP service account.
502 Can’t find email address
602 Can’t find campaign. Probably, it has already been sent.
701 Empty sender name or email address
703 Can’t find mailing list
704 Can’t find sender
707 Not enough funds on your account balance
711 You should wait for 15 minutes before creating new campaign on the same mailing list.
720 Empty subject field
721 Empty email message content field
722 Can’t find mailing list ID
799 Wrong send date. It must be in such format: Y-m-d H:i:s and can not be less than the current date
800 Invalid operation
802 Can’t find campaign
901 Empty sender name field
902 Chosen email address is already used
903 Empty sender email address field
904 Email address is blacklisted
905 You have reached the limit of available sender addresses
906 Email address syntax error
1101 Empty email address field
1003 The specified sender doesn’t exist
1004 Activation code was sent. You should wait for 15 minutes before the next try.
1005 Confirmation sending error
1104 Can’t find activation code