ScheduledSendDto

A pending, dispatched, cancelled or failed scheduled send, as shown on the Scheduled list

Properties

Name	Type	Description
code	string	Unique code identifying the scheduled send
Unique code identifying the scheduled send
sendType	enum	MailboxEmail MailboxSend MailboxReply WorkflowStep DocumentRequestOpen DataFormSend DataFormBulkSend DocumentApproval EmailBroadcast
MailboxEmail MailboxSend MailboxReply WorkflowStep DocumentRequestOpen DataFormSend DataFormBulkSend DocumentApproval EmailBroadcast
status	enum	Scheduled Dispatching Sent Cancelled Failed
Scheduled Dispatching Sent Cancelled Failed
scheduledAt	string	UTC instant at which the send becomes due for dispatch
UTC instant at which the send becomes due for dispatch
displaySubject	string	Subject/title captured at schedule time for display
Subject/title captured at schedule time for display
displayRecipients	string	Recipient summary captured at schedule time for display
Recipient summary captured at schedule time for display
client	CodeAndNameDto
task	CodeAndNameDto
createdByUser	CodeAndNameDto
createdDate	string	When the send was scheduled
When the send was scheduled
dispatchedAt	string	When the send was dispatched (success or failure). Null while pending.
When the send was dispatched (success or failure). Null while pending.
failureReason	string	Why dispatch failed, when Status is Failed
Why dispatch failed, when Status is Failed

{
  "code": "string",
  "sendType": "MailboxEmail",
  "status": "Scheduled",
  "scheduledAt": "2024-01-01T00:00:00Z",
  "displaySubject": "string"
}