Skip to main content

A standard representation of a file request, as returned from any file request API endpoints by default.

​
folder
Folder (Mini) · object
required

The folder that this file request is associated with.

Files submitted through the file request form will be uploaded to this folder.

​
created_at
string<date-time>
required

The date and time when the file request was created.

Example:

"2020-09-28T10:53:43-08:00"

​
updated_at
string<date-time>
required

The date and time when the file request was last updated.

Example:

"2020-09-28T10:53:43-08:00"

​
title
string

The title of file request. This is shown in the Box UI to users uploading files.

This defaults to title of the file request that was copied to create this file request.

Example:

"Please upload documents"

​
description
string | null

The optional description of this file request. This is shown in the Box UI to users uploading files.

This defaults to description of the file request that was copied to create this file request.

Example:

"Following documents are requested for your process"

​
status
enum<string>

The status of the file request. This defaults to active.

When the status is set to inactive, the file request will no longer accept new submissions, and any visitor to the file request URL will receive a HTTP 404 status code.

This defaults to status of file request that was copied to create this file request.

Available options:
active,
inactive
Example:

"active"

​
is_email_required
boolean

Whether a file request submitter is required to provide their email address.

When this setting is set to true, the Box UI will show an email field on the file request form.

This defaults to setting of file request that was copied to create this file request.

Example:

true

​
is_description_required
boolean

Whether a file request submitter is required to provide a description of the files they are submitting.

When this setting is set to true, the Box UI will show a description field on the file request form.

This defaults to setting of file request that was copied to create this file request.

Example:

true

​
expires_at
string<date-time>

The date after which a file request will no longer accept new submissions.

After this date, the status will automatically be set to inactive.

Example:

"2020-09-28T10:53:43-08:00"

​
etag
string | null

The HTTP etag of this file. This can be used in combination with the If-Match header when updating a file request. By providing that header, a change will only be performed on the file request if the etag on the file request still matches the etag provided in the If-Match header.

Example:

"1"

​
created_by
User (Mini) · object

The user who created this file request.

​
updated_by
User (Mini) · object

The user who last modified this file request.