API / SmartAttachment

Entity Description:

PoliteMail’s SmartAttachment enables email attachments to be tracked to know who is opening the email messages. SmartAttachment is inserted into the email as a link and the file is uploaded to the Content Library.

 

Properties

Name Description Type Additional
Information
ID Int32
ActiveState Int16
Name String
Description String
URL String
OwnerID Int32
GUID String
Shared Boolean
CreationDate DateTime
Data Binary
ContentType String
BusinessID Int32
RegionID Int32

 

Entity Statement

Creating a SmartAttachment
Request
POST /ssv3/odata/SmartAttachments
Content-Type     
application/json
Request body
{
“ID”:”0″,”ActiveState”:”1″,”Name”:”New Attachment”,
“Description”:””,”URL”:”Example RL”,”OwnerID”:”0″,”GUID”:
“0”,”Shared”:false,”CreationDate”:”2014-12-10T17:48:26.155Z”,
“Data”:”0″,”ContentType”:”Example Content Type”,”BusinessID”:
“0”,”RegionID”:”0″
}
Response body
{
“ID”:1,”ActiveState”:1,”Name”:”New Attachment”,”Description”:
“”,”URL”:”Example URL”,”OwnerID”:”0″,”GUID”:”0″,”Shared”:false,
“CreationDate”:”2014-12-10T18:08:11.125Z”,”Data”:0,”ContentType”:
“Example Content Type”,”BusinessID”:0,”RegionID”:0
}
Deleting a SmartAttachment
  Request
  DELETE /ssv3/odata/SmartAttachments(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a SmartAttachment
  Request
  GET /ssv3/odata/SmartAttachments(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”ActiveState”:1,”Name”:”New Attachment”,”Description”:
“”,”URL”:”Example URL”,”OwnerID”:”0″,”GUID”:”0″,”Shared”:false,
“CreationDate”:”2014-12-10T18:08:11.125Z”,”Data”:0,”ContentType”:
“Example Content Type”,”BusinessID”:0,”RegionID”:0
}
Updating a SmartAttachment
  Request
  PUT /ssv3/odata/SmartAttachments(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”ActiveState”:”1″,”Name”:”New Attachment”,”Description”:
“”,”URL”:”Example URL”,”OwnerID”:”0″,”GUID”:”0″,”Shared”:false,
“CreationDate”:”2014-12-10T17:48:26.155Z”,”Data”:”0″,
“ContentType”:”Example Content Type”,”BusinessID”:”0″,”RegionID”:”0″
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all SmartAttachments
  Request
  GET /ssv3/odata/SmartAttachments
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”ActiveState”:1,”Name”:”New Attachment”,”Description”:
“”,”URL”:”Example URL”,”OwnerID”:0,”GUID”:”0″,”Shared”:false,
“CreationDate”:”2014-12-10T17:48:26.155Z”,”Data”:0,”ContentType”:
“Example Content Type”,”BusinessID”:0,”RegionID”:0
},{
“ID”:1,”ActiveState”:1,”Name”:”New Attachment”,”Description”:
“”,”URL”:”Example URL”,”OwnerID”:”0″,”GUID”:”0″,”Shared”:false,
“CreationDate”:”2014-12-10T18:08:11.125Z”,”Data”:0,”ContentType”:
“Example Content Type”,”BusinessID”:0,”RegionID”:0
}]