v4

latestSwagger 2.02026-08-0343714211.7 MB

bundles

Bundles

Update Share Link

patch/bundles/{id}

Path parameters

idinteger required

Bundle ID.

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

Bundle expiration date/time

password_protectedboolean

Is this bundle password protected?

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.

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?

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,
  "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,
  "paths": [
    "file.txt"
  ],
  "bundlepaths": [
    {
      "recursive": true,
      "path": "example"
    }
  ]
}