Skip to content
English
  • There are no suggestions because the search field is empty.

Box Data Targets

Overview

DataBlend supports the following data targets for creating and modifying records in Box.

Configuration

Box Data Target

Setting

Required/ Optional

Description

 Name

 Required

 Descriptive free-text name for the collector.

Query

Required

Select the query that will generate the data for this target.
See the relevant target type documentation for additional details on what query columns are required for your target.

Query Mode

Required

Choose New unless you have a reason for choosing Latest or Specific.

Credential

Required

Select a Dropbox Credential from the list.

Object Type

Required

Select from the pre-populated drop-down menu.

To learn more about Box API requirements, please visit Add classification to file - API Reference - Box Developer Documentation.
 

Advanced

History Retention

History Retention (Days) allows users to decide how long they want the information from their data targets to be stored. This field is optional.

Timeout (seconds)

The Timeout section allows users to determine if they would like to timeout collections taking longer than a set number of seconds to collect data.

Skip If No Records Found

The “Skip if No Records Found” button is used to eliminate sending information to Data Targets unnecessarily. Simply enable the “Skip if No Records Found” toggle. The use of this toggle is optional.

Agent

Run As allows users to select from a drop-down list of users to run the Workflow. This is optional. Please note that Run As is only available to Admin users. If a user is set as the Run As and then demoted to a Member, the user which demoted the Run As user will instead be set as the Run As.

Run As

Run As allows users to select from a drop-down list of users to run the Workflow. This is optional.

 

Collaborations

Manages collaborations (sharing permissions) on Box files and folders.

Input Column Used By Description
operationType Create, Update, Delete `create`, `update`, or `delete`
id Update, Delete Collaboration ID
itemId Create File or folder ID to share
itemType Create `file` or `folder`
accessibleById Create User or group ID to grant access to
accessibleByType Create `user` or `group`
accessibleByLogin Create Email address of the user (alternative to `accessibleById` for users)
role Create, Update Access level (see table below)
canViewPath Create, Update `true` or `false` — whether the collaborator can see the folder path
expiresAt Create, Update Expiration date in ISO 8601 format
notify Create, Update `true` or `false` — send a notification email
status Update Collaboration status

Available roles:

Role Description
co-owner Full access, can manage collaborators
editor Can edit, upload, download, and preview
viewer uploader Can view and upload but not edit
viewer Can view and download
previewer uploader Can preview and upload
previewer Can preview only
uploader Can upload only

 

File Requests

Manages Box File Requests.

Input Column Used By Description
operationType Copy, Update, Delete `copy`, `update`, or `delete`
fileRequestId Copy, Update, Delete Box file request ID
folderId Copy, Update, Delete Destination folder ID for the copied file request
title Copy File request title
description Copy, Update File request description
status Copy, Update `active` or `inactive`
isEmailRequired Copy, Update `true` or `false`
isDescriptionRequired Copy, Update `true` or `false`
expiresAt Copy, Update Expiration date in ISO 8601 format (e.g., `2025-12-31T23:59:59Z`)

 

Files

Manages existing Box files.

Input Column Used By Description
operationType Copy, Update, Delete `copy`, `update`, or `delete`
fileId Copy, Update, Delete Box file ID
destinationFolderId Copy Destination folder ID
name Update New file name
description Update New file description
parentId Update New parent folder ID (moves the file)
tags Update Tags, separated by pipe (`|`). Example: `finance|Q4|report
sharedLinkAccessType Update `open`, `company`, or `collaborators`
sharedLinkPassword Update Password for the shared link
sharedLinkVanityName Update Custom vanity URL name
canDownload Update `true` or `false` - shared link download permission
canEdit Update `true` or `false` - shared link edit permission

 

Transfer Folder

Transfers ownership of a user's entire Box account contents to another user. This is an administrative operation typically used during employee offboarding.

Input Column Description
sourceUserId Box user ID of the current owner.
destinationUserId Box user ID of the new owner.
notify (Optional) `true` or `false` — whether to notify the destination user. Defaults to `false`.

Warning: This transfers all content from the source user's account. This action cannot be easily undone.

 

Upload Files

Uploads files to Box.

Mode 1 - Direct upload (single file):

The input stream is uploaded directly as a single file.

Setting Description
Folder ID Box folder ID where the file will be uploaded.
File Name Name for the uploaded file.
Use Collection Results Disabled.

Mode 2 - Batch upload from data:

Each row in the data is uploaded as a separate file.

Setting  Description
Use Collection Results Enabled.
Input Column Description
id Identifier for the file
version Version identifier
folderId Box folder ID for the upload destination
fileName Name for the uploaded file
data File content, Base64-encoded

Note: Files larger than 50 MB are automatically uploaded using Box's chunked upload API. No configuration is needed - Datablend handles this transparently.

 

Common Concepts

Nested Fields

When Box returns nested data (e.g., a file's owner), the fields are flattened using dot notation. For example:
```json
{
  "owned\_by": {
    "id": "12345",
    "name": "Jane Smith"
  }
}```
Becomes two columns: `owned_by.id` and `owned_by.name`.
Array values are stored as JSON strings (e.g., `["tag1", "tag2"]`).

Rate Limiting

Box enforces API rate limits. If the plugin hits a rate limit (HTTP 429), it automatically waits and retries with exponential backoff. No action is required on your part, but large operations may take longer as a result.

Duplicate Handing

When a datasink receives multiple rows with the same identifier and operation type, duplicates are automatically skipped. Only the first occurrence is processed.