FIfiles
bundles
Bundles

Create Share Link

Changed on

Create Share Link

post/bundles

Request

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

Request body multipart/form-data

user_idinteger

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

pathsstring[] required

A list of paths to include in this bundle.

passwordstring

Password for this bundle.

bypasses_site_expiration_rulesboolean

If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.

form_field_set_idinteger

Id of Form Field Set to use with this bundle

create_snapshotboolean

If true, create a snapshot of this bundle's contents.

dont_separate_submissions_by_folderboolean

Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.

expires_atstring date-time

Explicit Bundle expiration date/time. If not set, the site-wide expiration setting may apply.

finalize_snapshotboolean

If true, finalize the snapshot of this bundle's contents. Note that create_snapshot must also be true.

max_usesinteger

Maximum number of times bundle can be accessed

group_idinteger

Owning group ID. If set, members of this group can view, edit, and share this Share Link.

internal_namestring

Internal name for identifying this Share Link.

descriptionstring

Public description

notestring

Bundle internal note

codestring

Bundle code. This code forms the end part of the Public URL.

path_templatestring

Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.

path_template_time_zonestring

Timezone to use when rendering timestamps in path templates.

permissions'read' | 'write' | 'read_write' | 'full' | 'none' | 'preview_only'

Permissions that apply to Folders in this Share Link.

require_registrationboolean

Show a registration page that captures the downloader's name and email address?

clickwrap_idinteger

ID of the clickwrap to use with this bundle.

inbox_idinteger

ID of the associated inbox, if available.

require_share_recipientboolean

Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?

send_one_time_password_to_recipient_at_registrationboolean

If true, require_share_recipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.

send_email_receipt_to_uploaderboolean

Send delivery receipt to the uploader. Note: For writable share only

skip_emailboolean

BundleRegistrations can be saved without providing email?

skip_nameboolean

BundleRegistrations can be saved without providing name?

skip_companyboolean

BundleRegistrations can be saved without providing company?

start_access_on_datestring date-time

Date when share will start to be accessible. If nil access granted right after create.

snapshot_idinteger

ID of the snapshot containing this bundle's contents.

workspace_idinteger

Workspace ID. 0 means the default workspace.

watermark_attachment_filestring binary

Preview watermark image applied to all bundle items.

watermark_valueobject

Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value

Example request

{
  "paths": [
    "file.txt"
  ],
  "password": "Password",
  "bypasses_site_expiration_rules": true,
  "dont_separate_submissions_by_folder": true,
  "expires_at": "2000-01-01T01:00:00Z",
  "max_uses": 1,
  "group_id": 1,
  "internal_name": "Quarterly reports",
  "description": "The public description of the bundle.",
  "note": "The internal note on the bundle.",
  "code": "abc123",
  "path_template": "{{name}}_{{ip}}",
  "path_template_time_zone": "Eastern Time (US & Canada)",
  "permissions": "read",
  "clickwrap_id": 1,
  "inbox_id": 1,
  "send_one_time_password_to_recipient_at_registration": true,
  "send_email_receipt_to_uploader": true,
  "skip_email": true,
  "skip_name": true,
  "skip_company": true,
  "start_access_on_date": "2000-01-01T01:00:00Z",
  "snapshot_id": 1,
  "workspace_id": 1,
  "watermark_value": {
    "key": "example value"
  }
}

Response

The Bundles object.

codestring

Bundle code. This code forms the end part of the Public URL.

color_leftstring

Page link and button color

color_linkstring

Top bar link color

color_textstring

Page link and button color

color_topstring

Top bar background color

color_top_textstring

Top bar text color

urlstring

Public URL of Share Link

descriptionstring

Public description

expires_atstring date-time

Explicit Bundle expiration date/time. If not set, the site-wide expiration setting may apply.

password_protectedboolean

Is this bundle password protected?

permissions'read' | 'write' | 'read_write' | 'full' | 'none' | 'preview_only'

Permissions that apply to Folders in this Share Link.

preview_onlyboolean
require_registrationboolean

Show a registration page that captures the downloader's name and email address?

require_share_recipientboolean

Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?

require_logoutboolean

If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.

clickwrap_bodystring

Legal text that must be agreed to prior to accessing Bundle.

skip_nameboolean

BundleRegistrations can be saved without providing name?

skip_emailboolean

BundleRegistrations can be saved without providing email?

start_access_on_datestring date-time

Date when share will start to be accessible. If nil access granted right after create.

skip_companyboolean

BundleRegistrations can be saved without providing company?

idinteger

Bundle ID

bypasses_site_expiration_rulesboolean

If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.

created_atstring date-time

Bundle created at date/time

deletedboolean

Indicates if the bundle has been deleted.

deleted_atstring date-time

Bundle deleted at date/time

dont_separate_submissions_by_folderboolean

Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.

effective_expires_atstring date-time

Read-only expiration date/time, using the explicit expiration or the site-wide setting when applicable. Null when the Share Link does not expire.

max_usesinteger

Maximum number of times bundle can be accessed

internal_namestring

Internal name for identifying this Share Link.

notestring

Bundle internal note

path_templatestring

Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, strftime directives, and any custom form data.

path_template_time_zonestring

Timezone to use when rendering timestamps in path templates.

send_email_receipt_to_uploaderboolean

Send delivery receipt to the uploader. Note: For writable share only

snapshot_idinteger

ID of the snapshot containing this bundle's contents.

user_idinteger

Bundle creator user ID

usernamestring

Bundle creator username

group_idinteger

Owning group ID. If set, members of this group can view, edit, and share this Share Link.

clickwrap_idinteger

ID of the clickwrap to use with this bundle.

inbox_idinteger

ID of the associated inbox, if available.

watermark_valueobject

Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value

send_one_time_password_to_recipient_at_registrationboolean

If true, require_share_recipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.

workspace_idinteger

Workspace ID. 0 means the default workspace.

has_inboxboolean

Does this bundle have an associated inbox?

dont_allow_folders_in_uploadsboolean

Should folder uploads be prevented?

requested_upload_slotsobject[]

Upload slots requested by the associated Inbox. Each slot contains a name used as its label and destination subfolder name.

pathsstring[]

A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.

Example response

{
  "code": "abc123",
  "color_left": "#0066a7",
  "color_link": "#d34f5d",
  "color_text": "#0066a7",
  "color_top": "#000000",
  "color_top_text": "#ffffff",
  "url": "https://subdomain.files.com/f/12345678",
  "description": "The public description of the bundle.",
  "expires_at": "2000-01-01T01:00:00Z",
  "permissions": "read",
  "require_logout": true,
  "clickwrap_body": "[Legal text]",
  "form_field_set": {
    "id": 1,
    "title": "Sample Form Title",
    "form_layout": [
      1,
      2,
      3,
      4
    ],
    "form_fields": [
      {
        "id": 1,
        "label": "Sample Label",
        "required": true,
        "help_text": "Help Text",
        "field_type": "text",
        "options_for_select": [
          "red",
          "green",
          "blue"
        ],
        "default_option": "red",
        "form_field_set_id": 1
      }
    ],
    "skip_name": true,
    "skip_email": true,
    "skip_company": true,
    "in_use": true
  },
  "skip_name": true,
  "skip_email": true,
  "start_access_on_date": "2000-01-01T01:00:00Z",
  "skip_company": true,
  "id": 1,
  "bypasses_site_expiration_rules": true,
  "created_at": "2000-01-01T01:00:00Z",
  "deleted": true,
  "deleted_at": "2000-01-01T01:00:00Z",
  "dont_separate_submissions_by_folder": true,
  "effective_expires_at": "2000-01-01T01:00:00Z",
  "max_uses": 1,
  "internal_name": "Quarterly reports",
  "note": "The internal note on the bundle.",
  "path_template": "{{name}}_{{ip}}",
  "path_template_time_zone": "Eastern Time (US & Canada)",
  "send_email_receipt_to_uploader": true,
  "snapshot_id": 1,
  "user_id": 1,
  "username": "user",
  "group_id": 1,
  "clickwrap_id": 1,
  "inbox_id": 1,
  "watermark_attachment": {
    "name": "My logo",
    "uri": "https://mysite.files.com/.../my_image.png"
  },
  "watermark_value": {
    "key": "example value"
  },
  "send_one_time_password_to_recipient_at_registration": true,
  "workspace_id": 1,
  "has_inbox": true,
  "dont_allow_folders_in_uploads": true,
  "requested_upload_slots": [
    "example"
  ],
  "paths": [
    "file.txt"
  ],
  "bundlepaths": [
    {
      "recursive": true,
      "path": "example"
    }
  ]
}

Changes