Object Definition Mailing
Object definition mailing
| Property | Type | Description |
|---|---|---|
| ID | Guid | The ID of the mailing |
| AccountID | Guid | The accountID of the mailing |
| Name | String | The name of the mailing or the language of the multilanguage variant |
| FromName | String | The from name to use in your mailing. Leave null if you want to use the email address only. |
| FromAddressID | Guid | The ID of the from address you want to send with. Make sure this address is verified first. |
| ReplyToAddressID | Guid | The ID of the address you want the recipient to reply to when he clicks the reply button. Make sure this address is verified first. |
| Subject | String | The subject of your mailing. The subject can include merge fields as well, for example: Hi {{ Recipient.FirstName }}, see this awesome mail! |
| MailingState | Int (Enum) |
The state of the mailing 1 = Saved, mailing is saved and can be send later. 2 = Ready for sending, mailing will be send right away or on the scheduled date. 3 = Picked up by queuer, this mailing is currently being picked up to send. 4 = Processed, this mailing has been processed. 5 = Stopped, this mailing has been stopped due to a too high bounce or complaint rate. 6 = OutOfCredits, this mailing has been stopped due to not having enough credits for sending the emails. |
| MailingType | Int (Enum) |
The type of the mailing 1 = Newsletter mailing 2 = Test campaign 3 = Triggered mailing 4 = Test triggered 5 = AB test variation 6 = AB test result 7 = Newsletter language variation 8 = Triggered language variation |
| Template | Object | The template for this mailing. See the template object definition |
| CreatedOn | DateTime | When the mailing was created in CET |
| CreatedOnUtc | DateTime | When the mailing was created in UTC |
| ModifiedOn | DateTime | When the mailing was last modified in CET |
| ModifiedOnUtc | DateTime | When the mailing was last modified in UTC |
| DeletedOn | DateTime | When the mailing was deleted in CET |
| DeletedOnUtc | DateTime | When the mailing was deleted in UTC |
Object definition statistics
| Property | Type | Description |
|---|---|---|
| MailingID | Guid | The ID of the mailing |
| Total | Int | Total number of recipients |
| Statistics | Array of object | Statistiscs per state, see statistic object definition |
Object definition statistic
| Property | Type | Description |
|---|---|---|
| StatusID | Int | The ID of status |
| Status | String | The name of the status |
| NumberOfItems | Int | Number of items with this status |
Updated 8 months ago