Subscribers

REQUIREMENT

The base URL for all API requests is https://platform.sendbound.com/api/v1

REQUIREMENT

The API token MUST be included as a query parameter in all subsequent requests. The token value is assigned to the api_token parameter as a query parameter.

This section of the documentation describes how to obtain and manage subscriber information.

Subscriber Information

Display list's subscribers

 GET /subscribers

api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD

curl --location --request GET 'https://platform.sendbound.com/api/v1/subscribers?api_token=H1OudZgiBIlNUzu9p3g1P78cFzaU3Vg82T7pueu0cS8aErV7UXuB6vIpbR1V&list_uid=5eccdb2e6cfc3'

[
  {
      "uid": "618edde473725",
      "email": "adzamreforcea@boundmail.com",
      "status": "subscribed",
      "FIRST_NAME": "reforcea",
      "LAST_NAME": "Victor"
  },
  {
      "uid": "5eccdbfcd2bc5",
      "email": "plamic.zolic@SendBound.com",
      "status": "subscribed",
      "FIRST_NAME": "Edem ",
      "LAST_NAME": "Kofi"
  }
]

Query Parameters

`api_token`

Kindly reference here to obtain the API token.

`list_uid`

This represents the unique id of the email list for which you would like to retreive subscribers.

`open`

This is an optional value which represents the below:

yes - opened some campaigns
no - not opened any campaign

Default value is all

`click`

This is an optional value which represents the below:

yes - clicked some campaigns
no - not clicked any campaign

Default value is all

`per_page`

This represents the number of subscribers per page. Default value is 25

`page`

This represents the page number

Response Parameters

Returns a list of subscriber information in json.

New Subscriber

Create subscriber for a mail list

 POST /subscribers

api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD

  {
      "list_uid":"5eccdb2e6cfc3",
      "EMAIL":"redux@example.com",
      "FIRST_NAME":"James",
      "LAST_NAME":"Doe"
  }

curl --location --request POST 'https://platform.sendbound.com/api/v1/subscribers?api_token=H1OudZgiBIlNUzu9p3g1P78cFzaU3Vg82T7pueu0cS8aErV7UXuB6vIpbR1V' \
--header 'Content-Type: application/json' \
--data-raw '{
  "list_uid":"5eccdb2e6cfc3",
  "EMAIL":"redux@example.com"
}'

{
  "status": 1,
  "message": "Confirmation email sent to the subscriber",
  "subscriber_uid": "61f8f3e5bbd43"
}

Query Parameters

`api_token`

Kindly reference here to obtain the API token.

Request Parameters

`list_uid`

This represents the unique id of the email list for which you would like to add subscribers.

`EMAIL`

Subscriber's email

`FIRST_NAME`

Optional parameter representing subscribers first name

`LAST_NAME`

Optional parameter representing subscribers last name

`tag`

Subscriber's tags, seperated by a comma (,).

`OTHER_FIELDS...`

All subscriber's other fields: FIRST_NAME (?), LAST_NAME (?),... (depending on the list fields configuration)

Response Parameters

`status`

This represents the status of the operation. 1 means success and 0 means failure

`message`

This parameter contains a succss or failure message.

`subscriber_uid`

This parameter holds a unique identifier to the subscriber.

Get Subscriber

Create subscriber for a mail list

 GET /subscribers/{uid}

api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD

  curl --location --request GET 'https://platform.sendbound.com/api/v1/subscribers/618edde473725?api_token=H1OudZgiBIlNUzu9p3g1P78cFzaU3Vg82T7pueu0cS8aErV7UXuB6vIpbR1V'

{
  "subscriber": {
      "uid": "618edde473725",
      "email": "adzamreforcea@boundmail.com",
      "status": "subscribed",
      "source": "added",
      "ip_address": "154.160.14.159",
      "tags": [],
      "FIRST_NAME": "reforcea",
      "LAST_NAME": "Victor"
  }
}

Query Parameters

`api_token`

Kindly reference here to obtain the API token.

PATH PARAMETERS

`uid`

This represents the unique id of the subscriber or email.

Response Parameters

`subscriber`

All subscriber information in json

Update Subscriber

Update subscriber for a mail list

 PATCH /subscribers/{uid}

api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD

  ```json
{
    "EMAIL":"redux@example.com",
    "FIRST_NAME":"REDUX AR",
    "LAST_NAME":"BANE"
}
  ```
  

curl --location --request PATCH 'https://platform.sendbound.com/api/v1/subscribers/61f8f3e5bbd43?api_token=H1OudZgiBIlNUzu9p3g1P78cFzaU3Vg82T7pueu0cS8aErV7UXuB6vIpbR1V' \
--header 'Content-Type: application/json' \
--data-raw '{
  "EMAIL":"redux@example.com",
  "FIRST_NAME":"REDUX AR",
  "LAST_NAME":"BANE"
}'

{
  "status": 1,
  "message": "Subscriber was successfully updated",
  "subscriber_uid": "61f8f3e5bbd43"
}

Query Parameters

`api_token`

Kindly reference here to obtain the API token.

PATH PARAMETERS

`uid`

This represents the unique id of the subscriber or email.

Response Parameters

`status`

This represents the status of the operation. 1 means success and 0 means failure

`message`

This parameter contains a succss or failure message.

`subscriber_uid`

This parameter holds a unique identifier to the subscriber.

Add tags to Subscriber

Add tag(s) to subscriber

 POST /subscribers/{uid}/add-tag

api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD

curl --location --request POST 'https://platform.sendbound.com/api/v1/subscribers/61f8f3e5bbd43/add-tag?api_token=H1OudZgiBIlNUzu9p3g1P78cFzaU3Vg82T7pueu0cS8aErV7UXuB6vIpbR1V' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tag":"eat,sleep,dress"
}'

{
  "status": 1,
  "message": "Tag was added successfully",
  "subscriber_uid": "61f8f3e5bbd43",
  "tags": [
      "eat",
      "sleep",
      "dress"
  ]
}

Query Parameters

`api_token`

Kindly reference here to obtain the API token.

PATH PARAMETERS

`uid`

This represents the unique id of the subscriber or email.

Response Parameters

`status`

This represents the status of the operation. 1 means success and 0 means failure

`message`

This parameter contains a succss or failure message.

`subscriber_uid`

This parameter holds a unique identifier to the subscriber.

`tags`

This parameter holds the tags attached to the subscriber

Add tags to Subscriber

Add tag(s) to subscriber

 GET /subscribers/email/{email}

api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD

curl --location --request GET 'https://platform.sendbound.com/api/v1/subscribers/email/redux@example.com?api_token=H1OudZgiBIlNUzu9p3g1P78cFzaU3Vg82T7pueu0cS8aErV7UXuB6vIpbR1V'

{
  "subscribers": [
      {
          "uid": "61f8f3e5bbd43",
          "list_uid": "5eccdb2e6cfc3",
          "email": "redux@example.com",
          "status": "subscribed",
          "source": "api",
          "ip_address": "41.66.207.206",
          "FIRST_NAME": "REDUX AR",
          "LAST_NAME": "BANE"
      }
  ]
}

Query Parameters

`api_token`

Kindly reference here to obtain the API token.

PATH PARAMETERS

`uid`

This represents the unique id of the subscriber or email.

Response Parameters

`subscriber`

All subscriber information in json

Subscribe a subscriber to a mailing list

 PATCH /subscribers/{uid}/subscribe

api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD

curl --location --request PATCH 'https://platform.sendbound.com/api/v1/subscribers/61f8f3e5bbd43/subscribe?api_token=H1OudZgiBIlNUzu9p3g1P78cFzaU3Vg82T7pueu0cS8aErV7UXuB6vIpbR1V'

{
  "status": 0,
  "message": "Already subscribed"
}

Query Parameters

`api_token`

Kindly reference here to obtain the API token.

PATH PARAMETERS

`uid`

This represents the unique id of the subscriber or email.

Response Parameters

`subscriber`

`status`

This represents the status of the operation. 1 means success and 0 means failure

`message`

This parameter contains a succss or failure message.

Unsubscribe

Unsubscribe a subscriber from a mailing list

 PATCH /subscribers/{uid}/unsubscribe

api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD

curl --location --request PATCH 'https://platform.sendbound.com/api/v1/subscribers/61f8f3e5bbd43/unsubscribe?api_token=H1OudZgiBIlNUzu9p3g1P78cFzaU3Vg82T7pueu0cS8aErV7UXuB6vIpbR1V'

{
  "status": 1,
  "message": "Unsubscribed"
}

Query Parameters

`api_token`

Kindly reference here to obtain the API token.

PATH PARAMETERS

`uid`

This represents the unique id of the subscriber or email.

Response Parameters

`subscriber`

`status`

This represents the status of the operation. 1 means success and 0 means failure

`message`

This parameter contains a succss or failure message.

Delete a subscriber from a mailing list

 DELETE /subscribers/{uid}

api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD

curl --location --request DELETE 'https://platform.sendbound.com/api/v1/subscribers/61f8f3e5bbd43?api_token=H1OudZgiBIlNUzu9p3g1P78cFzaU3Vg82T7pueu0cS8aErV7UXuB6vIpbR1V'

{
  "status": 1,
  "message": "Deleted"
}

Query Parameters

`api_token`

Kindly reference here to obtain the API token.

PATH PARAMETERS

`uid`

This represents the unique id of the subscriber or email.

Response Parameters

`subscriber`

`status`

This represents the status of the operation. 1 means success and 0 means failure

`message`

This parameter contains a succss or failure message.

Subscribers

REQUIREMENT

REQUIREMENT

Subscriber Information

Query Parameters

api_token

list_uid

open

click

per_page

page

Response Parameters

New Subscriber

Query Parameters

api_token

Request Parameters

list_uid

EMAIL

FIRST_NAME

LAST_NAME

tag

OTHER_FIELDS...

Response Parameters

status

message

subscriber_uid

Get Subscriber

Query Parameters

api_token

PATH PARAMETERS

uid

Response Parameters

subscriber

Update Subscriber

Query Parameters

api_token

PATH PARAMETERS

uid

Response Parameters

status

message

subscriber_uid

Add tags to Subscriber

Query Parameters

api_token

PATH PARAMETERS

uid

Response Parameters

status

message

subscriber_uid

tags

Add tags to Subscriber

Query Parameters

api_token

PATH PARAMETERS

uid

Response Parameters

subscriber

Subscribe

Query Parameters

api_token

PATH PARAMETERS

uid

Response Parameters

subscriber

status

message

Unsubscribe

Query Parameters

api_token

PATH PARAMETERS

uid

Response Parameters

subscriber

status

message

Dlete Subscribe

Query Parameters

api_token

`api_token`

`list_uid`

`open`

`click`

`per_page`

`page`

`api_token`

`list_uid`

`EMAIL`

`FIRST_NAME`

`LAST_NAME`

`tag`

`OTHER_FIELDS...`

`status`

`message`

`subscriber_uid`

`api_token`

`uid`

`subscriber`

`api_token`

`uid`

`status`

`message`

`subscriber_uid`

`api_token`

`uid`

`status`

`message`

`subscriber_uid`

`tags`

`api_token`

`uid`

`subscriber`

`api_token`

`uid`

`subscriber`

`status`

`message`

`api_token`

`uid`

`subscriber`

`status`

`message`

`api_token`

`uid`

`subscriber`

`status`

`message`