Campaign

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 campaign information.

Campaign Information

Get information about all campaigns

 GET /campaigns
api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD
  curl --location --request GET 'https://platform.sendbound.com/api/v1/campaigns?api_token=H1OudZgiBIlNUzu9p3g1P78cFzaU3Vg82T7pueu0cS8aErV7UXuB6vIpbR1V'
[
  {
      "uid": "618ede5e105fe",
      "name": "New Customers",
      "type": "regular",
      "subject": "Testing",
      "plain": " News Digest Louis's Digest TOP STORIES FOR YOU What is the most Japanese thing ever? Scott Egan, Lived in Japan for two years • Updated April 25, 2017 I worked in a government office in Japan twenty years ago. After one month on the job I returned to my desk (after being away the ENTIRE day) to find $3,000 worth of yen on... Read More » 4.0K upvotes 88 comments I have written a novel and it’s been proofread. Where do I get it published or should I self-publish it? Sarah Armstrong, I'm a USA Today bestselling author. • Updated July 8 I’m a USA Today bestselling author, and own a small traditional publishing company. I’m also a ghostwriter and editor. The choices: 1. Traditional (never charges the author a... Read More » 81 upvotes 8 comments What does “ghibli” mean in Japanese? Douglas Kim, lived in Japan (2018-2019) • Answered October 23, 2020 This question was made for me. I honestly love Studio Ghibli’s movies and I even went to visit the Ghibli Museum in Mitaka, Tokyo. Put simply Ghibli refers to the translite... Read More » Read More » 420 upvotes 6 comments Read More in Your Feed Never miss a story. Designed for readers on the go. This email was sent by Quora (605 Castro Street, Mountain View, CA 94041). If you don't want to receive this type of email in the future, please unsubscribe. https://acellemail.com ",
      "from_email": "no-reply@p.com",
      "from_name": "SendBound Team",
      "reply_to": "no-reply@p.com",
      "status": "done",
      "delivery_at": "2021-11-12 21:41:36",
      "created_at": "2021-11-12T21:36:30.000000Z",
      "updated_at": "2021-11-12T21:41:37.000000Z"
  },
  {
      "uid": "61ae10161e9b4",
      "name": "Happy days",
      "type": "regular",
      "subject": "Testing",
      "plain": " One column layout Open in your browser Lorem ipsum dolor Nunc pulvinar turpis sed pellentesque aliquet Vestibulum id convallis ligula. Maecenas tellus erat, porta in augue eget, pretium aliquet neque. Nunc pulvinar turpis sed pellentesque aliquet. Sed ullamcorper, tellus eu viverra tincidunt, quam justo pellentesque est, et gravida justo eros vitae turpis. Mauris molestie id nisi in ultrices. Curabitur tellus ex, pretium nec dui ut, feugiat semper ipsum. Donec porttitor congue blandit. Pellentesque in purus nulla. Integer ut turpis purus. Nunc nec efficitur nunc. Lorem ipsum dolor Vestibulum id convallis ligula. Maecenas tellus erat, porta in augue eget, pretium aliquet neque. Nunc pulvinar turpis sed pellentesque aliquet. Sed ullamcorper, tellus eu viverra tincidunt, quam justo pellentesque est, et gravida justo eros vitae turpis. Mauris molestie id nisi in ultrices. Curabitur tellus ex, pretium nec dui ut, feugiat semper ipsum. Donec porttitor congue blandit. Pellentesque in purus nulla. Integer ut turpis purus. Nunc nec efficitur nunc. Copyright © 2021. All rights reserved. You can update your preferences or unsubscribe from this list. Back to top ",
      "from_email": "bloclexiz@boundmail.com",
      "from_name": "SendBound Team",
      "reply_to": "bloclexiz@boundmail.com",
      "status": "done",
      "delivery_at": "2022-01-10 22:26:44",
      "created_at": "2021-12-06T13:28:54.000000Z",
      "updated_at": "2022-01-11T21:06:37.000000Z"
  }
]

Query Parameters

api_token

Kindly reference here to obtain the API token.

Response Parameters

This operation returns a list of campaign model

Campaign Statistics

Get information about a specific campaign

 GET /campaigns/{uid}
api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD
  curl --location --request GET 'https://platform.sendbound.com/api/v1/campaigns/61ae10161e9b4?api_token=H1OudZgiBIlNUzu9p3g1P78cFzaU3Vg82T7pueu0cS8aErV7UXuB6vIpbR1V'
{
  "campaign": {
      "uid": "61ae10161e9b4",
      "name": "Happy days",
      "list": "",
      "segment": "",
      "default_subject": null,
      "from_email": "bloclexiz@boundmail.com",
      "from_name": "SendBound Team",
      "remind_message": null,
      "status": "done",
      "created_at": "2021-12-06T13:28:54.000000Z",
      "updated_at": "2022-01-11T21:06:37.000000Z"
  },
  "statistics": {
      "subscriber_count": 4,
      "uniq_open_rate": 0.75,
      "delivered_rate": 1,
      "unique_open_count": 3,
      "open_rate": 0.75,
      "uniq_open_count": 3,
      "last_open": "2022-01-25T07:17:58.000000Z",
      "click_rate": 0,
      "click_count": 0,
      "abuse_feedback_count": 0,
      "last_click": "",
      "bounce_count": 0,
      "unsubscribe_count": 0,
      "links": [],
      "top_locations": [
          "66.249.93.50",
          "104.28.87.13",
          "172.225.179.56",
          "66.249.93.80",
          "102.176.65.33"
      ],
      "top_open_subscribers": [
          {
              "uid": null,
              "email": "bloclexiz@boundmail.com"
          },
          {
              "uid": null,
              "email": "plamic.zolic@SendBound.com"
          },
          {
              "uid": null,
              "email": "adzamreforcea@boundmail.com"
          }
      ]
  }
}

Query Parameters

api_token

Kindly reference here to obtain the API token.

Response Parameters

This operation returns Campaign's information in json

campaign

Kindly reference here

statistics

Kindly reference here

Pause Campaign

Pause a specific campaign

 POST /api/v1/campaigns/{uid}/pause
api_token=NAim6P4gapLXU2ZUad7i46RAgtSnqTqRtFBX7BZpbyFTntUYZ8Dgtppf0byD
  curl --location --request POST 'https://platform.sendbound.com/api/v1/campaigns/61ae10161e9b4/pause?api_token=H1OudZgiBIlNUzu9p3g1P78cFzaU3Vg82T7pueu0cS8aErV7UXuB6vIpbR1V'
{
  "status": 1,
  "message": "Campaign Pause success"
}

Query Parameters

api_token

Kindly reference here to obtain the API token.

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.