API Docs / Schemas / EmailSummaryDto

EmailSummaryDto

Lightweight email summary for list responses

Properties

Name Type Description
idstring

Unique message identifier

Unique message identifier

tenantCodestring

Tenant code the email belongs to

Tenant code the email belongs to

subjectstring

Email subject line

Email subject line

recipientEmailstring

Primary recipient email address (first To recipient)

Primary recipient email address (first To recipient)

recipientNamestring

Primary recipient display name (first To recipient)

Primary recipient display name (first To recipient)

fromEmailstring

Sender email address

Sender email address

fromNamestring

Sender display name

Sender display name

statusenum

Represents the status of an email message

Queued Processing Sent Failed Cancelled

Represents the status of an email message

Queued Processing Sent Failed Cancelled

lastErrorstring

Last error message if the email failed

Last error message if the email failed

metadatastring

JSON metadata associated with the email

JSON metadata associated with the email

externalReferencestring

External reference from the calling application

External reference from the calling application

createdDatestring

When the email was created

When the email was created

sentAtstring

When the email was sent (null if not yet sent)

When the email was sent (null if not yet sent)

retryCountinteger

Number of retry attempts made

Number of retry attempts made

maxRetryCountinteger

Maximum number of retry attempts allowed

Maximum number of retry attempts allowed

JSON Example

{
  "id": "00000000-0000-0000-0000-000000000000",
  "tenantCode": "string",
  "subject": "string",
  "recipientEmail": "string",
  "recipientName": "string"
}

Contained in Schemas