ScheduledSend
The ScheduledSend type of the TypeScript SDK, which messages.send and 5 more methods take or answer.
type ScheduledSend = {
attempts: number
createdAt: number
deferrals: number
deliveryId: string
error: string | null
finishedAt: number | null
messageId: string
recipients: string[]
releaseAt: number
result: ScheduledLegResult[] | null
scheduleId: string
sendAt: number
state: ('pending' | 'releasing' | 'sent' | 'failed' | 'canceled')
threadId: string | null
}Fields
| Field | Type | Description |
|---|---|---|
attempts | number | Number of delivery attempts made |
createdAt | number | Creation timestamp in epoch seconds |
deferrals | number | Number of deferrals encountered |
deliveryId | string | Idempotency key for this submission |
error | string | null | Error reason if sending failed or was canceled, or null |
finishedAt | number | null | Completion timestamp in epoch seconds, or null if pending |
messageId | string | Draft message ULID scheduled for sending |
recipients | string[] | List of target recipient email addresses |
releaseAt | number | Actual scheduled release time in epoch seconds |
result | ScheduledLegResult[] | null | Per-recipient delivery outcomes, or null if pending |
scheduleId | string | Scheduled send ULID |
sendAt | number | Requested send time in epoch seconds |
state | ('pending' | 'releasing' | 'sent' | 'failed' | 'canceled') | Current scheduling status |
threadId | string | null | Associated conversation thread ID, or null |
Used by
| Method | What it does |
|---|---|
messages.send | Send an email message |
messages.sendDraft | Send a stored draft |
threads.reply | Reply to a conversation thread |
scheduled.list | List scheduled sends |
scheduled.get | Get a scheduled send |
scheduled.reschedule | Change a scheduled send's release time |