Skip to Content

Grant calendar access.

Grants read or write access to a mailbox for a calendar collection.

openemail.calendars.grantAccess(
  identityId: string,
  calendarId: string,
  shareeIdentityId: string,
  body: CalendarsGrantAccessBody,
  options?: CallOptions,
): ApiPromise<PimShare>

It calls PUT /identities/{identityId}/calendars/{calendarId}/shares/{shareeIdentityId}: Grant calendar access in the API reference.

Example

const pimShare = await openemail.calendars.grantAccess(identityId, calendarId, shareeIdentityId, { permission: 'read' })

Arguments

ArgumentTypeDescription
identityIdstringMailbox identity ULID. The path's {identityId}.
calendarIdstringCollection ULID or its name slug. The path's {calendarId}.
shareeIdentityIdstringThe grantee's mailbox identity ULID. The path's {shareeIdentityId}.
bodyCalendarsGrantAccessBodyThe 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, PimShare. 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, sharee, or mailbox
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

CalendarsGrantAccessBody

/** The body of `calendars.grantAccess`. */
type CalendarsGrantAccessBody = {
  /** Permission level ('read' or 'write') */
  permission: ('read' | 'read-write')
}

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