Scheduled Sends

Deferred outbound sends: emails, replies, workflow step sends, document requests, data forms, document approvals and broadcasts scheduled for a later dispatch time. Rows are created by passing scheduledAt to the normal send endpoints; these endpoints list, reschedule, edit, dispatch-now and cancel them. Used by the Requests page Scheduled tab.

OpenAPI Spec

Guides Operations Schemas

GET List Scheduled Sends
Returns a paged list of scheduled sends, scoped to the send types the caller has permission to manage. Defaults to pending rows (Scheduled and Failed)...
/tenants/{tenant}/scheduled-sends
GET Get Scheduled Send
Returns a scheduled send including its stored payload, used to prefill the edit dialogs. Raw uploaded attachments are represented by blob metadata rat...
/tenants/{tenant}/scheduled-sends/{code}
PUT Update Scheduled Send
Reschedules a pending scheduled send and optionally replaces its editable payload content. Routing references (task/step, document request, form, broa...
/tenants/{tenant}/scheduled-sends/{code}
POST Send Scheduled Send Now
Dispatches a pending scheduled send immediately instead of waiting for its scheduled time. Also the retry action for Failed rows.
/tenants/{tenant}/scheduled-sends/{code}/send-now
POST Cancel Scheduled Send
Cancels a pending scheduled send. A held draft document request stays Draft; a scheduled broadcast returns to Draft and becomes editable again.
/tenants/{tenant}/scheduled-sends/{code}/cancel