Entity Description:
The List entity is a user created list containing user contacts from, an imported list, or from within the Inbox and Sent Items folders.
Properties
| Name | Description | Type | Additional Information |
| ID | Int32 | ||
| Name | String | ||
| Description | String | ||
| IsNewsletter | Int32 | ||
| Shared | Boolean | ||
| CreationDate | DateTime | ||
| ActiveState | Int16 | ||
| IsAnonymous | Boolean | ||
| GUID | 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 List | |
| Request | |
| POST /api/odata/Lists | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","Name":"New List","Description":"Example Description", "IsNewsletter":"0","Shared":false, "CreationDate":"2014-11-19T17:48:26.155Z","ActiveState":"1","IsAnonymous":false,"BusinessID": "0","RegionID":"0" } | |
| Response body | |
| { "ID":1,"Name":"New List","Description":"Example Description", "IsNewsletter":0,"Shared":false, "CreationDate":"2014-11-19T23:00:00.000Z","ActiveState":1,"IsAnonymous":false, "BusinessID":0,"RegionID":0 } | |
| Deleting a List | |
| Request | |
| DELETE /api/odata/Lists(1) | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting a List | |
| Request | |
| GET /api/odata/Lists(1) | |
| Content-Type | |
| application/json | |
| Response body | |
| { "ID":1,"Name":"New List","Description":"Example Description", "IsNewsletter":0,"Shared":false, "CreationDate":"2014-11-19T23:00:00.000Z","ActiveState":1,"IsAnonymous":false, "BusinessID":0,"RegionID":0 } | |
| Updating a List | |
| Request | |
| PUT /api/odata/Lists(1) | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","Name":"New List","Description":"Example Description", "IsNewsletter":"0","Shared":false, "CreationDate":"2014-11-19T17:48:26.155Z","ActiveState":"1","IsAnonymous":false, "BusinessID":"0","RegionID":"0" } | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting all Lists | |
| Request | |
| GET /api/odata/Lists | |
| Content-Type | |
| application/json | |
| Response body | |
| "value":[{ "ID":0,"Name":"New List","Description":"Example Description", "IsNewsletter":0,"Shared":false, "CreationDate":"2014-11-19T17:48:26.155Z","ActiveState":1,"IsAnonymous":false, "BusinessID":0,"RegionID":0 },{ "ID":1,"Name":"New List","Description":"Example Description", "IsNewsletter":0,"Shared":false, "CreationDate":"2014-11-19T23:00:00.000Z","ActiveState":1,"IsAnonymous":false, "BusinessID":0,"RegionID":0 }] | |
