Get the list of campaigns

  • GET /campaigns returns an array of campaigns in Reply account.

 Example

Request:

GET /campaigns

Response:

200 OK
[
 {
    "id": 1191,
    "name": "Campaign One",
    "created": "2015-07-07T12:46:49.0755099+00:00",
    "emailAccount": "[email protected]",
    "deliveriesCount": 1210,
    "opensCount": 973,
    "repliesCount": 121,
    "bouncesCount": 7,
    "optOutsCount": 0,
    "outOfOfficeCount": 6,
    "peopleCount": 920,
    "peopleFinished": 137,
    "peopleActive": 783,
    "peoplePaused": 6
  }
]

Get campaign details by campaign ID or name

  • GET /campaigns/{id} returns the campaign details by campaign id.
  • GET /campaigns?name={name} returns the campaign details by campaign name.

Note: the name value should be encoded to prevent problems with spaces inside the campaign name. For example: Campaign One should be encoded to ...?name=Campaign%20One.

 Example

Request:

GET /campaigns?name=Campaign%20One

Response:

200 OK
{
    "id": 1191,
    "name": "Campaign One",
    "created": "2015-07-07T12:46:49.0755099+00:00",
    "emailAccount": "[email protected]",
    "deliveriesCount": 1210,
    "opensCount": 973,
    "repliesCount": 121,
    "bouncesCount": 7,
    "optOutsCount": 0,
    "outOfOfficeCount": 6,
    "peopleCount": 920,
    "peopleFinished": 137,
    "peopleActive": 783,
    "peoplePaused": 6
}

Data type

  • id. integer, read-only, not required 
  • name. string, read and update, required 
  • created. date and time, read and update, required 
  • emailAccount. string, read and update, not required 
  • deliveriesCount. integer, read and update, not required 
  • opensCount. integer, read and update, not required 
  • repliesCount. integer, read and update, not required 
  • bouncesCount. integer, read and update, not required 
  • optOutsCount. integer, read and update, not required 
  • outOfOfficeCount. integer, read and update, not required 
  • peopleCount. integer, read and update, not required 
  • peopleFinished. integer, read and update, not required 
  • peopleActive. integer, read and update, not required 
  • peoplePaused. integer, read and update, not required 
Did this answer your question?