scheduled.cancel
Cancel a scheduled send.
Cancels a pending scheduled send. The draft message is preserved as an editable draft in the mailbox.
openemail.scheduled.cancel(
mailboxId: string,
scheduleId: string,
options?: CallOptions,
): ApiPromise<ScheduledCancelResult>It calls POST /mailboxes/{mailboxId}/scheduled/{scheduleId}/cancel: Cancel a scheduled send in the API reference.
Example
const result = await openemail.scheduled.cancel(mailboxId, scheduleId)Arguments
| Argument | Type | Description |
|---|---|---|
mailboxId | string | Mailbox ULID identifier. The path's {mailboxId}. |
scheduleId | string | Scheduled send ULID identifier. The path's {scheduleId}. |
Options
It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
Awaited, it is the API's JSON, ScheduledCancelResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | Mailbox or schedule not found |
409 | cannot_unsend (release already started) or schedule_failed |
503 | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |
A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.
Types
ScheduledCancelResult
/** What `scheduled.cancel` answers. */
type ScheduledCancelResult = {
/** True if scheduled send was canceled */
canceled: boolean
}