ScheduledSendPayload
The stored payload of a scheduled send — everything needed to replay the underlying send at
dispatch time. Exactly one of the per-type payload sections is populated, matching the row's
SendType. Raw uploaded attachments are offloaded to blob storage at schedule time and
referenced via BlobAttachments; practice document attachments stay as codes and are resolved
at dispatch.
Properties
| Name | Type | Description |
|---|---|---|
| configCode | string | The mailbox (email config) to send from. Null on MailboxSend means automatic routing; |
The mailbox (email config) to send from. Null on MailboxSend means automatic routing; | ||
| SendMailboxEmailRequest | ||
| reply | ReplyMailboxEmailRequest | |
| replyToMessageId | string | The email service message id being replied to, for MailboxReply sends |
The email service message id being replied to, for MailboxReply sends | ||
| taskCode | string | Task code for WorkflowStep sends |
Task code for WorkflowStep sends | ||
| groupNumber | integer | Workflow group number for WorkflowStep sends |
Workflow group number for WorkflowStep sends | ||
| stepNumber | integer | Workflow step number for WorkflowStep sends |
Workflow step number for WorkflowStep sends | ||
| clientCode | string | Client code for DocumentRequestOpen, DataFormSend and DocumentApproval sends |
Client code for DocumentRequestOpen, DataFormSend and DocumentApproval sends | ||
| documentRequestCode | string | Code of the draft document request to open, for DocumentRequestOpen sends |
Code of the draft document request to open, for DocumentRequestOpen sends | ||
| documentRequestOpen | OpenDocumentRequestRequest | |
| dataFormCode | string | Code of the data form to send, for DataFormSend and DataFormBulkSend sends |
Code of the data form to send, for DataFormSend and DataFormBulkSend sends | ||
| dataFormSend | SendDataFormRequest | |
| dataFormBulkSend | BulkSendDataFormRequest | |
| documentApproval | RequestClientApprovalForDocumentsRequest | |
| emailBroadcastCode | string | Code of the broadcast to send, for EmailBroadcast sends |
Code of the broadcast to send, for EmailBroadcast sends | ||
| blobAttachments | array of ScheduledSendBlobAttachment | Raw uploaded attachments offloaded to blob storage at schedule time, |
Raw uploaded attachments offloaded to blob storage at schedule time, | ||
JSON Example
{
"configCode": "string",
"email": {
"subject": "string",
"htmlBody": "string",
"plainTextBody": "string",
"to": [
"..."
],
"cc": [
"..."
]
},
"reply": {
"htmlBody": "string",
"plainTextBody": "string",
"replyAll": false,
"toRecipients": [
"..."
],
"ccRecipients": [
"..."
]
},
"replyToMessageId": "00000000-0000-0000-0000-000000000000",
"taskCode": "string"
}