Skip to Content

Change a scheduled send's release time.

Moves WHEN a pending scheduled send fires. The message itself is untouched — same draft, same delivery id, same recipients — so this is not the draft-replacing 'edit in place' the design rules out; editing the MESSAGE remains cancel + resubmit. Pending sends only: once a release has started its legs may already be on the wire, and moving the time would neither recall them nor stop it.

openemail.scheduled.reschedule(
  mailboxId: string,
  scheduleId: string,
  body: ScheduledRescheduleBody,
  options?: CallOptions,
): ApiPromise<ScheduledSend>

It calls PATCH /mailboxes/{mailboxId}/scheduled/{scheduleId}: Change a scheduled send's release time in the API reference.

Example

const scheduledSend = await openemail.scheduled.reschedule(mailboxId, scheduleId, { sendAt: 1 })

Arguments

ArgumentTypeDescription
mailboxIdstringMailbox ULID identifier. The path's {mailboxId}.
scheduleIdstringScheduled send ULID identifier. The path's {scheduleId}.
bodyScheduledRescheduleBodyThe request's body.

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

StatusWhat it means
400send_at_in_past or send_at_too_far
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Mailbox or schedule not found
409cannot_unsend (release already started), schedule_failed, or already_canceled
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
503temporary_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

ScheduledRescheduleBody

/** The body of `scheduled.reschedule`. */
type ScheduledRescheduleBody = {
  /** New release time, epoch seconds. Must be in the future and within the same horizon a schedule may be created at. */
  sendAt: number
}

It names these types of the API, each on a page of its own: ScheduledSend.