API / Campaign

Entity Description:

Campaign is a group of similar email messages that have been sent with the ability to track the cumulative results of all the emails sent over time. (e.g. Monthly Newsletters, Weekly sales incentives, Marketing questionnaires, etc…).  Email messages can be added to a Campaign at any time after being sent out or before distribution.

 

Properties

Name Description Type Additional
Information
ID Int32
Name String
Description String
Owner ID Int32
Shared Boolean
CreationDate DateTime
ActiveState Boolean
BusinessID Int32
RegionID Int32

 

Entity Statement

Creating a Campaign
Request
POST /ssv3/odata/Campaigns
Content-Type     
application/json
Request body
{
“ID”:”0″,”Name”:”New Campaign”,”Description”:”Example Description”,”OwnerID”:”0″,”Shared”:false,”CreationDate”:”2014-11-19T11:48:26.155Z”,”ActiveState”:”1″,”BusinessID”:”0″,”RegionID”:”0″
}
Response body
{
“ID”:1,”Name”:”New Campaign”,”Description”:”Example Description”,”OwnerID”:0,”Shared”:false,”CreationDate”:”2014-12-01T16:28:30.157Z”,”ActiveState”:1,”BusinessID”:0,”RegionID”:0
}
Deleting a Campaign
  Request
  DELETE /ssv3/odata/Campaigns(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a Campaign
  Request
  GET /ssv3/odata/Campaigns(1)
  Content-Type     
  application/json
  Response body
  {“ID”:1,”Name”:”New Campaign”,”Description”:”Example Description”,”OwnerID”:0,”Shared”:false,”CreationDate”:”2014-12-01T16:28:30.157Z”,”ActiveState”:1,”BusinessID”:0,”RegionID”:0}
Updating a Campaign
  Request
  PUT /ssv3/odata/Campaigns(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”Name”:”New Campaign”,”Description”:”Example Description”,”OwnerID”:”0″,”Shared”:false,”CreationDate”:”2014-11-19T11:48:26.155Z”,”ActiveState”:”1″,”BusinessID”:”0″,”RegionID”:”0″
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Campaigns
  Request
  GET /ssv3/odata/Campaigns
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”Name”:”New Campaign”,”Description”:”Example Description”,”OwnerID”:0,”Shared”:false,”CreationDate”:”2014-11-19T11:48:26.155Z”,”ActiveState”:”1″,”BusinessID”:0,”RegionID”:0
},{
“ID”:1,”Name”:”New Campaign”,”Description”:”Example Description”,”OwnerID”:0,”Shared”:false,”CreationDate”:”2014-12-01T16:28:30.157Z”,”ActiveState”:1,”BusinessID”:0,”RegionID”:0
}]