Entity Description:
ScheduledSend functions as a delay mechanism for email messages that will be sent at a specified date and time.
Properties
| Name | Description | Type | Additional Information |
| ID | Int32 | ||
| OwnerID | Int32 | ||
| SendDate | DateTime | ||
| HtmlBody | String | ||
| TextBody | String | ||
| Subject | String | ||
| FromName | String | ||
| FromEmail | String | ||
| CampaignID | Int32 | ||
| PersonalizedFields | String | ||
| ReplyToName | String | ||
| ReplyToEmail | String | ||
| Enabled | Boolean | ||
| SendAnonymous | Boolean | ||
| SendAggregate | Boolean | ||
| RecipientCount | Int32 | ||
| BusinessID | Int32 | ||
| RegionID | Int32 |
Entity Statement
| Creating a ScheduledSend | |
| Request | |
| POST /ssv3/odata/ScheduledSends | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","OwnerID":"0","SendDate":"2014-11-19T17:48:26.155Z", "HtmlBody":"Example HTML Body","TextBody":"Example Text Body", "Subject":"Example Subject","FromName":"Example Name","FromEmail": "Example Email","CampaignID":"0","PersonalizedFields":"","ReplyToName": "Example Name","ReplyToEmail":"Example Email","Enabled":false, "SendAnonymous":false,"SendAggregate":false,"RecipientCount":"0", "BusinessID":"0","RegionID":"0" } |
|
| Response body | |
| { "ID":1,"OwnerID":"0","SendDate":"2014-11-20T11:48:26.155Z", "HtmlBody":"Example HTML Body","TextBody":"Example Text Body", "Subject":"Example Subject","FromName":"Example Name","FromEmail": "Example Email","CampaignID":0,"PersonalizedFields":"","ReplyToName": "Example Name","ReplyToEmail":"Example Email","Enabled":false, "SendAnonymous":false,"SendAggregate":false,"RecipientCount":0, "BusinessID":0,"RegionID":0 } |
|
| Deleting a ScheduledSend | |
| Request | |
| DELETE /ssv3/odata/ScheduledSends(1) | |
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting a ScheduledSend | |
| Request | |
| GET /ssv3/odata/ScheduledSends(1) | |
| Content-Type | |
| application/json | |
| Response body | |
| { "ID":1,"OwnerID":"0","SendDate":"2014-11-20T11:48:26.155Z", "HtmlBody":"Example HTML Body","TextBody":"Example Text Body", "Subject":"Example Subject","FromName":"Example Name","FromEmail": "Example Email","CampaignID":0,"PersonalizedFields":"","ReplyToName": "Example Name","ReplyToEmail":"Example Email","Enabled":false, "SendAnonymous":false,"SendAggregate":false,"RecipientCount":0, "BusinessID":0,"RegionID":0 } |
|
| Updating a ScheduledSend | |
| Request | |
| PUT /ssv3/odata/ScheduledSends(1) | |
| Content-Type | |
| application/json | |
| Request body | |
| { "ID":"0","OwnerID":"0","SendDate":"2014-11-19T17:48:26.155Z", "HtmlBody":"Example HTML Body","TextBody":"Example Text Body", "Subject":"Example Subject","FromName":"Example Name", "FromEmail":"Example Email","CampaignID":"0","PersonalizedFields": "","ReplyToName":"Example Name","ReplyToEmail":"Example Email", "Enabled":false, "SendAnonymous":false,"SendAggregate":false, "RecipientCount":"0", "BusinessID":"0","RegionID":"0" } |
|
| Response Headers | |
| HTTP/1.1 204 No Content | |
| Getting all Lists | |
| Request | |
| GET /ssv3/odata/ScheduledSends | |
| Content-Type | |
| application/json | |
| Response body | |
|
"value":[{ "ID":0,"OwnerID":0,"SendDate":"2014-11-19T17:48:26.155Z","HtmlBody": "Example HTML Body","TextBody":"Example Text Body","Subject":"Example Subject","FromName":"Example Name","FromEmail":"Example Email","CampaignID":0,"PersonalizedFields":"","ReplyToName":"Example Name","ReplyToEmail":"Example Email","Enabled":false, "SendAnonymous":false,"SendAggregate":false,"RecipientCount":0, "BusinessID":0,"RegionID":0 },{ "ID":1,"OwnerID":"0","SendDate":"2014-11-20T11:48:26.155Z","HtmlBody": "Example HTML Body","TextBody":"Example Text Body","Subject":"Example Subject","FromName":"Example Name","FromEmail":"Example Email","CampaignID":0,"PersonalizedFields":"","ReplyToName":"Example Name","ReplyToEmail":"Example Email","Enabled":false, "SendAnonymous":false,"SendAggregate":false,"RecipientCount":0, "BusinessID":0,"RegionID":0 }] |
|
