API Docs / Schemas / GetMessageResponse

GetMessageResponse

Response for get message request containing full message details

Properties

Name Type Description
messageIdstring

Unique message ID

Unique message ID

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

createdDatestring

When the message was created

When the message was created

processedAtstring

When the message was processed

When the message was processed

sentAtstring

When the message was sent

When the message was sent

retryCountinteger

Number of retry attempts

Number of retry attempts

lastErrorstring

Last error message if any

Last error message if any

externalReferencestring

External reference from calling application

External reference from calling application

subjectstring

Email subject line

Email subject line

fromEmailstring

Sender email address

Sender email address

fromNamestring

Sender display name

Sender display name

replyToEmailstring

Reply-to email address

Reply-to email address

replyToNamestring

Reply-to display name

Reply-to display name

toarray of EmailRecipientDto

List of To recipients

List of To recipients

ccarray of EmailRecipientDto

List of Cc recipients

List of Cc recipients

bccarray of EmailRecipientDto

List of Bcc recipients

List of Bcc recipients

attachmentsarray of EmailAttachmentInfoDto

List of attachments (metadata only, not content)

List of attachments (metadata only, not content)

JSON Example

{
  "messageId": "00000000-0000-0000-0000-000000000000",
  "status": "Queued",
  "createdDate": "2024-01-01T00:00:00Z",
  "processedAt": "2024-01-01T00:00:00Z",
  "sentAt": "2024-01-01T00:00:00Z"
}

Used By Operations