API / Email

Entity Description:

All PoliteMail that is distributed is tracked and a record of interactions with the recipients and the Email is stored and the metadata parsed to capture the metrics for future analysis.

 

Properties

Name Description Type Additional
Information
ID Int32
OwnerID Int32
ContactID Int32
SendDate DateTime
Subject String
RefID Int32
MessageID Int32
RecipientType Int16

 

Entity Statement

Creating an Email
Request
POST /ssv3/odata/Emails
Content-Type     
application/json
Request body
{
“ID”:”0″,”OwnerID”:”0″,”ContactID”:”0″,”SendDate”:”2014-11-27T11:48:26.155Z”,”Subject”:”Example Subject”,”RefID”:”0″,”MessageID”:”0″,”RecipientType”:”0″
}
Response body
{
“ID”:1,”OwnerID”:0,”ContactID”:0,”SendDate”:”2014-11-27T16:48:00.000Z”,”Subject”:”Example Subject”,”RefID”:0,”MessageID”:0,”RecipientType”:0
}
Deleting an Email
  Request
  DELETE /ssv3/odata/Emails(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting an Email
  Request
  GET /ssv3/odata/Emails(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”OwnerID”:0,”ContactID”:0,”SendDate”:”2014-11-27T16:48:00.000Z”,”Subject”:”Example Subject”,”RefID”:0,”MessageID”:0,”RecipientType”:0
}
Updating an Email
  Request
  PUT /ssv3/odata/Emails(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”OwnerID”:”0″,”ContactID”:”0″,”SendDate”:”2014-11-27T11:48:26.155Z”,”Subject”:”Example Subject”,”RefID”:”0″,”MessageID”:”0″,”RecipientType”:”0″
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Emails
  Request
  GET /ssv3/odata/Emails
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”OwnerID”:0,”ContactID”:0,”SendDate”:”2014-11-27T11:48:26.155Z”,”Subject”:”Example Subject”,”RefID”:0,”MessageID”:0,”RecipientType”:0
},{
“ID”:1,”OwnerID”:0,”ContactID”:0,”SendDate”:”2014-11-27T16:48:00.000Z”,”Subject”:”Example Subject”,”RefID”:0,”MessageID”:0,”RecipientType”:0
}]