PURESEND REST API

Overview

  • This is the Puresend REST API that enables clients to send emails, manage lists and messages via a web service interface.
  • This page provides some basic examples using curl command.

Command format

  • <Instance> is the Purecast server your account is running on.
  • <API Function> is the API function endpoint which can be found in each API function detail page.
  • <API Key> can be found in the bottom of the UI page in Administration > Change password
  • <JSON Input> is the parameter for the API, a sample template is at the bottom of each API function detail page.

curl --request POST 'https://<Instance>/PuresendService/v1/<API Function>' \
--header 'Authorization: Basic <API Key>' \
--header 'Content-Type: application/json' \
--data-raw '<JSON Input>'

  • The following example shows a request of Get List Id API, taking listType as an input parameter with value 1.

curl --request POST 'https://<Your Instance>/PuresendService/v1/getLists' \
--header 'Authorization: Basic <Your API Key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "listType": 1
}'