Skip to content

List scheduled deliveries

GET
/mail/mailboxes/{mailbox}/scheduled
curl --request GET \
--url https://mail.work.optidata.cloud/api/mail/mailboxes/78/scheduled \
--header 'Authorization: Bearer <token>'

Every delivery still in play for the mailbox — those waiting, those being sent right now, and those that failed — ordered by delivery time.

Requires scheduled sending to be enabled for the tenant.

mailbox
required
integer

Id of the mailbox. Every mailbox the caller may use is listed in their account.

The active scheduled deliveries.

Media typeapplication/json
Array<object>

A draft waiting for its delivery time.

object
id
integer
draft_id
integer
mailbox_id
integer
scheduled_at

When the message will be sent.

string
timezone

The time zone the user chose the moment in.

string
status

Where a scheduled delivery stands.

string
Allowed values: pending processing sent failed cancelled
sent_at
string | null
attempts

How many delivery attempts have been made.

integer
last_error

Why the last attempt failed, when one did.

string | null
created_at
string
updated_at
string
Examples
Examplepending
[
{
"id": 44,
"draft_id": 918,
"mailbox_id": 78,
"scheduled_at": "2026-08-20T09:00:00.000000Z",
"timezone": "America/Sao_Paulo",
"status": "pending",
"sent_at": null,
"attempts": 0,
"last_error": null,
"created_at": "2026-08-19T13:10:00.000000Z",
"updated_at": "2026-08-19T13:10:00.000000Z"
}
]

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
"error": "JWT passport exception: Missing bearer token in request"
}

Scheduled sending is not enabled for this tenant.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Exampledisabled
{
"message": "Not available"
}

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
"message": "Too Many Attempts."
}