Bundle 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

Command

files-cli bundle-recipients list

Output

Outputs a list of BundleRecipient objects according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--user-id=
int64		User ID. Provide a value of 0 to operate the current session's user.
--bundle-id=
int64
Required		List recipients for the bundle with this ID.

Additional Arguments

Example Request

files-cli bundle-recipients list \
  --bundle-id=1

Create Share Link Recipient

Command

files-cli bundle-recipients create

Output

Outputs a BundleRecipient object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--user-id=
int64		User ID. Provide a value of 0 to operate the current session's user.
--bundle-id=
int64
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.
--share-after-create
boolean		Set to true to share the link with the recipient upon creation.

Example Request

files-cli bundle-recipients create \
  --bundle-id=1 \
  --recipient="johndoe@gmail.com"

The BundleRecipient Object

Some of the commands above return a BundleRecipient object. The attributes of this object are listed below.

AttributeDescription
company
string		The recipient's company.
name
string		The recipient's name.
note
string		A note sent to the recipient with the bundle.
recipient
string		The recipient's email address.
sent_at
date-time		When the Bundle was shared with this recipient.
workspace_id
int64		Workspace ID. 0 means the default workspace.