FIfiles
bundle_recipients
Bundle Recipients

Create Share Link Recipient

Changed on

Create Share Link Recipient

post/bundle_recipients

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/bundle_recipients
  • Auth
    none declared

Request body multipart/form-data

user_idinteger

User ID. Provide a value of 0 to operate the current session's user.

bundle_idinteger required

Bundle to share.

recipientstring required

Email addresses to share this bundle with.

namestring

Name of recipient.

companystring

Company of recipient.

notestring

Note to include in email.

share_after_createboolean

Set to true to share the link with the recipient upon creation.

Example request

{
  "recipient": "johndoe@gmail.com",
  "name": "John Smith",
  "company": "Acme Ltd",
  "note": "Just a note."
}

Response

The BundleRecipients object.

companystring

The recipient's company.

namestring

The recipient's name.

notestring

A note sent to the recipient with the bundle.

recipientstring

The recipient's email address.

sent_atstring date-time

When the Bundle was shared with this recipient.

workspace_idinteger

Workspace ID. 0 means the default workspace.

Example response

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

Changes