Skip to Content

The PimShare type of the TypeScript SDK, which calendars.grantAccess and 3 more methods take or answer.

type PimShare = {
  createdAt: number
  permission: ('read' | 'read-write')
  shareeAddress: string | null
  shareeIdentityId: string
}

Fields

FieldTypeDescription
createdAtnumber
permission('read' | 'read-write')Access permission level
shareeAddressstring | nullPrimary email address of the sharee, or null for an address-less identity. Present so a sharing UI can name the grantee without a lookup per grant — the mirror of MailShare.granteeAddress
shareeIdentityIdstringIdentity ULID granted access

Used by

MethodWhat it does
calendars.grantAccessGrant calendar access
calendars.listAccessList calendar access grants
addressbooks.grantAccessGrant addressbook access
addressbooks.listAccessList addressbook access grants

On this page