action files_post_bundles { label: "Create Bundle" description: "Create Bundle" provider: files method: POST path: "/bundles" encoding: json output: { type: "object" description: "Create Bundle" properties: { clickwrap_body: { type: "string" description: "Legal text that must be agreed to prior to accessing Bundle." } clickwrap_id: { type: "integer" format: "int32" description: "ID of the clickwrap to use with this bundle." } code: { type: "string" description: "Bundle code. This code forms the end part of the Public URL." } created_at: { type: "string" format: "date-time" description: "Bundle created at date/time" } description: { type: "string" description: "Public description" } dont_separate_submissions_by_folder: { type: "boolean" description: "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_at: { type: "string" format: "date-time" description: "Bundle expiration date/time" } form_field_set: { type: "object" description: "List Form Field Sets" properties: { form_fields: { type: "array" description: "Associated form fields" items: { type: "object" properties: { default_option: { type: "string" description: "Default option for radio and dropdown" } field_type: { type: "string" description: "Type of Field" enum: ["text", "text_area", "dropdown", "radio"] } form_field_set_id: { type: "integer" format: "int32" description: "Form field set id" } help_text: { type: "string" description: "Help text to be displayed" } id: { type: "integer" format: "int32" description: "Form field id" } label: { type: "string" description: "Label to be displayed" } options_for_select: { type: "array" description: "Options to display for radio and dropdown" items: { type: "string" } } required: { type: "boolean" description: "Is this a required field?" } } } } form_layout: { type: "array" description: "Layout of the form" items: { type: "integer" format: "int32" } } id: { type: "integer" format: "int32" description: "Form field set id" } skip_company: { type: "boolean" description: "Any associated InboxRegistrations or BundleRegistrations can be saved without providing company" } skip_email: { type: "boolean" description: "Any associated InboxRegistrations or BundleRegistrations can be saved without providing email" } skip_name: { type: "boolean" description: "Any associated InboxRegistrations or BundleRegistrations can be saved without providing name" } title: { type: "string" description: "Title to be displayed" } } } has_inbox: { type: "boolean" description: "Does this bundle have an associated inbox?" } id: { type: "integer" format: "int32" description: "Bundle ID" } inbox_id: { type: "integer" format: "int32" description: "ID of the associated inbox, if available." } max_uses: { type: "integer" format: "int32" description: "Maximum number of times bundle can be accessed" } note: { type: "string" description: "Bundle internal note" } password_protected: { type: "boolean" description: "Is this bundle password protected?" } path_template: { type: "string" description: "Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data." } paths: { type: "array" description: "A list of paths in this bundle" items: { type: "string" } } permissions: { type: "string" description: "Permissions that apply to Folders in this Share Link." enum: ["read", "write", "read_write", "full", "none", "preview_only"] } preview_only: { type: "boolean" description: "Restrict users to previewing files only?" } require_registration: { type: "boolean" description: "Show a registration page that captures the downloader's name and email address?" } require_share_recipient: { type: "boolean" description: "Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?" } send_email_receipt_to_uploader: { type: "boolean" description: "Send delivery receipt to the uploader. Note: For writable share only" } skip_company: { type: "boolean" description: "BundleRegistrations can be saved without providing company?" } skip_email: { type: "boolean" description: "BundleRegistrations can be saved without providing email?" } skip_name: { type: "boolean" description: "BundleRegistrations can be saved without providing name?" } url: { type: "string" description: "Public URL of Share Link" } user_id: { type: "integer" format: "int32" description: "Bundle creator user ID" } username: { type: "string" description: "Bundle creator username" } watermark_attachment: { type: "object" properties: { name: { type: "string" description: "Image name" } uri: { type: "string" description: "Image URI" } } } watermark_value: { type: "object" description: "Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value" } } } }