Skip to Content

Update pattern route.

Updates the priority, delivery pacing, or destination configuration for a pattern route.

openemail.patterns.update(
  patternId: number,
  body?: PatternsUpdateBody,
  options?: CallOptions,
): ApiPromise<Pattern>

It calls PATCH /patterns/{patternId}: Update pattern route in the API reference.

Example

const pattern = await openemail.patterns.update(patternId, {})

Arguments

ArgumentTypeDescription
patternIdnumberPattern route numeric ID. The path's {patternId}.
bodyPatternsUpdateBodyOptional. The 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, Pattern. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed, invalid_address (malformed remoteAddress), empty_patch, destination_requires_type, unknown_mailbox (missing, inaccessible, or outside the pattern domain's account, including platform domains), webhook_format_unavailable, invalid_alias_address, alias_target_unresolvable, destination_is_self, destination_loops, or destination_chain_too_long
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Pattern not found or not accessible to this principal
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

PatternsUpdateBody

/** The body of `patterns.update`. */
type PatternsUpdateBody = {
  aliasAddress?: string
  destinationType?: ('mailbox' | 'webhook' | 'remote' | 'alias')
  mailboxId?: string
  /** Pace inbound deliveries to this pattern's mailbox through the paced queue (funnel protection). Mailbox patterns only; ignored at delivery time for other destination types. */
  paced?: boolean
  /** Routing priority order (higher priority matches first) */
  priority?: number
  remoteAddress?: string
  webhookFormat?: ('parsed' | 'reference')
  webhookSecret?: string | null
  webhookUrl?: string
}

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