Skip to main content
POST
/
file_requests
/
{file_request_id}
/
copy
cURL
curl -i -X POST "https://api.box.com/2.0/file_requests/42037322/copy" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "title": "Please upload required documents",
       "description": "Please upload required documents",
       "status": "active",
       "is_email_required": true,
       "is_description_required": false,
       "folder": {
         "id": "2233212",
         "type": "folder"
       }
     }'
{
  "id": "42037322",
  "type": "file_request",
  "folder": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "created_at": "2020-09-28T10:53:43-08:00",
  "updated_at": "2020-09-28T10:53:43-08:00",
  "title": "Please upload documents",
  "description": "Following documents are requested for your process",
  "status": "active",
  "is_email_required": true,
  "is_description_required": true,
  "expires_at": "2020-09-28T10:53:43-08:00",
  "url": "/f/19e57f40ace247278a8e3d336678c64a",
  "etag": "1",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "updated_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  }
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
file_request_id
string
required

The unique identifier that represent a file request.

The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/filerequest/123 the file_request_id is 123.

Body

application/json

The request body to copy a file request. The request body to update a file request.

​
folder
object
required

The folder to associate the new file request to.

​
title
string

An optional new title for the file request. This can be used to change the title of the file request.

This will default to the value on the existing file request.

Example:

"Please upload required documents"

​
description
string

An optional new description for the file request. This can be used to change the description of the file request.

This will default to the value on the existing file request.

Example:

"Please upload required documents"

​
status
enum<string>

An optional new status of the file request.

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 will default to the value on the existing 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 will default to the value on the existing 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 will default to the value on the existing 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.

This will default to the value on the existing file request.

Example:

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

Response

Returns updated file request object.

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

​
id
string
required

The unique identifier for this file request.

Example:

"42037322"

​
type
enum<string>
required

The value will always be file_request.

Available options:
file_request
Example:

"file_request"

​
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"

​
url
string

The generated URL for this file request. This URL can be shared with users to let them upload files to the associated folder.

Example:

"/f/19e57f40ace247278a8e3d336678c64a"

​
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.