Copy file request

post
https://api.box.com/2.0
/file_requests/:file_request_id/copy/

Copies an existing file request that is already present on one folder, and applies it to another folder.

Request

Bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
123

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.

Request Body

stringin bodyoptional
Please upload required documents

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.

string / date-timein bodyoptional
2020-09-28T10:53:43-08:00

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.

objectin body

The folder to associate the new file request to.

stringin bodyrequired
42037322

The ID of the folder to associate the new file request to.

booleanin bodyoptional
true

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.

booleanin bodyoptional
true

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.

stringin bodyoptional
active

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.

Value is one of active,inactive

stringin bodyoptional
Please upload required documents

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.

Response

application/jsonFile Request

Returns updated file request object.

application/jsonClient error

Returned when the access token provided in the Authorization header is not recognized or not provided.

application/jsonClient error

Returned if the user does not have all the permissions to complete the update.

  • access_denied_insufficient_permissions when the authenticated user does not have access to update the file request.
application/jsonClient error

Returned if the file request is not found, or the user does not have access to the associated folder.

application/jsonClient error

Returned if the file_request_id is not in a recognized format.

application/jsonClient error

An unexpected client error.

post
Copy file request
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

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"
       }
     }'

Response Example

{
  "id": 42037322,
  "type": "file-request",
  "created_at": "2020-09-28T10:53:43-08:00",
  "created_by": {
    "id": 11446498,
    "type": "user",
    "login": "ceo@example.com",
    "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": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "url": "https://cloud.app.box.com/f/19e57f40ace247278a8e3d336678c64a"
}