ShareRecipient Data Type

Reference to the recipient of a shared item.

Type can be one of user, group. external_user, public. public_link. If type is public or public_link, ID and hrek are not applicable.

Properties
name data type description
email string The email address of the recipient. Only applies when type is external_user.
Properties inherited from Recipient
type string Type of the recipient.

For assigned permissions, allowed values are:

  • user
  • group

For share recipients, allowed values are:

  • user
  • group
  • external_user
  • public
  • public_link
Properties inherited from LongIdLinkPair
id number The ID of the resource.
href string The path to the resource. This is relative to the root of the REST API (https://serveraddress/rest).

Example

{
  "email" : "...",
  "type" : "...",
  "id" : 12345,
  "href" : "..."
}