Skip to main content
API version 2024.0 A standard representation of a file request, as returned from any file request API endpoints by default.
​
id
string
example: 42037322The unique identifier for this file request.
​
type
string
example: file_requestThe value will always be file_request.Value is always file_request
​
created_at
string(date-time)
example: 2020-09-28T10:53:43-08:00The date and time when the file request was created.
​
created_by
User (Mini)object
The user who created this file request.
​
description
string
example: Following documents are requested for your processThe 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.
​
etag
string
example: 1The 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.
​
expires_at
string(date-time)
example: 2020-09-28T10:53:43-08:00The date after which a file request will no longer accept new submissions.After this date, the status will automatically be set to inactive.
​
folder
Folder (Mini)object
The folder that this file request is associated with.Files submitted through the file request form will be uploaded to this folder.
​
is_description_required
boolean
example: trueWhether 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.
​
is_email_required
boolean
example: trueWhether 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.
​
status
string
example: activeThe 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.Value is one of active,inactive
​
title
string
example: Please upload documentsThe 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.
​
updated_at
string(date-time)
example: 2020-09-28T10:53:43-08:00The date and time when the file request was last updated.
​
updated_by
User (Mini)object
The user who last modified this file request.
​
url
string
example: /f/19e57f40ace247278a8e3d336678c64aThe generated URL for this file request. This URL can be shared with users to let them upload files to the associated folder.
{
  "id": "42037322",
  "type": "file_request",
  "created_at": "2020-09-28T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "description": "Following documents are requested for your process",
  "etag": "1",
  "expires_at": "2020-09-28T10:53:43-08:00",
  "folder": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "is_description_required": true,
  "is_email_required": true,
  "status": "active",
  "title": "Please upload documents",
  "updated_at": "2020-09-28T10:53:43-08:00",
  "updated_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "url": "/f/19e57f40ace247278a8e3d336678c64a"
}