Skip to Content

Sync changes for addressbook.

Returns added, updated, and deleted object delta changes since a previous sync token (RFC 6578 sync-collection).

openemail.addressbooks.getChanges(
  identityId: string,
  addressbookId: string,
  options?: AddressbooksGetChangesOptions,
): ApiPromise<PimChanges>

It calls GET /identities/{identityId}/addressbooks/{addressbookId}/changes: Sync changes for addressbook in the API reference.

Example

const pimChanges = await openemail.addressbooks.getChanges(identityId, addressbookId)

Arguments

ArgumentTypeDescription
identityIdstringMailbox identity ULID. The path's {identityId}.
addressbookIdstringCollection ULID or its name slug. The path's {addressbookId}.

Options

The last argument, options, a AddressbooksGetChangesOptions, takes:

OptionTypeSent asDescription
sincestringquery sinceSync token from previous response (omit for initial sync)
limitnumberquery limitMaximum changes to return

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, PimChanges. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404No such collection, or mailbox not accessible
410invalid_sync_token — token expired or invalid; full resync required
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

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