scheduled.get
Get a scheduled send.
Returns the details and delivery status of a specific scheduled email send.
openemail.scheduled.get(
mailboxId: string,
scheduleId: string,
options?: CallOptions,
): ApiPromise<ScheduledSend>It calls GET /mailboxes/{mailboxId}/scheduled/{scheduleId}: Get a scheduled send in the API reference.
Example
const scheduledSend = await openemail.scheduled.get(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, ScheduledSend. 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 |
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
It names these types of the API, each on a page of its own: ScheduledSend.