API / ContactRead

Entity Description:

An email that is created and sent utilizing PoliteMail, will be tracked for the time the email was opened and read, the name of the recipient, if the email is active, and was it shared with someone else.


Properties

NameDescriptionTypeAdditional
Information
ID
Int32
TimeRead
Decimal
DisplayName
String
FirstName
String
LastName
String
Email
String
ActiveState
Int16
CreationDate
DateTime
Shared
Boolean
OwnerID
Int32
CatergoryID
Int32
StageID
Int32
Company
String
WebAddress
String
Title
String
FileAs
String
Source
Int32
Notes
String
Custom1
String
Custom2
String
Custom3
String
Custom4
String
Custom5
String
Custom6
String
Custom7
String
Custom8
String
Custom9
String
Custom10
String
Custom11
String
Custom12
String
Custom13
String
Custom14
String
Custom15
String
Custom16
String
Custom17
String
Custom18
String
Custom19
String
Custom20
String
BusinessID
Int32
RegionID
Int32


Entity Statement

if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.

Creating a ContactRead

Request

POST /api/odata/ContactReads

Content-Type 

application/json

Request body

{
"ID":"0","TimeRead":"0.00000","DisplayName":"Example Display Name",
"FirstName":"Example First Name","LastName":"Example Last Name","Email":
"Example Email","ActiveState":false,"CreationDate":"2014-10-30T12:00:00.000Z","Shared":false,"OwnerID":"0","CategoryID":"0",
"StageID":"0","Company":"Example Company","WebAddress":"Example Web Address","Title":"Example Title","FileAs":"","Source":"0","Notes":"",
"Custom1":"", "Custom2":"", "Custom3":"","Custom4":"", "Custom5":"",
"Custom6":"", "Custom7":"", "Custom8":"", "Custom9":"",
"Custom10":"", "Custom11":"", "Custom12":"", "Custom13":"",
"Custom14":"", "Custom15":"", "Custom16":"", "Custom17":"",
"Custom18":"", "Custom19":"", "Custom20":"", "BusinessID":"0", "RegionID":"0"
}

Response body

{
"ID":1,"TimeRead":0.00000,"DisplayName":"Example Display Name","FirstName":"Example First Name","LastName":"Example Last Name","Email":"Example Email","ActiveState":false,"CreationDate":"2014-10-31T12:00:00.000Z","Shared":false,"OwnerID":"0","CategoryID":"0","StageID":"0",
"Company":"Example Company","WebAddress":"Example Web Address","Title":"Example Title","FileAs":"","Source":0,"Notes":"", "Custom1":"", "Custom2":"", "Custom3":"",
"Custom4":"", "Custom5":"", "Custom6":"", "Custom7":"", "Custom8":"", "Custom9":"",
"Custom10":"", "Custom11":"", "Custom12":"", "Custom13":"", "Custom14":"", "Custom15":"", "Custom16":"", "Custom17":"", "Custom18":"", "Custom19":"", "Custom20":"", "BusinessID":0, "RegionID":0
}
Deleting a ContactRead
 Request
 DELETE /api/odata/ContactReads(1)
 Response Headers
 HTTP/1.1 204 No Content
Getting a ContactRead
 Request
 GET /api/odata/ContactReads(1)
 Content-Type 
 application/json
 Response body
 {
"ID":1,"TimeRead":0.00000,"DisplayName":"Example Display Name","FirstName":
"Example First Name","LastName":"Example Last Name","Email":"Example Email","ActiveState":false,"CreationDate":"2014-10-31T12:00:00.000Z","Shared":false,"OwnerID":"0","CategoryID":"0","StageID":"0",
"Company":"Example Company","WebAddress":"Example Web Address","Title":"Example Title","FileAs":"","Source":0,"Notes":"", "Custom1":"", "Custom2":"", "Custom3":"",
"Custom4":"", "Custom5":"", "Custom6":"", "Custom7":"", "Custom8":"", "Custom9":"",
"Custom10":"", "Custom11":"", "Custom12":"", "Custom13":"", "Custom14":"",
"Custom15":"", "Custom16":"", "Custom17":"", "Custom18":"", "Custom19":"",
"Custom20":"", "BusinessID":0, "RegionID":0
}
Updating a ContactRead
 Request
 PUT /api/odata/ContactReads(1)
 Content-Type 
 application/json
 Request body
 {
"ID":"0","TimeRead":"0.00000","DisplayName":"Example Display Name",
"FirstName":"Example First Name","LastName":"Example Last Name","Email":"Example Email","ActiveState":false,"CreationDate":"2014-10-30T12:00:00.000Z","Shared":false,"OwnerID":"0","CategoryID":"0","StageID":
"0","Company":"Example Company","WebAddress":"Example Web Address","Title":
"Example Title","FileAs":"","Source":"0","Notes":"", "Custom1":"", "Custom2":"",
"Custom3":"", "Custom4":"", "Custom5":"", "Custom6":"", "Custom7":"", "Custom8":
"", "Custom9":"", "Custom10":"", "Custom11":"", "Custom12":"", "Custom13":"",
"Custom14":"", "Custom15":"", "Custom16":"", "Custom17":"", "Custom18":"",
"Custom19":"", "Custom20":"", "BusinessID":"0", "RegionID":"0"
}
 Response Headers
 HTTP/1.1 204 No Content
Getting all ContactReads
 Request
 GET /api/odata/ContactReads
 Content-Type
 application/json
 Response body
 "value":[{
"ID":0,"TimeRead":0.00000,"DisplayName":"Example Display Name","FirstName":
"Example First Name","LastName":"Example Last Name","Email":"Example Email","ActiveState":false,"CreationDate":"2014-10-30T12:00:00.000Z","Shared":false,"OwnerID":0,"CategoryID":0,"StageID":0,
"Company":"Example Company","WebAddress":"Example Web Address","Title":
"Example Title","FileAs":"","Source":0,"Notes":"", "Custom1":"", "Custom2":"",
"Custom3":"", "Custom4":"", "Custom5":"", "Custom6":"", "Custom7":"",
"Custom8":"", "Custom9":"", "Custom10":"", "Custom11":"", "Custom12":"",
"Custom13":"", "Custom14":"", "Custom15":"", "Custom16":"", "Custom17":"",
"Custom18":"", "Custom19":"", "Custom20":"", "BusinessID":0, "RegionID":0
},{
"ID":1,"TimeRead":0.00000,"DisplayName":"Example Display Name","FirstName":
"Example First Name","LastName":"Example Last Name","Email":"Example Email","ActiveState":false,"CreationDate":"2014-10-31T12:00:00.000Z","Shared":false,"OwnerID":"0","CategoryID":"0","StageID":
"0","Company":"Example Company","WebAddress":"Example Web Address","Title":
"Example Title","FileAs":"","Source":0,"Notes":"", "Custom1":"", "Custom2":"",
"Custom3":"", "Custom4":"", "Custom5":"", "Custom6":"", "Custom7":"",
"Custom8":"", "Custom9":"", "Custom10":"", "Custom11":"", "Custom12":"",
"Custom13":"", "Custom14":"", "Custom15":"", "Custom16":"", "Custom17":"",
"Custom18":"", "Custom19":"", "Custom20":"", "BusinessID":0, "RegionID":0
}]