Types

SentEmail

One email the token organisation sent. body_html and body_text appear only with include=body.

idrequired
string (uuid)
The email id.
subjectrequired
string | null
The subject line.
statusrequired
string
Where the email is in sending.One of: queued, sending, sent, failed, suppressed, retry_scheduled
templaterequired
string | null
The template the email was rendered from.
sender_emailrequired
string | null
The address the email was sent from.
sender_namerequired
string | null
The name the email was sent as.
source_typerequired
string | null
What produced the email, such as invite, notification or deal_promotion.One of: distribution, invite, notification, deal_promotion, workflow, account, custom
source_labelrequired
string | null
A label for what produced the email, such as the promotion name.
deal_idsrequired
string (uuid)[]
The deals the email was about.
recipient_countrequired
integer
How many recipients the email went to, including copied recipients.
opensrequired
integer
How many times recipients opened the email, summed over every recipient.
clicksrequired
integer
How many links recipients clicked, summed over every recipient.
sent_atrequired
string | null (date-time)
When the email first went to a recipient. Null until then.
body_html
string | null
The rendered HTML body.
body_text
string | null
The plain text body.
created_atrequired
string (date-time)
When the email was queued.
updated_atrequired
string | null (date-time)
When the email last changed.

Used by (2)