Share Links

A Bundle is the API/SDK term for the feature called Share Links in the web interface. The API provides the full set of actions related to Share Links, including sending them via E-Mail.

Please note that we very closely monitor the E-Mailing feature and any abuse will result in disabling of your site.

XML Element

<filescom:list-share-links />

Authorization Requirement

Available to all authenticated keys or sessions.

Example Operation

<filescom:list-share-links config-ref="FilesCom" />

Example Response Payload

[
  {
    "code": "abc123",
    "colorLeft": "#0066a7",
    "colorLink": "#d34f5d",
    "colorText": "#0066a7",
    "colorTop": "#000000",
    "colorTopText": "#ffffff",
    "url": "https://subdomain.files.com/f/12345678",
    "description": "The public description of the bundle.",
    "expiresAt": "2000-01-01T01:00:00Z",
    "passwordProtected": false,
    "permissions": "read",
    "previewOnly": false,
    "requireRegistration": false,
    "requireShareRecipient": false,
    "requireLogout": true,
    "clickwrapBody": "[Legal text]",
    "formFieldSet": {
      "id": 1,
      "title": "Sample Form Title",
      "formLayout": [
        1,
        2,
        3,
        4
      ],
      "formFields": [
        {
          "id": 1,
          "label": "Sample Label",
          "required": true,
          "helpText": "Help Text",
          "fieldType": "text",
          "optionsForSelect": [
            "red",
            "green",
            "blue"
          ],
          "defaultOption": "red",
          "formFieldSetId": 1
        }
      ],
      "skipName": true,
      "skipEmail": true,
      "skipCompany": true,
      "inUse": true
    },
    "skipName": true,
    "skipEmail": true,
    "startAccessOnDate": "2000-01-01T01:00:00Z",
    "skipCompany": true,
    "id": 1,
    "bypassesSiteExpirationRules": true,
    "createdAt": "2000-01-01T01:00:00Z",
    "deleted": true,
    "deletedAt": "2000-01-01T01:00:00Z",
    "dontSeparateSubmissionsByFolder": true,
    "maxUses": 1,
    "internalName": "Quarterly reports",
    "note": "The internal note on the bundle.",
    "pathTemplate": "{{name}}_{{ip}}",
    "pathTemplateTimeZone": "Eastern Time (US & Canada)",
    "sendEmailReceiptToUploader": true,
    "snapshotId": 1,
    "userId": 1,
    "username": "user",
    "groupId": 1,
    "clickwrapId": 1,
    "inboxId": 1,
    "watermarkAttachment": {
      "name": "My logo",
      "uri": "https://mysite.files.com/.../my_image.png"
    },
    "watermarkValue": {
      "key": "example value"
    },
    "sendOneTimePasswordToRecipientAtRegistration": true,
    "workspaceId": 1,
    "hasInbox": true,
    "dontAllowFoldersInUploads": true,
    "requestedUploadSlots": [
      "example"
    ],
    "paths": [
      "file.txt"
    ],
    "bundlepaths": [
      {
        "recursive": true,
        "path": "example"
      }
    ]
  }
]

XML Element

<filescom:show-share-link />

Authorization Requirement

Available to all authenticated keys or sessions.

Parameter	Description
id Long Required	Bundle ID.

Example Operation

<filescom:show-share-link config-ref="FilesCom" id="1" />

Example Response Payload

{
  "code": "abc123",
  "colorLeft": "#0066a7",
  "colorLink": "#d34f5d",
  "colorText": "#0066a7",
  "colorTop": "#000000",
  "colorTopText": "#ffffff",
  "url": "https://subdomain.files.com/f/12345678",
  "description": "The public description of the bundle.",
  "expiresAt": "2000-01-01T01:00:00Z",
  "passwordProtected": false,
  "permissions": "read",
  "previewOnly": false,
  "requireRegistration": false,
  "requireShareRecipient": false,
  "requireLogout": true,
  "clickwrapBody": "[Legal text]",
  "formFieldSet": {
    "id": 1,
    "title": "Sample Form Title",
    "formLayout": [
      1,
      2,
      3,
      4
    ],
    "formFields": [
      {
        "id": 1,
        "label": "Sample Label",
        "required": true,
        "helpText": "Help Text",
        "fieldType": "text",
        "optionsForSelect": [
          "red",
          "green",
          "blue"
        ],
        "defaultOption": "red",
        "formFieldSetId": 1
      }
    ],
    "skipName": true,
    "skipEmail": true,
    "skipCompany": true,
    "inUse": true
  },
  "skipName": true,
  "skipEmail": true,
  "startAccessOnDate": "2000-01-01T01:00:00Z",
  "skipCompany": true,
  "id": 1,
  "bypassesSiteExpirationRules": true,
  "createdAt": "2000-01-01T01:00:00Z",
  "deleted": true,
  "deletedAt": "2000-01-01T01:00:00Z",
  "dontSeparateSubmissionsByFolder": true,
  "maxUses": 1,
  "internalName": "Quarterly reports",
  "note": "The internal note on the bundle.",
  "pathTemplate": "{{name}}_{{ip}}",
  "pathTemplateTimeZone": "Eastern Time (US & Canada)",
  "sendEmailReceiptToUploader": true,
  "snapshotId": 1,
  "userId": 1,
  "username": "user",
  "groupId": 1,
  "clickwrapId": 1,
  "inboxId": 1,
  "watermarkAttachment": {
    "name": "My logo",
    "uri": "https://mysite.files.com/.../my_image.png"
  },
  "watermarkValue": {
    "key": "example value"
  },
  "sendOneTimePasswordToRecipientAtRegistration": true,
  "workspaceId": 1,
  "hasInbox": true,
  "dontAllowFoldersInUploads": true,
  "requestedUploadSlots": [
    "example"
  ],
  "paths": [
    "file.txt"
  ],
  "bundlepaths": [
    {
      "recursive": true,
      "path": "example"
    }
  ]
}

XML Element

<filescom:create-share-link />

Authorization Requirement

Available to all authenticated keys or sessions.

Parameter	Description
paths List<String> Required	A list of paths to include in this bundle.
password String	Password for this bundle.
expiresAt String	Bundle expiration date/time
maxUses Long	Maximum number of times bundle can be accessed
description String	Public description
note String	Bundle internal note
permissions String	Permissions that apply to Folders in this Share Link. Possible values: `read`, `write`, `read_write`, `full`, `none`, `preview_only`
requireRegistration boolean	Show a registration page that captures the downloader's name and email address?

Example Operation

<filescom:create-share-link config-ref="FilesCom"
 paths='#[["file.txt"]]'
 password="Password"
 expiresAt="2000-01-01T01:00:00Z"
 maxUses="1"
 description="The public description of the bundle."
 note="The internal note on the bundle."
 permissions="read"
 requireRegistration="false"
/>

Example Response Payload

{
  "code": "abc123",
  "colorLeft": "#0066a7",
  "colorLink": "#d34f5d",
  "colorText": "#0066a7",
  "colorTop": "#000000",
  "colorTopText": "#ffffff",
  "url": "https://subdomain.files.com/f/12345678",
  "description": "The public description of the bundle.",
  "expiresAt": "2000-01-01T01:00:00Z",
  "passwordProtected": false,
  "permissions": "read",
  "previewOnly": false,
  "requireRegistration": false,
  "requireShareRecipient": false,
  "requireLogout": true,
  "clickwrapBody": "[Legal text]",
  "formFieldSet": {
    "id": 1,
    "title": "Sample Form Title",
    "formLayout": [
      1,
      2,
      3,
      4
    ],
    "formFields": [
      {
        "id": 1,
        "label": "Sample Label",
        "required": true,
        "helpText": "Help Text",
        "fieldType": "text",
        "optionsForSelect": [
          "red",
          "green",
          "blue"
        ],
        "defaultOption": "red",
        "formFieldSetId": 1
      }
    ],
    "skipName": true,
    "skipEmail": true,
    "skipCompany": true,
    "inUse": true
  },
  "skipName": true,
  "skipEmail": true,
  "startAccessOnDate": "2000-01-01T01:00:00Z",
  "skipCompany": true,
  "id": 1,
  "bypassesSiteExpirationRules": true,
  "createdAt": "2000-01-01T01:00:00Z",
  "deleted": true,
  "deletedAt": "2000-01-01T01:00:00Z",
  "dontSeparateSubmissionsByFolder": true,
  "maxUses": 1,
  "internalName": "Quarterly reports",
  "note": "The internal note on the bundle.",
  "pathTemplate": "{{name}}_{{ip}}",
  "pathTemplateTimeZone": "Eastern Time (US & Canada)",
  "sendEmailReceiptToUploader": true,
  "snapshotId": 1,
  "userId": 1,
  "username": "user",
  "groupId": 1,
  "clickwrapId": 1,
  "inboxId": 1,
  "watermarkAttachment": {
    "name": "My logo",
    "uri": "https://mysite.files.com/.../my_image.png"
  },
  "watermarkValue": {
    "key": "example value"
  },
  "sendOneTimePasswordToRecipientAtRegistration": true,
  "workspaceId": 1,
  "hasInbox": true,
  "dontAllowFoldersInUploads": true,
  "requestedUploadSlots": [
    "example"
  ],
  "paths": [
    "file.txt"
  ],
  "bundlepaths": [
    {
      "recursive": true,
      "path": "example"
    }
  ]
}

XML Element

<filescom:update-share-link />

Authorization Requirement

Available to all authenticated keys or sessions.

Parameter	Description
id Long Required	Bundle ID.
expiresAt String	Bundle expiration date/time
permissions String	Permissions that apply to Folders in this Share Link. Possible values: `read`, `write`, `read_write`, `full`, `none`, `preview_only`

Example Operation

<filescom:update-share-link config-ref="FilesCom"
 id="1"
 expiresAt="2000-01-01T01:00:00Z"
 permissions="read"
/>

Example Response Payload

{
  "code": "abc123",
  "colorLeft": "#0066a7",
  "colorLink": "#d34f5d",
  "colorText": "#0066a7",
  "colorTop": "#000000",
  "colorTopText": "#ffffff",
  "url": "https://subdomain.files.com/f/12345678",
  "description": "The public description of the bundle.",
  "expiresAt": "2000-01-01T01:00:00Z",
  "passwordProtected": false,
  "permissions": "read",
  "previewOnly": false,
  "requireRegistration": false,
  "requireShareRecipient": false,
  "requireLogout": true,
  "clickwrapBody": "[Legal text]",
  "formFieldSet": {
    "id": 1,
    "title": "Sample Form Title",
    "formLayout": [
      1,
      2,
      3,
      4
    ],
    "formFields": [
      {
        "id": 1,
        "label": "Sample Label",
        "required": true,
        "helpText": "Help Text",
        "fieldType": "text",
        "optionsForSelect": [
          "red",
          "green",
          "blue"
        ],
        "defaultOption": "red",
        "formFieldSetId": 1
      }
    ],
    "skipName": true,
    "skipEmail": true,
    "skipCompany": true,
    "inUse": true
  },
  "skipName": true,
  "skipEmail": true,
  "startAccessOnDate": "2000-01-01T01:00:00Z",
  "skipCompany": true,
  "id": 1,
  "bypassesSiteExpirationRules": true,
  "createdAt": "2000-01-01T01:00:00Z",
  "deleted": true,
  "deletedAt": "2000-01-01T01:00:00Z",
  "dontSeparateSubmissionsByFolder": true,
  "maxUses": 1,
  "internalName": "Quarterly reports",
  "note": "The internal note on the bundle.",
  "pathTemplate": "{{name}}_{{ip}}",
  "pathTemplateTimeZone": "Eastern Time (US & Canada)",
  "sendEmailReceiptToUploader": true,
  "snapshotId": 1,
  "userId": 1,
  "username": "user",
  "groupId": 1,
  "clickwrapId": 1,
  "inboxId": 1,
  "watermarkAttachment": {
    "name": "My logo",
    "uri": "https://mysite.files.com/.../my_image.png"
  },
  "watermarkValue": {
    "key": "example value"
  },
  "sendOneTimePasswordToRecipientAtRegistration": true,
  "workspaceId": 1,
  "hasInbox": true,
  "dontAllowFoldersInUploads": true,
  "requestedUploadSlots": [
    "example"
  ],
  "paths": [
    "file.txt"
  ],
  "bundlepaths": [
    {
      "recursive": true,
      "path": "example"
    }
  ]
}

XML Element

<filescom:delete-share-link />

Authorization Requirement

Available to all authenticated keys or sessions.

Parameter	Description
id Long Required	Bundle ID.

Example Operation

<filescom:delete-share-link config-ref="FilesCom" id="1" />

List Share Links

XML Element

Authorization Requirement

Show Share Link

XML Element

Authorization Requirement

Create Share Link

XML Element

Authorization Requirement

Update Share Link

XML Element

Authorization Requirement

Delete Share Link

XML Element

Authorization Requirement