Types

DistributionListSend

One email sent to a distribution list. Delivery completes after the send is created, and the status and counts update as it proceeds.

idrequired
string (uuid)
The send id.
statusrequired
string
Where delivery is. queued: accepted, nothing sent yet. sending: emails are being created. sent: every recipient has been dealt with and at least one email was created. failed: every recipient has been dealt with and no email was created, or the sending jobs failed.One of: queued, sending, sent, failed
recipient_countrequired
integer
How many active members the list had when the send was made.
email_countrequired
integer
How many emails have been created so far.
failed_countrequired
integer
How many recipients no email could be created for, such as users who cannot be contacted, plus any lost to a failed job.
errorrequired
string | null
Why the send failed, or the last job error. Null while nothing has gone wrong.
deal_idsrequired
string (uuid)[]
The deals the email presented, in the order they were sent.
created_byrequired
string | null (uuid)
The user who made the send.
created_atrequired
string (date-time)
When the send was made.
updated_atrequired
string | null (date-time)
When the send last progressed.

Used by (3)