Skip to Content

Restore deleted addressbook object.

Brings a deleted object back into this addressbook under its own id, href and UID, byte-identical. For a meeting this mailbox organizes, the body's SEQUENCE is then advanced by one and a fresh REQUEST is sent to its attendees (the delete sent them a CANCEL), unless notify=false; an attendee's copy is restored locally and nothing is sent. Owner only, write scope.

openemail.addressbookObjects.restore(
  identityId: string,
  addressbookId: string,
  objectId: string,
  options?: CallOptions,
): ApiPromise<PimObjectRestored>

It calls POST /identities/{identityId}/addressbooks/{addressbookId}/trash/{objectId}/restore: Restore deleted addressbook object in the API reference.

Example

const pimObjectRestored = await openemail.addressbookObjects.restore(identityId, addressbookId, objectId)

Arguments

ArgumentTypeDescription
identityIdstringMailbox identity ULID. The path's {identityId}.
addressbookIdstringLive collection ULID or its name slug. The path's {addressbookId}.
objectIdstringThe trashed object's ULID (the id it had while live). The path's {objectId}.

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, PimObjectRestored. 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
404not_found: no such deleted object in this collection, no such live collection, or mailbox not accessible
409href_taken: a live object holds the deleted one's href; uid_conflict: a live object holds its UID (conflictHref names it); unsupported_component: the calendar no longer accepts the deleted object's component
503scheduling_unavailable: preparation could not complete; nothing restored. Or temporary_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)
507scheduling_backlog_full or too_many_objects: the scheduling or object cap; nothing restored

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: PimObjectRestored.