---
title: "Update Share Link"
method: PATCH
path: "/bundles/{id}"
tags: ["bundles", "Bundles"]
---

# Update Share Link

`PATCH /bundles/{id}`

Update Share Link

## Path parameters

- `id` integer, required

## Response `200`

The Bundles object.

- BundleEntity — BundleEntity model
  - `code` string — Bundle code. This code forms the end part of the Public URL.
  - `color_left` string — Page link and button color
  - `color_link` string — Top bar link color
  - `color_text` string — Page link and button color
  - `color_top` string — Top bar background color
  - `color_top_text` string — Top bar text color
  - `url` string — Public URL of Share Link
  - `description` string — Public description
  - `expires_at` string, date-time — Bundle expiration date/time
  - `password_protected` boolean — Is this bundle password protected?
  - `permissions` 'read' | 'write' | 'read_write' | 'full' | 'none' | 'preview_only' — Permissions that apply to Folders in this Share Link.
  - `preview_only` boolean
  - `require_registration` boolean — Show a registration page that captures the downloader's name and email address?
  - `require_share_recipient` boolean — Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
  - `require_logout` boolean — 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_body` string — Legal text that must be agreed to prior to accessing Bundle.
  - `form_field_set` FormFieldSetEntity — FormFieldSetEntity model
    - `id` integer — Form field set id
    - `title` string — Title to be displayed
    - `form_layout` integer[] — Layout of the form
    - `form_fields` FormFieldEntity[] — Associated form fields
      - `id` integer — Form field id
      - `label` string — Label to be displayed
      - `required` boolean — Is this a required field?
      - `help_text` string — Help text to be displayed
      - `field_type` 'text' | 'text_area' | 'dropdown' | 'radio' | 'date' — Type of Field
      - `options_for_select` string[] — Options to display for radio and dropdown
      - `default_option` string — Default option for radio and dropdown
      - `form_field_set_id` integer — Form field set id
    - `skip_name` boolean — Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    - `skip_email` boolean — Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    - `skip_company` boolean — Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    - `in_use` boolean — Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
  - `skip_name` boolean — BundleRegistrations can be saved without providing name?
  - `skip_email` boolean — BundleRegistrations can be saved without providing email?
  - `start_access_on_date` string, date-time — Date when share will start to be accessible. If `nil` access granted right after create.
  - `skip_company` boolean — BundleRegistrations can be saved without providing company?
  - `id` integer — Bundle ID
  - `bypasses_site_expiration_rules` boolean — If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this.
  - `created_at` string, date-time — Bundle created at date/time
  - `deleted` boolean — Indicates if the bundle has been deleted.
  - `deleted_at` string, date-time — Bundle deleted at date/time
  - `dont_separate_submissions_by_folder` boolean — 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_uses` integer — Maximum number of times bundle can be accessed
  - `internal_name` string — Internal name for identifying this Share Link.
  - `note` string — Bundle internal note
  - `path_template` string — 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_zone` string — Timezone to use when rendering timestamps in path templates.
  - `send_email_receipt_to_uploader` boolean — Send delivery receipt to the uploader. Note: For writable share only
  - `snapshot_id` integer — ID of the snapshot containing this bundle's contents.
  - `user_id` integer — Bundle creator user ID
  - `username` string — Bundle creator username
  - `group_id` integer — Owning group ID. If set, members of this group can view, edit, and share this Share Link.
  - `clickwrap_id` integer — ID of the clickwrap to use with this bundle.
  - `inbox_id` integer — ID of the associated inbox, if available.
  - `watermark_attachment` ImageEntity
    - `name` string — Image name
    - `uri` string — Image URI
  - `watermark_value` object — Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
  - `send_one_time_password_to_recipient_at_registration` boolean — 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_id` integer — Workspace ID. `0` means the default workspace.
  - `has_inbox` boolean — Does this bundle have an associated inbox?
  - `dont_allow_folders_in_uploads` boolean — Should folder uploads be prevented?
  - `paths` string[] — A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
  - `bundlepaths` BundlePathEntity[] — A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
    - `recursive` boolean — Allow access to subfolders content?
    - `path` string — The path to the resource relative to filesystem.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `405` — Method Not Allowed
- `409` — Conflict
- `412` — Precondition Failed
- `422` — Unprocessable Entity
- `423` — Locked
- `429` — Too Many Requests

---

[API](https://skmtc.net/files/apis/files-com-api.md) · [All operations](https://skmtc.net/files/apis/files-com-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/files/files-com-api/versions/c80c746637fd/schema)