API / Category

Entity Description:

Contacts can be organized outside of mailing lists using category. Categories are assigned manually to individual contacts, or when selecting or importing a list or group of contacts.

 

Properties

Name Description Type Additional
Information
ID Int32
Name String
Enabled Int32

 

Entity Statement

Creating a Category
Request
POST /ssv3/odata/Categories
Content-Type     
application/json
Request body
{
“ID”:”0″,”Name”:”New Category”,”Enabled”:”0″
}
Response body
{
“ID”:1,”Name”:”New Category”,”Enabled”:0
}
Deleting a Category
  Request
  DELETE /ssv3/odata/Categories(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a Category
  Request
  GET /ssv3/odata/Categories(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”Name”:”New Category”,”Enabled”:0
}
Updating a Category
  Request
  PUT /ssv3/odata/Categories(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”Name”:”New Category”,”Enabled”:”0″
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Categories
  Request
  GET /ssv3/odata/Categories
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”Name”:”New Category”,”Enabled”:0
},{
“ID”:1,”Name”:”New Category”,”Enabled”:0
}]