API / OptOut

Entity Description:

To be CAN-SPAM compliant with any commercial email message, OptOut can add an automated opt-out compliance footer to the PoliteMail email message or template. The OptOut footer is optional when sending email via a local email server, or when PoliteMail is used for internal corporate communications.

 

Properties

Name Description Type Additional
Information
ID Int32
RefID Int32
OwnerID Int32
DeviceID Int32
IPAddress String
UserAgent String
Browser String
Version String
IsMobile Boolean
MobileDeviceManufacturer String
MobileDeviceModel String
Latitude Decimal
Longitude Decimal
BrowserLanguage String
FullUserAgent String
Referrer String
OptOutDate DateTime

 

Entity Statement

Creating an OptOut
Request
POST /ssv3/odata/OptOuts
Content-Type     
application/json
Request body
{
“ID”:”0″,”RefID”:”0″,”OwnerID”:”0″,”DeviceID”:”0″,”IPAddress”:
“0.0.0.0”,”UserAgent”:”Example User Agent”,”Browser”:”Example Browser”,
“Version”:”Example Version”,”IsMobile”:true,”MobileDeviceManufacturer”:
“Example Manufacturer”,”MobileDeviceModel”:”Example Model”,”Latitude”:”0.00000″,”Longitude”:”0.00000″,”BrowserLanguage”:
“Example Language”,”FullUserAgent”:”Example Full User Agent”,”Referrer”:
“Example Referrer”,”OptOutDate”:”2014-11-19T17:48:26.155Z”
}
Response body
{
“ID”:1,”RefID”:0,”OwnerID”:0,”DeviceID”:0,”IPAddress”:0.0.0.0,”UserAgent”:
“Example User Agent”,”Browser”:”Example Browser”,”Version”:”Example Version”,”IsMobile”:true,”MobileDeviceManufacturer”:”Example Manufacturer”,”MobileDeviceModel”:”Example Model”,”Latitude”:0.00000,”Longitude”:0.00000,”BrowserLanguage”:”Example Language”,”FullUserAgent”:”Example Full User Agent”,”Referrer”:”Example Referrer”,”OptOutDate”:”2014-11-20T01:14:23.112Z”
}
Deleting an OptOut
  Request
  DELETE /ssv3/odata/OptOuts(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting an OptOut
  Request
  GET /ssv3/odata/OptOuts(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”RefID”:0,”OwnerID”:0,”DeviceID”:0,”IPAddress”:0.0.0.0,”UserAgent”:
“Example User Agent”,”Browser”:”Example Browser”,”Version”:”Example Version”,”IsMobile”:true,”MobileDeviceManufacturer”:”Example Manufacturer”,”MobileDeviceModel”:”Example Model”,”Latitude”:0.00000,”Longitude”:0.00000,”BrowserLanguage”:”Example Language”,”FullUserAgent”:”Example Full User Agent”,”Referrer”:”Example Referrer”,”OptOutDate”:”2014-11-20T01:14:23.112Z”
}
Updating an OptOut
  Request
  PUT /ssv3/odata/OptOuts(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”RefID”:”0″,”OwnerID”:”0″,”DeviceID”:”0″,”IPAddress”:”0.0.0.0″,
“UserAgent”:”Example User Agent”,”Browser”:”Example Browser”,”Version”:
“Example Version”,”IsMobile”:true,”MobileDeviceManufacturer”:”Example Manufacturer”,”MobileDeviceModel”:”Example Model”,”Latitude”:”0.00000″,”Longitude”:”0.00000″,”BrowserLanguage”:
“Example Language”,”FullUserAgent”:”Example Full User Agent”,”Referrer”:
“Example Referrer”,”OptOutDate”:”2014-11-19T17:48:26.155Z”
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all OptOuts
  Request
  GET /ssv3/odata/Lists
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”RefID”:0,”OwnerID”:0,”DeviceID”:0,”IPAddress”:0.0.0.0,”UserAgent”:
“Example User Agent”,”Browser”:”Example Browser”,”Version”:”Example Version”,”IsMobile”:true,”MobileDeviceManufacturer”:”Example Manufacturer”,”MobileDeviceModel”:”Example Model”,”Latitude”:0.00000,”Longitude”:0.00000,”BrowserLanguage”:”Example Language”,”FullUserAgent”:”Example Full User Agent”,”Referrer”:”Example Referrer”,”OptOutDate”:”2014-11-19T17:48:26.155Z”
},{
“ID”:1,”RefID”:0,”OwnerID”:0,”DeviceID”:0,”IPAddress”:0.0.0.0,”UserAgent”:
“Example User Agent”,”Browser”:”Example Browser”,”Version”:”Example Version”,”IsMobile”:true,”MobileDeviceManufacturer”:”Example Manufacturer”,”MobileDeviceModel”:”Example Model”,”Latitude”:0.00000,”Longitude”:0.00000,”BrowserLanguage”:”Example Language”,”FullUserAgent”:”Example Full User Agent”,”Referrer”:”Example Referrer”,”OptOutDate”:”2014-11-20T01:14:23.112Z”
}]