Box Developer Documentation

Update file request

put
https://api.box.com/2.0
/file_requests/:file_request_id

Updates a file request. This can be used to activate or deactivate a file request.

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-time)in 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.

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.

Request Headers

stringin headeroptional
1

Ensures this item hasn't recently changed before making changes.

Pass in the item's last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.

Response

application/jsonFile Request

Returns the 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

Returns an error when the If-Match header does not match the current etag value of the file request. This indicates that the file request has changed since it was last requested.

application/jsonClient error

An unexpected client error.

put
Update 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 PUT "https://api.box.com/2.0/file_requests/42037322" \
     -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
     }'
TypeScript Gen
await client.fileRequests.updateFileRequestById(copiedFileRequest.id, {
  title: 'updated title',
  description: 'updated description',
} satisfies FileRequestUpdateRequest);
Python Gen
client.file_requests.update_file_request_by_id(
    copied_file_request.id, title="updated title", description="updated description"
)
.NET Gen
await client.FileRequests.UpdateFileRequestByIdAsync(fileRequestId: copiedFileRequest.Id, requestBody: new FileRequestUpdateRequest() { Title = "updated title", Description = "updated description" });
Swift Gen (Beta)
try await client.fileRequests.updateFileRequestById(fileRequestId: copiedFileRequest.id, requestBody: FileRequestUpdateRequest(title: "updated title", description: "updated description"))
Java
BoxFileRequest fileRequest = new BoxFileRequest(api, "id");
BoxFileRequest.Info fileRequestInfo = fileRequest.new Info();
fileRequestInfo.setDescription("Following documents are requested for your process");
fileRequestInfo.setIsDescriptionRequired(true);
fileRequestInfo.setStatus(BoxFileRequest.Status.ACTIVE);
fileRequestInfo = fileRequest.updateInfo(fileRequestInfo);
Python
from boxsdk.object.file_request import StatusState
update_data = {
    "description": 'Updated description', 
    "is_email_required": True,
    "status": StatusState.ACTIVE
}
file_request.update_info(data=update_data)
.NET
var updateRequest = new BoxFileRequestUpdateRequest
{
    Description = "New file request description",
    Status = BoxFileRequestStatus.inactive
};

BoxFileRequestObject fileRequest = await client.FileRequestsManager.UpdateFileRequestAsync("12345", updateRequest);
Node
client.fileRequests.update(fileRequestId, {
  title: 'Updated title'
}).then((r: FileRequest) => {
  // do something with the updated file request 
  console.log(r)
});
iOS
let updateRequest = FileRequestUpdateRequest(
    title: "Updated file request title",
    description: "Updated file request description",
    status: .inactive,
    isEmailRequired: false,
    isDescriptionRequired: true
)

client.fileRequests.update(fileRequestId: "123456", updateRequest: updateRequest) { result in
    guard case let .success(fileRequest) = result else {
        print("Error updating file request")
        return
    }
    
    print("Updated file request title: \(fileRequest.title ?? "n/a"), description: \(fileRequest.description ?? "n/a")")
}

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": "/f/19e57f40ace247278a8e3d336678c64a"
}