Skip to Content

Add multiple patterns to an address list.

Imports a batch of address and domain patterns into an address list. Invalid patterns are skipped and reported in the response.

openemail.accountAddressLists.addEntries(
  accountId: string,
  listId: string,
  body: AccountAddressListsAddEntriesBody,
  options?: CallOptions,
): ApiPromise<AddressListBatchResult>

It calls POST /accounts/{accountId}/lists/{listId}/entries/batch: Add multiple patterns to an address list in the API reference.

Example

const addressListBatchResult = await openemail.accountAddressLists.addEntries(accountId, listId, { entries: [{ pattern: '*@example.com' }] })

Arguments

ArgumentTypeDescription
accountIdstringAccount identifier. The path's {accountId}.
listIdstringList id. The path's {listId}.
bodyAccountAddressListsAddEntriesBodyThe 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, AddressListBatchResult. 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_full
413too_large: JSON request body exceeds 2 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

AccountAddressListsAddEntriesBody

/** The body of `accountAddressLists.addEntries`. */
type AccountAddressListsAddEntriesBody = {
  /** Array of pattern entries to add */
  entries: AccountAddressListsAddEntriesBodyEntriesItem[]
}

AccountAddressListsAddEntriesBodyEntriesItem

/** The API's `AccountAddressListsAddEntriesBodyEntriesItem`, as the document describes it. */
type AccountAddressListsAddEntriesBodyEntriesItem = {
  /** Epoch seconds after which the entry stops applying (must be in the future); omit or null for never. A repeat add replaces the previous expiry. */
  expiresAt?: number | null
  /** Display-only note */
  note?: string
  /** Address pattern: `jo@acme.example`, `@acme.example` (stored `*@acme.example`), `sales-*@acme.example`, or `@.acme.example` for a domain and its subdomains */
  pattern: string
}

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