Add the power of the Box AI API to your custom apps at Content Cloud Summit on May 15

Learn more and register!

Update a File Request

Update a File Request

To update some of the basic details for an existing file request, all you need is its unique ID.

curl -i -X PUT "" \
     -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
var updateRequest = new BoxFileRequestUpdateRequest
    Description = "New file request description",
    Status = BoxFileRequestStatus.inactive

BoxFileRequestObject fileRequest = await client.FileRequestsManager.UpdateFileRequestAsync("12345", updateRequest);
BoxFileRequest fileRequest = new BoxFileRequest(api, "id");
BoxFileRequest.Info fileRequestInfo = Info();
fileRequestInfo.setDescription("Following documents are requested for your process");
fileRequestInfo = fileRequest.updateInfo(fileRequestInfo);
from boxsdk.object.file_request import StatusState
update_data = {
    "description": 'Updated description', 
    "is_email_required": True,
    "status": StatusState.ACTIVE
client.fileRequests.update(fileRequestId, {
  title: 'Updated title'
}).then((r: FileRequest) => {
  // do something with the updated file request 
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")
    print("Updated file request title: \(fileRequest.title ?? "n/a"), description: \(fileRequest.description ?? "n/a")")
TypeScript (Beta)
await client.fileRequests.updateFileRequestById(, {
  title: 'updated title',
  description: 'updated description',
} satisfies FileRequestUpdateRequest);
Python (Beta)
client.file_requests.update_file_request_by_id(, title='updated title', description='updated description')
.NET (Beta)
await client.FileRequests.UpdateFileRequestByIdAsync(fileRequestId: copiedFileRequest.Id, requestBody: new FileRequestUpdateRequest(title: "updated title", description: "updated description"));

For more details on the different fields that can be updated when creating a template, please see the reference documentation for the POST /file-requests/:id/update API.

The ID of a file request can be determined by visiting the Box web app and inspecting the URL. Please check our guide on setting up a file request template to learn how to determine a file request ID.