Share Link Recipients

A BundleRecipient is a person who has had a bundle shared with them via email invite. A Bundle can be re-shared with a Bundle Recipient by sending a create request with the inbox_id, recipient email address, and share_after_create => true.

List Share Link Recipients

XML Element

<filescom:list-share-link-recipients />

Authorization Requirement

Available to all authenticated keys or sessions.

ParameterDescription
bundleId
Long
Required		List recipients for the bundle with this ID.

Example Operation

<filescom:list-share-link-recipients config-ref="FilesCom" bundleId="1" />

Example Response Payload

[
  {
    "company": "Acme Inc.",
    "name": "John Doe",
    "note": "Some note.",
    "recipient": "john.doe@example.com",
    "sentAt": "2000-01-01T01:00:00Z",
    "workspaceId": 1
  }
]

Create Share Link Recipient

XML Element

<filescom:create-share-link-recipient />

Authorization Requirement

Available to all authenticated keys or sessions.

ParameterDescription
bundleId
Long
Required		Bundle to share.
recipient
String
Required		Email addresses to share this bundle with.
name
String		Name of recipient.
company
String		Company of recipient.
note
String		Note to include in email.

Example Operation

<filescom:create-share-link-recipient config-ref="FilesCom"
 bundleId="1"
 recipient="johndoe@gmail.com"
 name="John Smith"
 company="Acme Ltd"
 note="Just a note."
/>

Example Response Payload

{
  "company": "Acme Inc.",
  "name": "John Doe",
  "note": "Some note.",
  "recipient": "john.doe@example.com",
  "sentAt": "2000-01-01T01:00:00Z",
  "workspaceId": 1
}