Entity Description:
Template entity provides users the capability to design professional looking templates that can be used and modified for totally customizable email messages. The templates are saved and can be reused in other mailings.
Properties
| Name | Description | Type | Additional Information |
| ID | Int32 | ||
| ActiveState | Int16 | ||
| Name | String | ||
| Description | String | ||
| OwnerID | Int32 | ||
| Body | String | ||
| BodyBinary | Binary | ||
| Icon | Bitmap | ||
| LastUsed | DateTime | ||
| CreationDate | DateTime | ||
| Subject | String | ||
| Shared | Boolean | ||
| 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 Template | |
| Request | |
| POST /api/odata/Templates | |
| Content-Type | |
| application/json | |
| Request body | |
| { “ID”:”0″,”ActiveState”:”1″,”Name”:”New Template”,”Description”: “Example Description”,”OwnerID”:”0″,”Body”:”Example Body”, “BodyBinary”:”0”, “Icon”:”Example Icon”,”LastUsed”:”2014-12-10T10:48:26.155Z”,”CreationDate”:”2014-12-01T01:00:25.155Z”, “Subject”:”Example Subject”,”Shared”:false,”BusinessID”:”0″,”RegionID”:”0″ } | |
| Response body | |
| { “ID”:1,”ActiveState”:1,”Name”:”New Template”,”Description”:”Example Description”,”OwnerID”:0,”Body”:”Example Body”,”BodyBinary”:0, “Icon”:”Example Icon”,”LastUsed”:”2014-12-09T04:40:08.155Z”, “CreationDate”:”2014-12-08T13:30:25.125Z”,”Subject”:”Example Subject”,”Shared”:false,”BusinessID”:0,”RegionID”:0 } | |
| Deleting a Template | |
| Request | |
| DELETE /api/odata/Templates(1) | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting a Template | |
| Request | |
| GET /api/odata/Templates(1) | |
| Content-Type | |
| application/json | |
| Response body | |
| { “ID”:1,”ActiveState”:1,”Name”:”New Template”,”Description”: “Example Description”,”OwnerID”:0,”Body”:”Example Body”, “BodyBinary”:0, “Icon”:”Example Icon”,”LastUsed”:”2014-12-09T04:40:08.155Z”,”CreationDate”:”2014-12-08T13:30:25.125Z”, “Subject”:”Example Subject”,”Shared”:false,”BusinessID”:0,”RegionID”:0 } | |
| Updating a Template | |
| Request | |
| PUT /api/odata/Templates(1) | |
| Content-Type | |
| application/json | |
| Request body | |
| { “ID”:”0″,”ActiveState”:”1″,”Name”:”New Template”,”Description”: “Example Description”,”OwnerID”:”0″,”Body”:”Example Body”, “BodyBinary”:”0”, “Icon”:”Example Icon”,”LastUsed”:”2014-12-10T10:48:26.155Z”,”CreationDate”:”2014-12-01T01:00:25.155Z”, “Subject”:”Example Subject”,”Shared”:false,”BusinessID”:”0″,”RegionID”:”0″ } | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting all Templates | |
| Request | |
| GET /api/odata/Templates | |
| Content-Type | |
| application/json | |
| Response body | |
| “value”:[{ “ID”:0,”ActiveState”:1,”Name”:”New Template”,”Description”: “Example Description”,”OwnerID”:0,”Body”:”Example Body”, “BodyBinary”:0, “Icon”:”Example Icon”,”LastUsed”:”2014-12-10T10:48:26.155Z”,”CreationDate”:”2014-12-01T01:00:25.155Z”, “Subject”:”Example Subject”,”Shared”:false,”BusinessID”:0,”RegionID”:0 },{ “ID”:1,”ActiveState”:1,”Name”:”New Template”,”Description”: “Example Description”,”OwnerID”:0,”Body”:”Example Body”, “BodyBinary”:0, “Icon”:”Example Icon”,”LastUsed”:”2014-12-09T04:40:08.155Z”,”CreationDate”:”2014-12-08T13:30:25.125Z”, “Subject”:”Example Subject”,”Shared”:false,”BusinessID”:0,”RegionID”:0 }] | |
