Skip to Content

Update addressbook.

Updates properties (name, color, description, visibility) for a addressbook collection.

openemail.addressbooks.update(
  identityId: string,
  addressbookId: string,
  body?: AddressbooksUpdateBody,
  options?: CallOptions,
): ApiPromise<PimCollection>

It calls PATCH /identities/{identityId}/addressbooks/{addressbookId}: Update addressbook in the API reference.

Example

const pimCollection = await openemail.addressbooks.update(identityId, addressbookId, {})

Arguments

ArgumentTypeDescription
identityIdstringMailbox identity ULID. The path's {identityId}.
addressbookIdstringCollection ULID or its name slug. The path's {addressbookId}.
bodyAddressbooksUpdateBodyOptional. 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, PimCollection. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
400validation_failed, invalid_name, or invalid_components
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404No such collection, or mailbox not accessible
409name_taken; visibility_conflict (CAS lost); or components_conflict with count of incompatible live and restorable trashed objects. No properties change on refusal.
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

AddressbooksUpdateBody

/** The body of `addressbooks.update`. */
type AddressbooksUpdateBody = {
  color?: string | null
  description?: string | null
  descriptionLang?: string | null
  displayName?: string | null
  /** Access visibility scope */
  expectedVisibility?: ('private' | 'shared' | 'public')
  name?: string
  role?: string | null
  /** Access visibility scope */
  visibility?: ('private' | 'shared' | 'public')
}

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