Skip to Content

Update an address list.

Renames an address list and/or sets contactsExempt (inbound block lists only). Scope, direction and verdict are immutable.

openemail.accountAddressLists.update(
  accountId: string,
  listId: string,
  body: AccountAddressListsUpdateBody,
  options?: CallOptions,
): ApiPromise<AddressList>

It calls PATCH /accounts/{accountId}/lists/{listId}: Update an address list in the API reference.

Example

const addressList = await openemail.accountAddressLists.update(accountId, listId, {})

Arguments

ArgumentTypeDescription
accountIdstringAccount identifier. The path's {accountId}.
listIdstringList id. The path's {listId}.
bodyAccountAddressListsUpdateBodyThe 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, AddressList. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed, or invalid_pattern
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
403account_credentials_required — a mailbox credential may mutate inbound lists only; outbound lists are administrator-managed
404not_found — the account, mailbox, scope or list is not accessible
409list_name_taken
413too_large: JSON request body exceeds 1 MiB or 500,000 values (object keys included), checked before parsing
503temporary_failure (with Retry-After): the directory version does not yet support this write; retry

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

AccountAddressListsUpdateBody

/** The body of `accountAddressLists.update`. */
type AccountAddressListsUpdateBody = {
  /** Inbound block lists only: let the receiving mailbox's contacts through this list's catch-all */
  contactsExempt?: boolean
  /** New list name */
  name?: string
}

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