Skip to main content

Object Definition Mailing

Object definition mailing​

PropertyTypeDescription
IDGuidThe ID of the mailing
AccountIDGuidThe accountID of the mailing
NameStringThe name of the mailing or the language of the multilanguage variant
FromNameStringThe from name to use in your mailing. Leave null if you want to use the email address only.
FromAddressIDGuidThe ID of the from address you want to send with. Make sure this address is verified first.
ReplyToAddressIDGuidThe ID of the address you want the recipient to reply to when he clicks the reply button. Make sure this address is verified first.
SubjectStringThe subject of your mailing. The subject can include merge fields as well, for example: Hi {{ Recipient.FirstName }}, see this awesome mail!
MailingStateInt (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.

MailingTypeInt (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

TemplateObjectThe template for this mailing. See the template object definition
CreatedOnDateTimeWhen the mailing was created in CET
CreatedOnUtcDateTimeWhen the mailing was created in UTC
ModifiedOnDateTimeWhen the mailing was last modified in CET
ModifiedOnUtcDateTimeWhen the mailing was last modified in UTC
DeletedOnDateTimeWhen the mailing was deleted in CET
DeletedOnUtcDateTimeWhen the mailing was deleted in UTC

Object definition statistics​

PropertyTypeDescription
MailingIDGuidThe ID of the mailing
TotalIntTotal number of recipients
StatisticsArray of objectStatistiscs per state, see statistic object definition

Object definition statistic​

PropertyTypeDescription
StatusIDIntThe ID of status
StatusStringThe name of the status
NumberOfItemsIntNumber of items with this status