Entity Description:
An email address that is created by a user will automatically be entered into PoliteMail as a Contact. A Contacts information can be added to PoliteMail manually, edited for content, added to a mailing list, or deleted from PoliteMail.
Properties
| Name | Description | Type | Additional Information |
| ID | Int32 | ||
| DisplayName | String | ||
| FirstName | String | ||
| LastName | String | ||
| String | |||
| ActiveState | Boolean | ||
| 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 | Inbt32 | ||
| ListID | Int32 |
Entity Statement
| Creating a Contact | |
| Request | |
| POST /ssv3/odata/Contacts | |
| Content-Type | |
| application/json | |
| Request body | |
| { “ID”:”0″,”DisplayName”:”Example Display Name”,”FirstName”: “Example First Name”,”LastName”:”Example Last Name”,”Email”: “Example Email”,”ActiveState”:false, “CreationDate”:”2014-01-29T12:40:26.135Z”, “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”,”ListID”:”0” } |
|
| Response body | |
| { “ID”:1,”DisplayName”:”Example Display Name”,”FirstName”: “Example First Name”,”LastName”:”Example Last Name”, “Email”:”Example Email”,”ActiveState”:false,”CreationDate”: “2014-02-02T11:14:06.135Z”,”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, ”ListID”:0 } |
|
Deleting a Contact |
|
| Request | |
| DELETE /ssv3/odata/Contacts(1) | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
Getting a Contact |
|
| Request | |
| GET /ssv3/odata/Contacts(1) | |
| Content-Type | |
| application/json | |
| Response body | |
| { “ID”:1,”DisplayName”:”Example Display Name”,”FirstName”: “Example First Name”,”LastName”:”Example Last Name”, “Email”:”Example Email”,”ActiveState”:false,”CreationDate”: “2014-02-02T11:14:06.135Z”,”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, ”ListID”:0 } |
|
Updating a Contact |
|
| Request | |
| PUT /ssv3/odata/Contacts(1) | |
| Content-Type | |
| application/json | |
| Request body | |
| { “ID”:”0″,”DisplayName”:”Example Display Name”,”FirstName”: “Example First Name”,”LastName”:”Example Last Name”,”Email”: “Example Email”,”ActiveState”:false,”CreationDate”: “2014-01-29T12:40:26.135Z”,”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”,”ListID”:”0” } |
|
| Response Headers | |
| HTTP/1.1 204 No Content | |
Getting all Contacts |
|
| Request | |
| GET /ssv3/odata/Contacts | |
| Content-Type | |
| application/json | |
| Response body | |
| “value”:[{ “ID”:0,”DisplayName”:”Example Display Name”,”FirstName”: “Example First Name”,”LastName”:”Example Last Name”,”Email”: “Example Email”,”ActiveState”:false,”CreationDate”: “2014-01-29T12:40:26.135Z”,”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,”ListID”:0 },{ “ID”:1,”DisplayName”:”Example Display Name”,”FirstName”: “Example First Name”,”LastName”:”Example Last Name”,”Email”:”Example Email”, “ActiveState”:false,”CreationDate”:”2014-02-02T11:14:06.135Z”, “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, ”ListID”:0 }] |
|
