{ "info": { "_postman_id": "e7c0fc97-d639-41c1-b3b7-4851b86c3fc0", "name": "Box Authorize Authorization Files API", "description": "Needs a description.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "lastUpdatedBy": "35240", "uid": "35240-e7c0fc97-d639-41c1-b3b7-4851b86c3fc0" }, "item": [ { "name": "files", "item": [ { "name": "{file_id}", "item": [ { "name": "copy", "item": [ { "name": "Box Copy file", "id": "2ec44c76-0a4c-42e9-bca1-9161ca8e25ee", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "copy" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "id": "5789b33a-b65c-4919-9fac-3d00af91563b", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Creates a copy of a file." }, "response": [ { "id": "95882a9c-95df-4572-8aef-645f07b86b48", "name": "Returns a new file object representing the copied file.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "copy" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"open\",\n \"effective_permission\": \"no_access\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopi\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_download\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"annotation_edit\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"previewer uploader\",\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"utb3\": {\n \"inc7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_preview\",\n \"can_download\"\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-95882a9c-95df-4572-8aef-645f07b86b48" }, { "id": "81382d6e-5f82-4e42-87e5-923d238c952a", "name": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the file. This indicates that the file\nhas not changed since it was last requested.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "copy" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Modified", "code": 304, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-81382d6e-5f82-4e42-87e5-923d238c952a" }, { "id": "2a2e31a0-f049-407d-81c5-7f1a42eca206", "name": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `bad_request` when a parameter is missing.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "copy" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-2a2e31a0-f049-407d-81c5-7f1a42eca206" }, { "id": "df19948a-8646-4872-915d-3873acc1d4ec", "name": "Returns an error when the user does not have the\nright permissions to create the copy a file.\n\n* `forbidden_by_policy`: Returned if copying a file is\nforbidden due to information barrier restrictions.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "copy" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-df19948a-8646-4872-915d-3873acc1d4ec" }, { "id": "70c51875-ee8b-4503-9236-64d46b949239", "name": "Returns an error if either the source file or the destination\nfolder could not be found, or the authenticated user does not\nhave access to either.\n\n* `not_found` when the authenticated user does not have access\n to the source file or the destination fold", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "copy" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-70c51875-ee8b-4503-9236-64d46b949239" }, { "id": "7b604f7f-6785-478e-bd10-a0cec42b4557", "name": "* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in process.\n\n The operation can be retried at a later point.\n\n* `item_name_in_use` when a folder", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "copy" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-7b604f7f-6785-478e-bd10-a0cec42b4557" }, { "id": "3cf71d18-8c86-4c02-9469-cfcfaf735cbe", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\",\n \"version\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "copy" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-3cf71d18-8c86-4c02-9469-cfcfaf735cbe" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-2ec44c76-0a4c-42e9-bca1-9161ca8e25ee" } ], "id": "76e758ae-96c4-4465-9361-a389af2d7362", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-76e758ae-96c4-4465-9361-a389af2d7362" }, { "name": "thumbnail.{extension}", "item": [ { "name": "Box Get file thumbnail", "id": "1eedc70c-10d8-446f-ae54-33a463132fd4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "image/png" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/thumbnail.{{extension}}?min_height=&min_width=&max_height=&max_width=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "thumbnail.{{extension}}" ], "query": [ { "description": "The minimum height of the thumbnail", "key": "min_height", "value": "" }, { "description": "The minimum width of the thumbnail", "key": "min_width", "value": "" }, { "description": "The maximum height of the thumbnail", "key": "max_height", "value": "" }, { "description": "The maximum width of the thumbnail", "key": "max_width", "value": "" } ], "variable": [ { "id": "afd36eb0-44c1-4f8b-ac3d-cb4a25ea9070", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Retrieves a thumbnail, or smaller image representation, of a file.\n\nSizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in\nthe `.png` format and sizes of `32x32`, `160x160`, and `320x320`\ncan be returned in the `.jpg` format.\n\nThumbnails can be generated for the image and video file formats listed\n[found on our community site][1].\n\n[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327" }, "response": [ { "id": "a2b4a475-aa0f-4d0b-bcb3-1bc591f019b1", "name": "When a thumbnail can be created the thumbnail data will be\nreturned in the body of the response.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "image/png" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/thumbnail.{{extension}}?min_height=&min_width=&max_height=&max_width=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "thumbnail.{{extension}}" ], "query": [ { "description": "The minimum height of the thumbnail", "key": "min_height", "value": "" }, { "description": "The minimum width of the thumbnail", "key": "min_width", "value": "" }, { "description": "The maximum height of the thumbnail", "key": "max_height", "value": "" }, { "description": "The maximum width of the thumbnail", "key": "max_width", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "image/png" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a2b4a475-aa0f-4d0b-bcb3-1bc591f019b1" }, { "id": "8dda2cd7-2bf2-4df4-a670-83f1b751f293", "name": "Sometimes generating a thumbnail can take a few seconds. In these\nsituations the API returns a `Location`-header pointing to a\nplaceholder graphic for this file type.\n\nThe placeholder graphic can be used in a user interface until the\nthumbnail generation ", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/files/:file_id/thumbnail.{{extension}}?min_height=&min_width=&max_height=&max_width=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "thumbnail.{{extension}}" ], "query": [ { "description": "The minimum height of the thumbnail", "key": "min_height", "value": "" }, { "description": "The minimum width of the thumbnail", "key": "min_width", "value": "" }, { "description": "The maximum height of the thumbnail", "key": "max_height", "value": "" }, { "description": "The maximum width of the thumbnail", "key": "max_width", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "The time in seconds after which the thumbnail will be available.\n\nYour application only attempt to get the thumbnail again after\nthis time.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "A pointer to a placeholder graphic that can be used until the\nthumbnail has been generated.", "type": "text/plain" }, "key": "Location", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-8dda2cd7-2bf2-4df4-a670-83f1b751f293" }, { "id": "be374b52-0bff-4943-ab85-79804c8efa87", "name": "Returns an error when Box is not able to create a thumbnail for this\nfile type.\n\nInstead, a `Location`-header pointing to a placeholder graphic for\nthis file type will be returned.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/files/:file_id/thumbnail.{{extension}}?min_height=&min_width=&max_height=&max_width=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "thumbnail.{{extension}}" ], "query": [ { "description": "The minimum height of the thumbnail", "key": "min_height", "value": "" }, { "description": "The minimum width of the thumbnail", "key": "min_width", "value": "" }, { "description": "The maximum height of the thumbnail", "key": "max_height", "value": "" }, { "description": "The maximum width of the thumbnail", "key": "max_width", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "Found", "code": 302, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "A pointer to a placeholder graphic that can be used for this\nfile type.", "type": "text/plain" }, "key": "Location", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-be374b52-0bff-4943-ab85-79804c8efa87" }, { "id": "ebf4fdeb-bf1d-4f35-89e3-ebf5898ad185", "name": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `requested_preview_unavailable` - an incorrect dimension was\n requested. This will happen if the dimension requested is\n larger or smaller than the available file sizes for the thum", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/thumbnail.{{extension}}?min_height=&min_width=&max_height=&max_width=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "thumbnail.{{extension}}" ], "query": [ { "description": "The minimum height of the thumbnail", "key": "min_height", "value": "" }, { "description": "The minimum width of the thumbnail", "key": "min_width", "value": "" }, { "description": "The maximum height of the thumbnail", "key": "max_height", "value": "" }, { "description": "The maximum width of the thumbnail", "key": "max_width", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-ebf4fdeb-bf1d-4f35-89e3-ebf5898ad185" }, { "id": "ee8dfaf4-e89f-45b0-8062-b5b356bde693", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/thumbnail.{{extension}}?min_height=&min_width=&max_height=&max_width=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "thumbnail.{{extension}}" ], "query": [ { "description": "The minimum height of the thumbnail", "key": "min_height", "value": "" }, { "description": "The minimum width of the thumbnail", "key": "min_width", "value": "" }, { "description": "The maximum height of the thumbnail", "key": "max_height", "value": "" }, { "description": "The maximum width of the thumbnail", "key": "max_width", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-ee8dfaf4-e89f-45b0-8062-b5b356bde693" }, { "id": "22ff1a9e-4835-43af-9a9e-afe3260229a3", "name": "Returned if the file is not found, or the user does not\nhave access to the file, or for additional reasons.\n\n* `preview_cannot_be_generated` - Box does not support thumbnails\n for this type of file", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/thumbnail.{{extension}}?min_height=&min_width=&max_height=&max_width=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "thumbnail.{{extension}}" ], "query": [ { "description": "The minimum height of the thumbnail", "key": "min_height", "value": "" }, { "description": "The minimum width of the thumbnail", "key": "min_width", "value": "" }, { "description": "The maximum height of the thumbnail", "key": "max_height", "value": "" }, { "description": "The maximum width of the thumbnail", "key": "max_width", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-22ff1a9e-4835-43af-9a9e-afe3260229a3" }, { "id": "1c21c3d8-d8ce-457c-ad26-65b5f5a935fc", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/thumbnail.{{extension}}?min_height=&min_width=&max_height=&max_width=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "thumbnail.{{extension}}" ], "query": [ { "description": "The minimum height of the thumbnail", "key": "min_height", "value": "" }, { "description": "The minimum width of the thumbnail", "key": "min_width", "value": "" }, { "description": "The maximum height of the thumbnail", "key": "max_height", "value": "" }, { "description": "The maximum width of the thumbnail", "key": "max_width", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-1c21c3d8-d8ce-457c-ad26-65b5f5a935fc" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-1eedc70c-10d8-446f-ae54-33a463132fd4" } ], "id": "dfb394af-6ecb-484f-a876-d18ff964ed0e", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-dfb394af-6ecb-484f-a876-d18ff964ed0e" }, { "name": "collaborations", "item": [ { "name": "Box List file collaborations", "id": "33be2f87-2c7a-4c48-9739-64b460f122fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/collaborations?fields=,&limit=&marker=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "collaborations" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" } ], "variable": [ { "id": "a68c8c91-6d6f-4bba-bcff-431eb9e075ae", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Retrieves a list of pending and active collaborations for a\nfile. This returns all the users that have access to the file\nor have been invited to the file." }, "response": [ { "id": "d4f41b72-82ae-4aef-92f6-ea3a9d531cf2", "name": "Returns a collection of collaboration objects. If there are no\ncollaborations on this file an empty collection will be returned.\n\nThis list includes pending collaborations, for which the `status`\nis set to `pending`, indicating invitations that have been ", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/collaborations?fields=,&limit=&marker=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "collaborations" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "null", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d4f41b72-82ae-4aef-92f6-ea3a9d531cf2" }, { "id": "d0310ef3-e36f-42f6-9802-41fcf12a76d6", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/collaborations?fields=,&limit=&marker=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "collaborations" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d0310ef3-e36f-42f6-9802-41fcf12a76d6" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-33be2f87-2c7a-4c48-9739-64b460f122fb" } ], "id": "9db46fef-2bcf-497c-92dd-58f322579b65", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-9db46fef-2bcf-497c-92dd-58f322579b65" }, { "name": "comments", "item": [ { "name": "Box List file comments", "id": "0fe96dbb-798e-43a2-beb0-757d7fa32f99", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/comments?fields=,&limit=&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "comments" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" } ], "variable": [ { "id": "71429c0b-1e92-4ea0-bf8f-3a5030d030e5", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Retrieves a list of comments for a file." }, "response": [ { "id": "626985de-98e7-43fc-b5be-c88244e27fca", "name": "Returns a collection of comment objects. If there are no\ncomments on this file an empty collection will be returned.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/comments?fields=,&limit=&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "comments" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" } ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"ASC\"\n },\n {\n \"by\": \"\",\n \"direction\": \"ASC\"\n }\n ],\n \"entries\": [\n {\n \"tagged_message\": \"\"\n },\n {\n \"tagged_message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-626985de-98e7-43fc-b5be-c88244e27fca" }, { "id": "8c18556e-1a31-4af5-b112-0b649c8c6725", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/comments?fields=,&limit=&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "comments" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" } ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-8c18556e-1a31-4af5-b112-0b649c8c6725" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-0fe96dbb-798e-43a2-beb0-757d7fa32f99" } ], "id": "199b936b-3151-403b-9962-8b59e31f6eee", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-199b936b-3151-403b-9962-8b59e31f6eee" }, { "name": "content", "item": [ { "name": "Box Download file", "id": "a45381d1-9011-4ed4-9f70-f42b95a0fda3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The byte range of the content to download.\n\nThe format `bytes={start_byte}-{end_byte}` can be used to specify\nwhat section of the file to download.", "key": "range", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/content?version=&access_token=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "content" ], "query": [ { "description": "The file version to download", "key": "version", "value": "" }, { "description": "An optional access token that can be used to pre-authenticate this request, which means that a download link can be shared with a browser or a third party service without them needing to know how to handle the authentication.\nWhen using this parameter, please make sure that the access token is sufficiently scoped down to only allow read access to that file and no other files or folders.", "key": "access_token", "value": "" } ], "variable": [ { "id": "a0c58fdb-2cf3-49e2-89a3-0e87a9e5f2f9", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Returns the contents of a file in binary format." }, "response": [ { "id": "e2e0b86b-c756-4ad6-9683-555fa46493a4", "name": "Returns the requested file if the client has the **follow\nredirects** setting enabled to automatically\nfollow HTTP `3xx` responses as redirects. If not, the request\nwill return `302` instead.\nFor details, see\nthe [download file guide](g://downloads/file#d", "originalRequest": { "method": "GET", "header": [ { "description": "The byte range of the content to download.\n\nThe format `bytes={start_byte}-{end_byte}` can be used to specify\nwhat section of the file to download.", "key": "range", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/content?version=&access_token=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "content" ], "query": [ { "description": "The file version to download", "key": "version", "value": "" }, { "description": "An optional access token that can be used to pre-authenticate this request, which means that a download link can be shared with a browser or a third party service without them needing to know how to handle the authentication.\nWhen using this parameter, please make sure that the access token is sufficiently scoped down to only allow read access to that file and no other files or folders.", "key": "access_token", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e2e0b86b-c756-4ad6-9683-555fa46493a4" }, { "id": "6a5ee394-ff8d-4562-852a-dfadb4d7d0b2", "name": "If the file is not ready to be downloaded yet `Retry-After` header will\nbe returned indicating the time in seconds after which the file will\nbe available for the client to download.\n\nThis response can occur when the file was uploaded immediately before th", "originalRequest": { "method": "GET", "header": [ { "description": "The byte range of the content to download.\n\nThe format `bytes={start_byte}-{end_byte}` can be used to specify\nwhat section of the file to download.", "key": "range", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/content?version=&access_token=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "content" ], "query": [ { "description": "The file version to download", "key": "version", "value": "" }, { "description": "An optional access token that can be used to pre-authenticate this request, which means that a download link can be shared with a browser or a third party service without them needing to know how to handle the authentication.\nWhen using this parameter, please make sure that the access token is sufficiently scoped down to only allow read access to that file and no other files or folders.", "key": "access_token", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "The time in seconds after which to retry the download", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-6a5ee394-ff8d-4562-852a-dfadb4d7d0b2" }, { "id": "2ecb3916-f682-4027-8816-d8a1b99204be", "name": "If the file is available for download the response will include a\n`Location` header for the file on `dl.boxcloud.com`.\n\nThe `dl.boxcloud.com` URL is not persistent and clients will need\nto follow the redirect to actually download the file.", "originalRequest": { "method": "GET", "header": [ { "description": "The byte range of the content to download.\n\nThe format `bytes={start_byte}-{end_byte}` can be used to specify\nwhat section of the file to download.", "key": "range", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/content?version=&access_token=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "content" ], "query": [ { "description": "The file version to download", "key": "version", "value": "" }, { "description": "An optional access token that can be used to pre-authenticate this request, which means that a download link can be shared with a browser or a third party service without them needing to know how to handle the authentication.\nWhen using this parameter, please make sure that the access token is sufficiently scoped down to only allow read access to that file and no other files or folders.", "key": "access_token", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "Found", "code": 302, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "A pointer to the download URL", "type": "text/plain" }, "key": "Location", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-2ecb3916-f682-4027-8816-d8a1b99204be" }, { "id": "d248527d-276c-4cae-a3e3-852977b8d82b", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "description": "The byte range of the content to download.\n\nThe format `bytes={start_byte}-{end_byte}` can be used to specify\nwhat section of the file to download.", "key": "range", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/content?version=&access_token=", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "content" ], "query": [ { "description": "The file version to download", "key": "version", "value": "" }, { "description": "An optional access token that can be used to pre-authenticate this request, which means that a download link can be shared with a browser or a third party service without them needing to know how to handle the authentication.\nWhen using this parameter, please make sure that the access token is sufficiently scoped down to only allow read access to that file and no other files or folders.", "key": "access_token", "value": "" } ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d248527d-276c-4cae-a3e3-852977b8d82b" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a45381d1-9011-4ed4-9f70-f42b95a0fda3" }, { "name": "Box Upload file version", "id": "91530b03-4fea-440a-9a5e-9a0c7478729d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "description": "An optional header containing the SHA1 hash of the file to\nensure that the file was not corrupted in transit.", "key": "content-md5", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The additional attributes of the file being uploaded. Mainly the\nname and the parent folder. These attributes are part of the multi\npart request body and are in JSON format.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "attributes", "value": "[object Object]", "type": "text" }, { "description": "(Required) The content of the file to upload to Box.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "file", "type": "file", "value": null } ] }, "url": { "raw": "https://upload.box.com/api/2.0/files/:file_id/content?fields=,", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", ":file_id", "content" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "id": "042469c3-51d3-449a-a72f-6cae12763b68", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Update a file's content. For file sizes over 50MB we recommend\nusing the Chunk Upload APIs.\n\n# Request body order\n\nThe `attributes` part of the body must come **before** the\n`file` part. Requests that do not follow this format when\nuploading the file will receive a HTTP `400` error with a\n`metadata_after_file_contents` error code." }, "response": [ { "id": "03fd7acf-2939-4022-a59a-58a671a09fb0", "name": "Returns the new file object in a list.", "originalRequest": { "method": "POST", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "description": "An optional header containing the SHA1 hash of the file to\nensure that the file was not corrupted in transit.", "key": "content-md5", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The additional attributes of the file being uploaded. Mainly the\nname and the parent folder. These attributes are part of the multi\npart request body and are in JSON format.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "attributes", "value": "[object Object]", "type": "text" }, { "description": "(Required) The content of the file to upload to Box.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "file", "type": "file" } ] }, "url": { "raw": "https://upload.box.com/api/2.0/files/:file_id/content?fields=,", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", ":file_id", "content" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"collaborators\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"other\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"annotation_view_self\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"annotation_view_all\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"allowed_invitee_roles\": [\n \"previewer uploader\",\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"eu_69d\": {\n \"ipsuma_a\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"suntf6\": {\n \"fugiat3_4\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"pending\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\",\n \"can_edit\"\n ]\n },\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_edit\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"collaborators\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"trashed\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopi\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"annotation_edit\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"base_upload\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"allowed_invitee_roles\": [\n \"co-owner\",\n \"uploader\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"Ut_b_\": {\n \"ea_e\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sita0f\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"do_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"in_3c_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"amet338\": {\n \"aute__3\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"fugiat0c\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"elit_b5\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"tempor_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"dolore48\": {\n \"mollit_3_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"pariatura1\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sunt_15\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_preview\",\n \"can_edit\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-03fd7acf-2939-4022-a59a-58a671a09fb0" }, { "id": "cc8258fe-42c7-4050-996d-608489a987db", "name": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file. This indicates that the file\nhas changed since it was last requested.", "originalRequest": { "method": "POST", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "description": "An optional header containing the SHA1 hash of the file to\nensure that the file was not corrupted in transit.", "key": "content-md5", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The additional attributes of the file being uploaded. Mainly the\nname and the parent folder. These attributes are part of the multi\npart request body and are in JSON format.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "attributes", "value": "[object Object]", "type": "text" }, { "description": "(Required) The content of the file to upload to Box.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "file", "type": "file" } ] }, "url": { "raw": "https://upload.box.com/api/2.0/files/:file_id/content?fields=,", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", ":file_id", "content" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-cc8258fe-42c7-4050-996d-608489a987db" }, { "id": "12fa8163-9319-469e-a9f6-05a48dda236f", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "description": "An optional header containing the SHA1 hash of the file to\nensure that the file was not corrupted in transit.", "key": "content-md5", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The additional attributes of the file being uploaded. Mainly the\nname and the parent folder. These attributes are part of the multi\npart request body and are in JSON format.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "attributes", "value": "[object Object]", "type": "text" }, { "description": "(Required) The content of the file to upload to Box.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "file", "type": "file" } ] }, "url": { "raw": "https://upload.box.com/api/2.0/files/:file_id/content?fields=,", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", ":file_id", "content" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-12fa8163-9319-469e-a9f6-05a48dda236f" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-91530b03-4fea-440a-9a5e-9a0c7478729d" } ], "id": "8fef2228-9050-4a1f-9924-768a78178666", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-8fef2228-9050-4a1f-9924-768a78178666" }, { "name": "upload_sessions", "item": [ { "name": "Box Create upload session for existing file", "id": "177dd730-b41e-4e42-9e3d-5b827bd2440c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file_size\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/:file_id/upload_sessions", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", ":file_id", "upload_sessions" ], "variable": [ { "id": "c1a49246-e0c9-44cd-945a-c79b6d148f56", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Creates an upload session for an existing file." }, "response": [ { "id": "92e7c7f6-0de5-4946-9aa1-edff3a18743c", "name": "Returns a new upload session.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file_size\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/:file_id/upload_sessions", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", ":file_id", "upload_sessions" ], "variable": [ { "key": "file_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"upload_session\",\n \"session_expires_at\": \"\",\n \"part_size\": \"\",\n \"total_parts\": \"\",\n \"num_parts_processed\": \"\",\n \"session_endpoints\": {\n \"upload_part\": \"\",\n \"commit\": \"\",\n \"abort\": \"\",\n \"list_parts\": \"\",\n \"status\": \"\",\n \"log_event\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-92e7c7f6-0de5-4946-9aa1-edff3a18743c" }, { "id": "e07c3d0b-e4e5-416a-b89f-d834204f8ac7", "name": "Returns an error if the file already exists,\nor if the account has run out of disk space.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file_size\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/:file_id/upload_sessions", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", ":file_id", "upload_sessions" ], "variable": [ { "key": "file_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e07c3d0b-e4e5-416a-b89f-d834204f8ac7" }, { "id": "c4b5f83d-bb7b-4c75-9055-5014f22802b2", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"file_size\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/:file_id/upload_sessions", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", ":file_id", "upload_sessions" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-c4b5f83d-bb7b-4c75-9055-5014f22802b2" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-177dd730-b41e-4e42-9e3d-5b827bd2440c" } ], "id": "074cf7ac-9f5d-4252-bf0b-bd05deb5b30e", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-074cf7ac-9f5d-4252-bf0b-bd05deb5b30e" }, { "name": "tasks", "item": [ { "name": "Box List tasks on file", "id": "3b70ba61-8b48-4ac7-bff7-24653a04a543", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/tasks", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "tasks" ], "variable": [ { "id": "a2ce0fb1-cfda-4980-8c48-4df78b0f82b0", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Retrieves a list of all the tasks for a file. This\nendpoint does not support pagination." }, "response": [ { "id": "ca84c45e-85ac-4e2e-bd20-4e445b7ce3ff", "name": "Returns a list of tasks on a file.\n\nIf there are no tasks on this file an empty collection is returned\ninstead.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/tasks", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "tasks" ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"task\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n }\n },\n \"due_at\": \"\",\n \"action\": \"review\",\n \"message\": \"\",\n \"task_assignment_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"value\": \"reference #/components/schemas/TaskAssignment not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/TaskAssignment not found in the OpenAPI spec\"\n }\n ]\n },\n \"is_completed\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"completion_rule\": \"any_assignee\"\n },\n {\n \"id\": \"\",\n \"type\": \"task\",\n \"item\": {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n }\n },\n \"due_at\": \"\",\n \"action\": \"complete\",\n \"message\": \"\",\n \"task_assignment_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"value\": \"reference #/components/schemas/TaskAssignment not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/TaskAssignment not found in the OpenAPI spec\"\n }\n ]\n },\n \"is_completed\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"completion_rule\": \"any_assignee\"\n }\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-ca84c45e-85ac-4e2e-bd20-4e445b7ce3ff" }, { "id": "4525c01d-5851-4baa-a32d-38d97574225a", "name": "Returns an error when the file could not be found or the user does not\nhave access to the file.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/tasks", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "tasks" ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-4525c01d-5851-4baa-a32d-38d97574225a" }, { "id": "c14ef820-b68c-4b58-8264-9ea7397cb90a", "name": "Returns an error when the `file_id` was not provided.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/tasks", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "tasks" ], "variable": [ { "key": "file_id" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-c14ef820-b68c-4b58-8264-9ea7397cb90a" }, { "id": "2e741e13-b024-450d-9d89-3c1f27e514b0", "name": "Returns an error when an attempt was made to retrieve tasks for the file\nwith ID `0`.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/tasks", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "tasks" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-2e741e13-b024-450d-9d89-3c1f27e514b0" }, { "id": "e0eab1f7-1885-4a17-bc3e-2dc4b481ff10", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/tasks", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "tasks" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e0eab1f7-1885-4a17-bc3e-2dc4b481ff10" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-3b70ba61-8b48-4ac7-bff7-24653a04a543" } ], "id": "daac0e12-32ab-4e9b-a624-e92f77383e5c", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-daac0e12-32ab-4e9b-a624-e92f77383e5c" }, { "name": "trash", "item": [ { "name": "Box Get trashed file", "id": "2d784294-a1ca-46a1-b2b7-fbba137056bf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/trash?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "trash" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "id": "0ca0cd73-b8e0-43c5-a060-6333dc172325", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Retrieves a file that has been moved to the trash.\n\nPlease note that only if the file itself has been moved to the\ntrash can it be retrieved with this API call. If instead one of\nits parent folders was moved to the trash, only that folder\ncan be inspected using the\n[`GET /folders/:id/trash`](e://get_folders_id_trash) API.\n\nTo list all items that have been moved to the trash, please\nuse the [`GET /folders/trash/items`](e://get-folders-trash-items/)\nAPI." }, "response": [ { "id": "222ca4dc-8902-4b92-8948-6675b011a226", "name": "Returns the file that was trashed,\nincluding information about when the it\nwas moved to the trash.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/trash?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "trash" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"file\",\n \"sequence_id\": \"\",\n \"sha1\": \"\",\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"type\": \"folder\",\n \"id\": \"\",\n \"sequence_id\": \"\",\n \"etag\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"folder\",\n \"id\": \"\",\n \"sequence_id\": \"\",\n \"etag\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"item_status\": \"trashed\",\n \"etag\": \"\",\n \"name\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": \"\",\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-222ca4dc-8902-4b92-8948-6675b011a226" }, { "id": "e02559dd-9a6a-42c1-a368-26f7b67f078a", "name": "Returns an error if the file can not be found directly\nin the trash.\n\nPlease note that a `HTTP 404` is also returned if any of\nthe file's parent folders have been moved to the trash.\n\nIn that case, only that parent folder can be inspected using\nthe [`GET ", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/trash?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "trash" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e02559dd-9a6a-42c1-a368-26f7b67f078a" }, { "id": "ff45b138-a984-4aa3-9908-bc32d166f7a3", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/trash?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "trash" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-ff45b138-a984-4aa3-9908-bc32d166f7a3" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-2d784294-a1ca-46a1-b2b7-fbba137056bf" }, { "name": "Box Permanently remove file", "id": "a2b14d4c-dc73-4c76-bb15-7197b7efc5df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/trash", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "trash" ], "variable": [ { "id": "8c68946d-dd82-4210-83dc-21e9cb2243e3", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Permanently deletes a file that is in the trash.\nThis action cannot be undone." }, "response": [ { "id": "a00b35af-fbc4-4cce-88c3-2ae96b57bf5a", "name": "Returns an empty response when the file was\npermanently deleted.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/files/:file_id/trash", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "trash" ], "variable": [ { "key": "file_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a00b35af-fbc4-4cce-88c3-2ae96b57bf5a" }, { "id": "12651c7c-d47d-41ca-8548-500cff1701c7", "name": "Returns an error if the file is not in the trash.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/trash", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "trash" ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-12651c7c-d47d-41ca-8548-500cff1701c7" }, { "id": "d73a4b46-74e8-4c0e-8019-e676db76d698", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/trash", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "trash" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d73a4b46-74e8-4c0e-8019-e676db76d698" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a2b14d4c-dc73-4c76-bb15-7197b7efc5df" } ], "id": "6e38e151-118f-42b1-a196-13879291ae23", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-6e38e151-118f-42b1-a196-13879291ae23" }, { "name": "versions", "item": [ { "name": "{file_version_id}", "item": [ { "name": "Box Get file version", "id": "86d947c8-2fa5-40a0-9fdc-451a4bfbc1f8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/versions/:file_version_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions", ":file_version_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "id": "2b07921d-0171-4c0b-9356-80d79b7e1fac", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "id": "89163ac5-2b43-48b2-8e30-c5c0acbf2328", "key": "file_version_id", "value": "", "description": "(Required) The ID of the file version" } ] }, "description": "Retrieve a specific version of a file.\n\nVersions are only tracked for Box users with premium accounts." }, "response": [ { "id": "b3ec0f37-50ab-4f80-a868-dd77260c7e47", "name": "Returns a specific version of a file.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/versions/:file_version_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions", ":file_version_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" }, { "key": "file_version_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"version_number\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-b3ec0f37-50ab-4f80-a868-dd77260c7e47" }, { "id": "f28d903b-732c-44c9-800d-6336c5d2d42f", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/versions/:file_version_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions", ":file_version_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" }, { "key": "file_version_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-f28d903b-732c-44c9-800d-6336c5d2d42f" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-86d947c8-2fa5-40a0-9fdc-451a4bfbc1f8" }, { "name": "Box Remove file version", "id": "f1a600dc-d35a-40ae-8589-50f5f9f24145", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/versions/:file_version_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions", ":file_version_id" ], "variable": [ { "id": "46418f29-7ecc-4909-b99e-30f8359c719e", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "id": "8bd1eb16-1447-49c2-9909-4d28878af130", "key": "file_version_id", "value": "", "description": "(Required) The ID of the file version" } ] }, "description": "Move a file version to the trash.\n\nVersions are only tracked for Box users with premium accounts." }, "response": [ { "id": "896ffb4d-d56e-46ac-9aee-f9241505ed2c", "name": "Returns an empty response when the file has been successfully\ndeleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/versions/:file_version_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions", ":file_version_id" ], "variable": [ { "key": "file_id" }, { "key": "file_version_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-896ffb4d-d56e-46ac-9aee-f9241505ed2c" }, { "id": "6e212473-e4cb-4d1e-891d-60399f464c86", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/versions/:file_version_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions", ":file_version_id" ], "variable": [ { "key": "file_id" }, { "key": "file_version_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-6e212473-e4cb-4d1e-891d-60399f464c86" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-f1a600dc-d35a-40ae-8589-50f5f9f24145" }, { "name": "Box Restore file version", "id": "2baa9af0-5609-411d-922d-971ecad017f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"trashed_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/versions/:file_version_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions", ":file_version_id" ], "variable": [ { "id": "1c8e7b3a-bc57-4605-b8e9-a146921362de", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "id": "5b5c6344-542b-47f3-840f-fccd1e39b5a7", "key": "file_version_id", "value": "", "description": "(Required) The ID of the file version" } ] }, "description": "Restores a specific version of a file after it was deleted.\nDon't use this endpoint to restore Box Notes,\nas it works with file formats such as PDF, DOC,\nPPTX or similar." }, "response": [ { "id": "a6541103-034b-4207-90e9-8a876d594a47", "name": "Returns a restored file version object.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"trashed_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/versions/:file_version_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions", ":file_version_id" ], "variable": [ { "key": "file_id" }, { "key": "file_version_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"version_number\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a6541103-034b-4207-90e9-8a876d594a47" }, { "id": "e2abcb4b-b430-4fa4-a735-009041a0d654", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"trashed_at\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/versions/:file_version_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions", ":file_version_id" ], "variable": [ { "key": "file_id" }, { "key": "file_version_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e2abcb4b-b430-4fa4-a735-009041a0d654" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-2baa9af0-5609-411d-922d-971ecad017f5" } ], "id": "bc63617a-b6f3-4693-9d9f-34894aa0994b", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-bc63617a-b6f3-4693-9d9f-34894aa0994b" }, { "name": "current", "item": [ { "name": "Box Promote file version", "id": "d1a93255-c04d-4b5f-a191-820c38f0b7ce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"type\": \"file_version\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/versions/current?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions", "current" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "id": "da9155d7-222e-42e6-8bf8-6cd40733b47c", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Promote a specific version of a file.\n\nIf previous versions exist, this method can be used to\npromote one of the older versions to the top of the version history.\n\nThis creates a new copy of the old version and puts it at the\ntop of the versions history. The file will have the exact same contents\nas the older version, with the the same hash digest, `etag`, and\nname as the original.\n\nOther properties such as comments do not get updated to their\nformer values.\n\nDon't use this endpoint to restore Box Notes,\nas it works with file formats such as PDF, DOC,\nPPTX or similar." }, "response": [ { "id": "5d521eed-a782-4888-b287-951fdd8cda57", "name": "Returns a newly created file version object.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"type\": \"file_version\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/versions/current?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions", "current" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"version_number\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-5d521eed-a782-4888-b287-951fdd8cda57" }, { "id": "285e0131-600e-4a26-bbf3-a807935ef187", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"type\": \"file_version\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/versions/current?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions", "current" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-285e0131-600e-4a26-bbf3-a807935ef187" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d1a93255-c04d-4b5f-a191-820c38f0b7ce" } ], "id": "dad9beae-dcc1-436a-a74d-21a0f7667eae", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-dad9beae-dcc1-436a-a74d-21a0f7667eae" }, { "name": "Box List all file versions", "id": "0f2f9b63-6e9e-4551-b762-d4e57da909d3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/versions?fields=,&limit=&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" } ], "variable": [ { "id": "20b9b6ee-58d2-4892-8821-01d437f5c9f7", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Retrieve a list of the past versions for a file.\n\nVersions are only tracked by Box users with premium accounts. To fetch the ID\nof the current version of a file, use the `GET /file/:id` API." }, "response": [ { "id": "fe447f74-d56b-4207-b1e1-ae747e7bdacd", "name": "Returns an array of past versions for this file.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/versions?fields=,&limit=&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" } ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"ASC\"\n },\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n }\n ],\n \"entries\": [\n {\n \"version_number\": \"\"\n },\n {\n \"version_number\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-fe447f74-d56b-4207-b1e1-ae747e7bdacd" }, { "id": "ceaccc08-6040-423e-a27c-99b5f471d97b", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/versions?fields=,&limit=&offset=0", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "versions" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" } ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-ceaccc08-6040-423e-a27c-99b5f471d97b" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-0f2f9b63-6e9e-4551-b762-d4e57da909d3" } ], "id": "83d4e827-576c-4510-812c-fe8254ec50a0", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-83d4e827-576c-4510-812c-fe8254ec50a0" }, { "name": "metadata", "item": [ { "name": "enterprise", "item": [ { "name": "securityClassification-6VMVochwUWo", "item": [ { "name": "Box Get classification on file", "id": "f005383d-f5c0-4a8d-a1b2-925e279c7acc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "id": "dfc41423-0b7f-43bd-b5f8-3138fe8d0d3b", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Retrieves the classification metadata instance that\nhas been applied to a file.\n\nThis API can also be called by including the enterprise ID in the\nURL explicitly, for example\n`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`." }, "response": [ { "id": "cdfa09c8-5c11-4863-9846-f9e6563582ea", "name": "Returns an instance of the `securityClassification` metadata\ntemplate, which contains a `Box__Security__Classification__Key`\nfield that lists all the classifications available to this\nenterprise.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"Box__Security__Classification__Key\": \"\",\n \"$parent\": \"\",\n \"$template\": \"securityClassification-6VMVochwUWo\",\n \"$scope\": \"\",\n \"$version\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\",\n \"$canEdit\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-cdfa09c8-5c11-4863-9846-f9e6563582ea" }, { "id": "a03098bb-80ba-4386-adab-edbbed22c13c", "name": "Returned when the request parameters are not valid.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a03098bb-80ba-4386-adab-edbbed22c13c" }, { "id": "620c0751-a52e-42af-8886-dc9b31d51d74", "name": "Returned if the metadata template specified\nwas not applied to this file or the user does not have access to the\nfile.\n\n* `instance_not_found` - The metadata template was not applied to the\nfile.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-620c0751-a52e-42af-8886-dc9b31d51d74" }, { "id": "87eba66e-6e47-4b48-9831-7d936216cb77", "name": "Returned when the method was not allowed.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-87eba66e-6e47-4b48-9831-7d936216cb77" }, { "id": "3618edbe-6d9c-4e52-87a6-a29623bb71ff", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-3618edbe-6d9c-4e52-87a6-a29623bb71ff" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-f005383d-f5c0-4a8d-a1b2-925e279c7acc" }, { "name": "Box Add classification to file", "id": "a0784cf4-cdec-468a-a043-c188555cd578", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Box__Security__Classification__Key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "id": "e1b2ec63-9e0b-45ae-b0a7-5624b2e6cadb", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Adds a classification to a file by specifying the label of the\nclassification to add.\n\nThis API can also be called by including the enterprise ID in the\nURL explicitly, for example\n`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`." }, "response": [ { "id": "d37a739c-49cd-4267-a95b-58611946d6e8", "name": "Returns the classification template instance\nthat was applied to the file.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Box__Security__Classification__Key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"Box__Security__Classification__Key\": \"\",\n \"$parent\": \"\",\n \"$template\": \"securityClassification-6VMVochwUWo\",\n \"$scope\": \"\",\n \"$version\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\",\n \"$canEdit\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d37a739c-49cd-4267-a95b-58611946d6e8" }, { "id": "67713483-7369-4995-8c23-2ada2535325f", "name": "Returns an error when the request body is not valid.\n\n* `schema_validation_failed` - The request body contains a value for a for\na field that either does not exist, or for which the value or type does\nnot match the expected field type. An example might be", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Box__Security__Classification__Key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-67713483-7369-4995-8c23-2ada2535325f" }, { "id": "a7155081-3949-42e9-a087-63ce594075a3", "name": "Returns an error when the file or metadata template was not found.\n\n* `not_found` - The file could not be found, or the user does not have\naccess to the file.\n* `instance_tuple_not_found` - The metadata template was not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Box__Security__Classification__Key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a7155081-3949-42e9-a087-63ce594075a3" }, { "id": "e6a3d37d-01eb-44da-92d2-b789009567cd", "name": "Returns an error when an instance of this metadata template is already\npresent on the file.\n\n* `tuple_already_exists` - An instance of them metadata template already\nexists on the file.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Box__Security__Classification__Key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e6a3d37d-01eb-44da-92d2-b789009567cd" }, { "id": "7dc0f072-b2dc-4c6d-abc2-9c5f10284943", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Box__Security__Classification__Key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-7dc0f072-b2dc-4c6d-abc2-9c5f10284943" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a0784cf4-cdec-468a-a043-c188555cd578" }, { "name": "Box Update classification on file", "id": "e3e07cb1-a8c7-455b-accf-78754b086c1d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "id": "8d64714a-ddbc-4711-bda3-9324f77fa4a2", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Updates a classification on a file.\n\nThe classification can only be updated if a classification has already been\napplied to the file before. When editing classifications, only values are\ndefined for the enterprise will be accepted." }, "response": [ { "id": "35893b26-1bbd-4671-b4be-ee73a16adfff", "name": "Returns the updated classification metadata template instance.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"Box__Security__Classification__Key\": \"\",\n \"$parent\": \"\",\n \"$template\": \"securityClassification-6VMVochwUWo\",\n \"$scope\": \"\",\n \"$version\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\",\n \"$canEdit\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-35893b26-1bbd-4671-b4be-ee73a16adfff" }, { "id": "6bd98d99-b4c7-4fa1-9418-0bd3769d1234", "name": "Returns an error when the request body is not valid.\n\n* `bad_request` - The request body format is not an array of valid JSON\nPatch operations.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-6bd98d99-b4c7-4fa1-9418-0bd3769d1234" }, { "id": "116cc8b3-a376-4cf6-a210-51060873b516", "name": "Returns an error in some edge cases when the request body is not a valid\narray of JSON Patch items.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-116cc8b3-a376-4cf6-a210-51060873b516" }, { "id": "643a1a45-37b6-4600-bb46-814689400956", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-643a1a45-37b6-4600-bb46-814689400956" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e3e07cb1-a8c7-455b-accf-78754b086c1d" }, { "name": "Box Remove classification from file", "id": "405b8f7c-4f16-4057-a001-bc5817e99377", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "id": "fbf4bcdc-57ef-4be2-bf68-8f7db38d25ba", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Removes any classifications from a file.\n\nThis API can also be called by including the enterprise ID in the\nURL explicitly, for example\n`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`." }, "response": [ { "id": "b2291e4d-e8f0-48f8-8c53-2ce0919363e3", "name": "Returns an empty response when the classification is\nsuccessfully deleted.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-b2291e4d-e8f0-48f8-8c53-2ce0919363e3" }, { "id": "aa4d07d2-5e40-41db-b387-0904ea2419eb", "name": "Returned when the request parameters are not valid.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-aa4d07d2-5e40-41db-b387-0904ea2419eb" }, { "id": "fcac7dfb-73d5-4413-b788-bf1763dda1c1", "name": "Returns an error when the file does not have any classification applied\nto it, or when the user does not have access to the\nfile.\n\n* `instance_not_found` - An instance of the classification metadata\ntemplate with the was not found on this file.\n* `not_fou", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-fcac7dfb-73d5-4413-b788-bf1763dda1c1" }, { "id": "98cd5b9f-588b-4772-8dfd-51b327bd449b", "name": "Returned when the method was not allowed.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-98cd5b9f-588b-4772-8dfd-51b327bd449b" }, { "id": "a3bc7591-17fc-43c2-ad32-046b348ab7ca", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a3bc7591-17fc-43c2-ad32-046b348ab7ca" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-405b8f7c-4f16-4057-a001-bc5817e99377" } ], "id": "82c10d6f-7aee-4078-b078-c74084382d54", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-82c10d6f-7aee-4078-b078-c74084382d54" } ], "id": "ba8d1aeb-b6bb-4e78-ac0b-4365f3c0ad4d", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-ba8d1aeb-b6bb-4e78-ac0b-4365f3c0ad4d" }, { "name": "{scope}", "item": [ { "name": "{template_key}", "item": [ { "name": "Box Get metadata instance on file", "id": "9d83ffd0-6b83-4b9d-87ba-3466ff2d329b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "id": "cbf3855e-66f4-4df3-944a-10abe88d1b04", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "id": "e0b50b24-5fb0-4a51-988b-67797e9ac952", "key": "scope", "value": "enterprise", "description": "(Required) The scope of the metadata template" }, { "id": "a534ddea-b333-4b6b-b980-ef80f5514aa8", "key": "template_key", "value": "", "description": "(Required) The name of the metadata template" } ] }, "description": "Retrieves the instance of a metadata template that has been applied to a\nfile." }, "response": [ { "id": "4ed9593c-43aa-49cb-9252-9b43bc07d1aa", "name": "An instance of the metadata template that includes\nadditional \"key:value\" pairs defined by the user or\nan application.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\",\n \"$canEdit\": \"\",\n \"$id\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-4ed9593c-43aa-49cb-9252-9b43bc07d1aa" }, { "id": "8c85bda7-2339-4cb1-863f-8184dd5877f9", "name": "Returned when the request parameters are not valid.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-8c85bda7-2339-4cb1-863f-8184dd5877f9" }, { "id": "a6012da9-85ab-4acf-9d90-1996454171a8", "name": "Returned if the metadata template specified\nwas not applied to this file or the user does not have access to the\nfile.\n\n* `instance_not_found` - The metadata template was not applied to the\nfile.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a6012da9-85ab-4acf-9d90-1996454171a8" }, { "id": "bd5e87c6-b27e-4783-bf68-a58c4682cab1", "name": "Returned when the method was not allowed.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-bd5e87c6-b27e-4783-bf68-a58c4682cab1" }, { "id": "d704a9fc-30c9-4fce-ae86-b2bb930fb00e", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d704a9fc-30c9-4fce-ae86-b2bb930fb00e" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-9d83ffd0-6b83-4b9d-87ba-3466ff2d329b" }, { "name": "Box Create metadata instance on file", "id": "01408fbb-5489-4554-9dd4-42567841164a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"proidentad\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n },\n \"Lorem8_3\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n },\n \"sint_611\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "id": "73f41738-3540-4668-a49b-ff9be36aceb0", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "id": "aa650f74-c430-4bce-8474-65fb08676cf7", "key": "scope", "value": "enterprise", "description": "(Required) The scope of the metadata template" }, { "id": "dcdd1a09-404e-44ff-a39a-4ce374691639", "key": "template_key", "value": "", "description": "(Required) The name of the metadata template" } ] }, "description": "Applies an instance of a metadata template to a file.\n\nIn most cases only values that are present in the metadata template\nwill be accepted, except for the `global.properties` template which accepts\nany key-value pair." }, "response": [ { "id": "e4caaa53-f0ae-4d88-ae3c-d58e25bd9014", "name": "Returns the instance of the template that was applied to the file,\nincluding the data that was applied to the template.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"proidentad\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n },\n \"Lorem8_3\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n },\n \"sint_611\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\",\n \"$canEdit\": \"\",\n \"$id\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e4caaa53-f0ae-4d88-ae3c-d58e25bd9014" }, { "id": "48de3952-ce7f-4134-a15e-a32982e4cee8", "name": "Returns an error when the request body is not valid.\n\n* `schema_validation_failed` - The request body contains a value for a for\na field that either does not exist, or for which the value or type does\nnot match the expected field type. An example might be", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"proidentad\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n },\n \"Lorem8_3\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n },\n \"sint_611\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-48de3952-ce7f-4134-a15e-a32982e4cee8" }, { "id": "e198adce-620b-49af-bb97-44987bfab2e5", "name": "Returns an error when the file or metadata template was not found.\n\n* `not_found` - The file could not be found, or the user does not have\naccess to the file.\n* `instance_tuple_not_found` - The metadata template was not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"proidentad\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n },\n \"Lorem8_3\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n },\n \"sint_611\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e198adce-620b-49af-bb97-44987bfab2e5" }, { "id": "7f50e0fd-2129-42fa-8930-4315a2797e6b", "name": "Returns an error when an instance of this metadata template is already\npresent on the file.\n\n* `tuple_already_exists` - An instance of them metadata template already\nexists on the file.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"proidentad\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n },\n \"Lorem8_3\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n },\n \"sint_611\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-7f50e0fd-2129-42fa-8930-4315a2797e6b" }, { "id": "65236cab-9baa-47dd-b4c3-51651ec98616", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"proidentad\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n },\n \"Lorem8_3\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n },\n \"sint_611\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present\\non the metadata template.\\nFor the `global.properties` template this can be\\na list of zero or more fields,\\nas this template allows for any generic key-value pairs \\nto be stored stored in the template.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-65236cab-9baa-47dd-b4c3-51651ec98616" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-01408fbb-5489-4554-9dd4-42567841164a" }, { "name": "Box Update metadata instance on file", "id": "d9a6c704-1c5c-4904-93a6-9d832bf2c094", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "id": "d6f0fbde-1f46-4816-b79d-8be98d9d689b", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "id": "625f9c8c-f063-4983-b9da-9f59c65e9a8b", "key": "scope", "value": "enterprise", "description": "(Required) The scope of the metadata template" }, { "id": "fbb9d17e-4666-40e6-a59f-65a7e21dbc1d", "key": "template_key", "value": "", "description": "(Required) The name of the metadata template" } ] }, "description": "Updates a piece of metadata on a file.\n\nThe metadata instance can only be updated if the template has already been\napplied to the file before. When editing metadata, only values that match\nthe metadata template schema will be accepted.\n\nThe update is applied atomically. If any errors occur during the\napplication of the operations, the metadata instance will not be changed." }, "response": [ { "id": "e587a92b-ffa1-499d-9c88-ab432e38c689", "name": "Returns the updated metadata template instance, with the\ncustom template data included.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\",\n \"$canEdit\": \"\",\n \"$id\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e587a92b-ffa1-499d-9c88-ab432e38c689" }, { "id": "573aa948-5e5d-49bb-9dbd-f5f584d8ada1", "name": "Returns an error when the request body is not valid.\n\n* `bad_request` - The request body format is not an array of valid JSON\nPatch objects.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-573aa948-5e5d-49bb-9dbd-f5f584d8ada1" }, { "id": "c9f868cb-0319-47ae-b12e-3bdb2bc35469", "name": "Returns an error in some edge cases when the request body is not a valid\narray of JSON Patch items.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-c9f868cb-0319-47ae-b12e-3bdb2bc35469" }, { "id": "40d2bf81-d41d-4bf3-9df4-9d43cbc168ed", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-40d2bf81-d41d-4bf3-9df4-9d43cbc168ed" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d9a6c704-1c5c-4904-93a6-9d832bf2c094" }, { "name": "Box Remove metadata instance from file", "id": "9231d980-3cd7-4a79-b07b-92f18f2d8cda", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "id": "c198d3a3-1962-47ce-9d27-2d9614a2db1a", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." }, { "id": "9f1ccc65-f3ba-458b-92e7-a95239e34ae8", "key": "scope", "value": "enterprise", "description": "(Required) The scope of the metadata template" }, { "id": "d9184d8b-13d6-4b2f-9ada-294b11069a17", "key": "template_key", "value": "", "description": "(Required) The name of the metadata template" } ] }, "description": "Deletes a piece of file metadata." }, "response": [ { "id": "5bfa5126-c5b2-4098-b729-fcd29ccb9806", "name": "Returns an empty response when the metadata is\nsuccessfully deleted.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-5bfa5126-c5b2-4098-b729-fcd29ccb9806" }, { "id": "56b5ad8e-e4ed-48f1-9339-2aac36f84788", "name": "Returned when the request parameters are not valid. This may happen of the\n`scope` is not valid.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-56b5ad8e-e4ed-48f1-9339-2aac36f84788" }, { "id": "a1568a68-c35d-40b5-8f84-4f2b0b99d185", "name": "Returns an error when the file does not have an instance of the metadata\ntemplate applied to it, or when the user does not have access to the\nfile.\n\n* `instance_not_found` - An instance of the metadata template with the\ngiven `scope` and `templateKey` was", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a1568a68-c35d-40b5-8f84-4f2b0b99d185" }, { "id": "59231e15-a39c-48d5-97dc-cee1d4127f1a", "name": "Returned when the method was not allowed.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-59231e15-a39c-48d5-97dc-cee1d4127f1a" }, { "id": "10178815-9c45-4345-81c4-61179ba9d63d", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "file_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-10178815-9c45-4345-81c4-61179ba9d63d" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-9231d980-3cd7-4a79-b07b-92f18f2d8cda" } ], "id": "3c35c66a-2828-4acc-b7d3-3708839fe312", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-3c35c66a-2828-4acc-b7d3-3708839fe312" } ], "id": "a529a0f9-6084-4480-b414-3b20bf475b9d", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a529a0f9-6084-4480-b414-3b20bf475b9d" }, { "name": "global", "item": [ { "name": "boxSkillsCards", "item": [ { "name": "List Box Skill cards on file", "id": "7176e7e4-d7f1-489c-b26f-05908fa0df2e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "id": "36ea1c1f-3bff-47b8-b6bd-1aa7fff98332", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "List the Box Skills metadata cards that are attached to a file." }, "response": [ { "id": "3a3188d9-41a0-45b1-b2a3-7df7db3246d3", "name": "Returns all the metadata associated with a file.\n\nThis API does not support pagination and will therefore always return\nall of the metadata associated to the file.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"$canEdit\": \"\",\n \"$id\": \"\",\n \"$parent\": \"\",\n \"$scope\": \"\",\n \"$template\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\",\n \"$version\": \"\",\n \"cards\": [\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-3a3188d9-41a0-45b1-b2a3-7df7db3246d3" }, { "id": "764ef94f-6aca-4d7f-ad4f-7dd3d12885f1", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-764ef94f-6aca-4d7f-ad4f-7dd3d12885f1" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-7176e7e4-d7f1-489c-b26f-05908fa0df2e" }, { "name": "Create Box Skill cards on file", "id": "4f417645-cf34-48b2-93f1-0d513a19389d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cards\": [\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "id": "29ac2a90-d536-46df-b456-285d07fb26a6", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Applies one or more Box Skills metadata cards to a file." }, "response": [ { "id": "6cfaf4e3-ab80-4b8d-bc3c-119c55f3e229", "name": "Returns the instance of the template that was applied to the file,\nincluding the data that was applied to the template.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cards\": [\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"$canEdit\": \"\",\n \"$id\": \"\",\n \"$parent\": \"\",\n \"$scope\": \"\",\n \"$template\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\",\n \"$version\": \"\",\n \"cards\": [\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-6cfaf4e3-ab80-4b8d-bc3c-119c55f3e229" }, { "id": "db193ff1-2f39-4502-aa34-acca2d2163bd", "name": "Returns an error when the request body is not valid.\n\n* `schema_validation_failed` - The request body contains a value for a for\na field that either does not exist, or for which the value or type does\nnot match the expected field type. An example might be", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cards\": [\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-db193ff1-2f39-4502-aa34-acca2d2163bd" }, { "id": "4750d002-f1b7-4cb5-8b29-a9191729e14a", "name": "Returns an error when the file or metadata template was not found.\n\n* `not_found` - The file could not be found, or the user does not have\naccess to the file.\n* `instance_tuple_not_found` - The metadata template was not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cards\": [\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-4750d002-f1b7-4cb5-8b29-a9191729e14a" }, { "id": "f779fc26-9ca3-4b5b-b3c8-b2b75508e2e6", "name": "Returns an error when an instance of this metadata template is already\npresent on the file.\n\n* `tuple_already_exists` - An instance of them metadata template already\nexists on the file.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cards\": [\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-f779fc26-9ca3-4b5b-b3c8-b2b75508e2e6" }, { "id": "24437ae1-893e-4bd0-9969-6b45db6650f1", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cards\": [\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-24437ae1-893e-4bd0-9969-6b45db6650f1" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-4f417645-cf34-48b2-93f1-0d513a19389d" }, { "name": "Update Box Skill cards on file", "id": "8d6bc59b-9af3-4287-b5fc-6d1c8c76903e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\",\n \"description\": \"The card to insert into the list of cards at the\\nposition defined by `path`.\"\n }\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\",\n \"description\": \"The card to insert into the list of cards at the\\nposition defined by `path`.\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "id": "476ff86c-4cae-4aac-94cb-19486ed768d8", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Updates one or more Box Skills metadata cards to a file." }, "response": [ { "id": "7fb62b1f-e95b-4cf3-9bbc-2828f6aab63e", "name": "Returns the updated metadata template, with the\ncustom template data included.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\",\n \"description\": \"The card to insert into the list of cards at the\\nposition defined by `path`.\"\n }\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\",\n \"description\": \"The card to insert into the list of cards at the\\nposition defined by `path`.\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"$canEdit\": \"\",\n \"$id\": \"\",\n \"$parent\": \"\",\n \"$scope\": \"\",\n \"$template\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\",\n \"$version\": \"\",\n \"cards\": [\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-7fb62b1f-e95b-4cf3-9bbc-2828f6aab63e" }, { "id": "68c90645-41b0-4032-b24a-54435ec0cad9", "name": "The requested file could not be found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\",\n \"description\": \"The card to insert into the list of cards at the\\nposition defined by `path`.\"\n }\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\",\n \"description\": \"The card to insert into the list of cards at the\\nposition defined by `path`.\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-68c90645-41b0-4032-b24a-54435ec0cad9" }, { "id": "063c599b-6352-4d67-9e78-fa0e5c0447c0", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\",\n \"description\": \"The card to insert into the list of cards at the\\nposition defined by `path`.\"\n }\n },\n {\n \"op\": \"replace\",\n \"path\": \"\",\n \"value\": {\n \"value\": \"reference #/components/schemas/KeywordSkillCard not found in the OpenAPI spec\",\n \"description\": \"The card to insert into the list of cards at the\\nposition defined by `path`.\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-063c599b-6352-4d67-9e78-fa0e5c0447c0" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-8d6bc59b-9af3-4287-b5fc-6d1c8c76903e" }, { "name": "Remove Box Skill cards from file", "id": "ab8959d2-d6fb-4860-9a36-920de1fdf653", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "id": "1ef83f74-1728-4d4c-a6bf-841592784dbd", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Removes any Box Skills cards metadata from a file." }, "response": [ { "id": "d8a339a9-8ef4-4551-8741-394e7d10d555", "name": "Returns an empty response when the cards are\nsuccessfully deleted.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d8a339a9-8ef4-4551-8741-394e7d10d555" }, { "id": "27de5fab-1971-462f-80aa-1f448bc82f2a", "name": "Returns an error when the file does not have an instance of the Box Skill\ncards applied to it, or when the user does not have access to the file.\n\n* `instance_not_found` - An instance of the metadata template for Box\nSkill cards was not found on this file", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-27de5fab-1971-462f-80aa-1f448bc82f2a" }, { "id": "a4951463-415f-4b2a-bf6f-195eed2264c6", "name": "Returned when the method was not allowed.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a4951463-415f-4b2a-bf6f-195eed2264c6" }, { "id": "8b2283d7-969f-4db8-834b-3044f11334cd", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata/global/boxSkillsCards", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata", "global", "boxSkillsCards" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-8b2283d7-969f-4db8-834b-3044f11334cd" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-ab8959d2-d6fb-4860-9a36-920de1fdf653" } ], "id": "39fdff2c-217e-40e6-a854-052044817fe0", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-39fdff2c-217e-40e6-a854-052044817fe0" } ], "id": "4e08062e-5114-464d-8861-5fe62802f50f", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-4e08062e-5114-464d-8861-5fe62802f50f" }, { "name": "Box List metadata instances on file", "id": "e9ea3175-511a-4f5d-b557-6c2264aeed91", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata" ], "variable": [ { "id": "90542958-10e9-418f-94dd-7b73b8e69905", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Retrieves all metadata for a given file." }, "response": [ { "id": "fa11dea3-df85-4c6a-b8d8-db81961797fa", "name": "Returns all the metadata associated with a file.\n\nThis API does not support pagination and will therefore always return\nall of the metadata associated to the file.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata" ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entries\": [\n {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n ],\n \"limit\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-fa11dea3-df85-4c6a-b8d8-db81961797fa" }, { "id": "bf7f9afa-085d-432c-89d1-afdc246ec7a3", "name": "Returned when the request parameters are not valid.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata" ], "variable": [ { "key": "file_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-bf7f9afa-085d-432c-89d1-afdc246ec7a3" }, { "id": "b42ef74b-31e2-457e-8be7-969daeac437d", "name": "Returned when the user does not have access to the file.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata" ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-b42ef74b-31e2-457e-8be7-969daeac437d" }, { "id": "b1d28e95-9302-416a-9977-fe21b93b0cad", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "metadata" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-b1d28e95-9302-416a-9977-fe21b93b0cad" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e9ea3175-511a-4f5d-b557-6c2264aeed91" } ], "id": "01e45c0a-f0f0-4e56-b8b8-6794665deb27", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-01e45c0a-f0f0-4e56-b8b8-6794665deb27" }, { "name": "watermark", "item": [ { "name": "Box Get watermark on file", "id": "e6fed211-5c57-41f9-9a57-f8712862e3bc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "watermark" ], "variable": [ { "id": "fe3721b4-4ad8-4b80-b777-bce02385124b", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Retrieve the watermark for a file." }, "response": [ { "id": "6f4ca695-0056-43b7-b8b1-1f3993b6ca52", "name": "Returns an object containing information about the\nwatermark associated for to this file.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "watermark" ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"watermark\": {\n \"created_at\": \"\",\n \"modified_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-6f4ca695-0056-43b7-b8b1-1f3993b6ca52" }, { "id": "6c06f235-2a9b-4798-844b-2ce25c9b61fe", "name": "Returns an error if the file does not have a watermark applied.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "watermark" ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-6c06f235-2a9b-4798-844b-2ce25c9b61fe" }, { "id": "4323f93a-785a-46c6-be83-c2ac0c1d7a2f", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "watermark" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-4323f93a-785a-46c6-be83-c2ac0c1d7a2f" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e6fed211-5c57-41f9-9a57-f8712862e3bc" }, { "name": "Box Apply watermark to file", "id": "4edbff49-5ae7-4acf-af54-670777257af5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"watermark\": {\n \"imprint\": \"default\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "watermark" ], "variable": [ { "id": "97034980-e6e7-4b7d-83d5-0c66eecc4de7", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Applies or update a watermark on a file." }, "response": [ { "id": "e70d3c2e-64f8-404b-adf4-6ffc987568c3", "name": "Returns an updated watermark if a watermark already\nexisted on this file.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"watermark\": {\n \"imprint\": \"default\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "watermark" ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"watermark\": {\n \"created_at\": \"\",\n \"modified_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e70d3c2e-64f8-404b-adf4-6ffc987568c3" }, { "id": "ea5472e7-a3f0-4e41-9873-aa77e0a5f834", "name": "Returns a new watermark if no watermark existed on\nthis file yet.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"watermark\": {\n \"imprint\": \"default\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "watermark" ], "variable": [ { "key": "file_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"watermark\": {\n \"created_at\": \"\",\n \"modified_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-ea5472e7-a3f0-4e41-9873-aa77e0a5f834" }, { "id": "91d70a0c-24a6-479d-93fb-ee76e64f4d1f", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"watermark\": {\n \"imprint\": \"default\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "watermark" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-91d70a0c-24a6-479d-93fb-ee76e64f4d1f" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-4edbff49-5ae7-4acf-af54-670777257af5" }, { "name": "Box Remove watermark from file", "id": "491ba4ea-dbd4-4daf-b0a8-863606cb103d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "watermark" ], "variable": [ { "id": "68a47190-511e-487e-9105-628d84e1f37d", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Removes the watermark from a file." }, "response": [ { "id": "94448609-6e78-4c71-83e2-eeef3cda3e1f", "name": "Removes the watermark and returns an empty response.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/files/:file_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "watermark" ], "variable": [ { "key": "file_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-94448609-6e78-4c71-83e2-eeef3cda3e1f" }, { "id": "c3b6df97-4b9a-4d2f-99bc-56639d862bb1", "name": "Returns an error if the file did not have\na watermark applied to it.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "watermark" ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-c3b6df97-4b9a-4d2f-99bc-56639d862bb1" }, { "id": "4ceedacf-3c97-4831-a6a2-c3936e0e115d", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id", "watermark" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-4ceedacf-3c97-4831-a6a2-c3936e0e115d" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-491ba4ea-dbd4-4daf-b0a8-863606cb103d" } ], "id": "095bd33f-9ec7-4a31-b3f9-537bf3d6a644", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-095bd33f-9ec7-4a31-b3f9-537bf3d6a644" }, { "name": "Box Get file information", "id": "275ded60-8375-4040-a6c9-d00a21ad33c5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "description": "A header required to request specific `representations`\nof a file. Use this in combination with the `fields` query\nparameter to request a specific file representation.\n\nThe general format for these representations is\n`X-Rep-Hints: [...]` where `[...]` is one or many\nhints in the format `[fileType?query]`.\n\nFor example, to request a `png` representation in `32x32`\nas well as `64x64` pixel dimensions provide the following\nhints.\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nAdditionally, a `text` representation is available for all\ndocument file types in Box using the `[extracted_text]`\nrepresentation.\n\n`x-rep-hints: [extracted_text]`", "key": "x-rep-hints", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," } ], "variable": [ { "id": "cec0fcbc-d203-480e-a76d-d91a3e66de1b", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Retrieves the details about a file." }, "response": [ { "id": "56caa45e-9dd2-464f-9b52-293084b17156", "name": "Returns a file object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "description": "A header required to request specific `representations`\nof a file. Use this in combination with the `fields` query\nparameter to request a specific file representation.\n\nThe general format for these representations is\n`X-Rep-Hints: [...]` where `[...]` is one or many\nhints in the format `[fileType?query]`.\n\nFor example, to request a `png` representation in `32x32`\nas well as `64x64` pixel dimensions provide the following\nhints.\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nAdditionally, a `text` representation is available for all\ndocument file types in Box using the `[extracted_text]`\nrepresentation.\n\n`x-rep-hints: [extracted_text]`", "key": "x-rep-hints", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"open\",\n \"effective_permission\": \"no_access\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopi\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_download\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"annotation_edit\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"previewer uploader\",\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"utb3\": {\n \"inc7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_preview\",\n \"can_download\"\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-56caa45e-9dd2-464f-9b52-293084b17156" }, { "id": "8009e86c-ddfc-46c8-8ae6-52da16abccd1", "name": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the folder. This indicates that the folder\nhas not changed since it was last requested.", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "description": "A header required to request specific `representations`\nof a file. Use this in combination with the `fields` query\nparameter to request a specific file representation.\n\nThe general format for these representations is\n`X-Rep-Hints: [...]` where `[...]` is one or many\nhints in the format `[fileType?query]`.\n\nFor example, to request a `png` representation in `32x32`\nas well as `64x64` pixel dimensions provide the following\nhints.\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nAdditionally, a `text` representation is available for all\ndocument file types in Box using the `[extracted_text]`\nrepresentation.\n\n`x-rep-hints: [extracted_text]`", "key": "x-rep-hints", "value": "" } ], "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Modified", "code": 304, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-8009e86c-ddfc-46c8-8ae6-52da16abccd1" }, { "id": "76726eff-b732-47dc-ac38-16cd5e69bccc", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "description": "A header required to request specific `representations`\nof a file. Use this in combination with the `fields` query\nparameter to request a specific file representation.\n\nThe general format for these representations is\n`X-Rep-Hints: [...]` where `[...]` is one or many\nhints in the format `[fileType?query]`.\n\nFor example, to request a `png` representation in `32x32`\nas well as `64x64` pixel dimensions provide the following\nhints.\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nAdditionally, a `text` representation is available for all\ndocument file types in Box using the `[extracted_text]`\nrepresentation.\n\n`x-rep-hints: [extracted_text]`", "key": "x-rep-hints", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-76726eff-b732-47dc-ac38-16cd5e69bccc" }, { "id": "d90843fd-277e-4e8d-8fa2-5ec8db7912a4", "name": "Returned if the file is not found, or the user does not\nhave access to the file.", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "description": "A header required to request specific `representations`\nof a file. Use this in combination with the `fields` query\nparameter to request a specific file representation.\n\nThe general format for these representations is\n`X-Rep-Hints: [...]` where `[...]` is one or many\nhints in the format `[fileType?query]`.\n\nFor example, to request a `png` representation in `32x32`\nas well as `64x64` pixel dimensions provide the following\nhints.\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nAdditionally, a `text` representation is available for all\ndocument file types in Box using the `[extracted_text]`\nrepresentation.\n\n`x-rep-hints: [extracted_text]`", "key": "x-rep-hints", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d90843fd-277e-4e8d-8fa2-5ec8db7912a4" }, { "id": "3f75c818-4ffa-4ede-b7d7-097be8acd987", "name": "Returned if the `file_id` is not in a recognized format.", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "description": "A header required to request specific `representations`\nof a file. Use this in combination with the `fields` query\nparameter to request a specific file representation.\n\nThe general format for these representations is\n`X-Rep-Hints: [...]` where `[...]` is one or many\nhints in the format `[fileType?query]`.\n\nFor example, to request a `png` representation in `32x32`\nas well as `64x64` pixel dimensions provide the following\nhints.\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nAdditionally, a `text` representation is available for all\ndocument file types in Box using the `[extracted_text]`\nrepresentation.\n\n`x-rep-hints: [extracted_text]`", "key": "x-rep-hints", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-3f75c818-4ffa-4ede-b7d7-097be8acd987" }, { "id": "d29b85c2-3522-4ce9-bfe1-fc14e9076d77", "name": "Returns an error if an action is performed on a file with an\nincorrect media type.\n\n* `unsupported_media_type` when requesting an `expiring_embed_link`\n for a file that is not supported by Box Embed.", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "description": "A header required to request specific `representations`\nof a file. Use this in combination with the `fields` query\nparameter to request a specific file representation.\n\nThe general format for these representations is\n`X-Rep-Hints: [...]` where `[...]` is one or many\nhints in the format `[fileType?query]`.\n\nFor example, to request a `png` representation in `32x32`\nas well as `64x64` pixel dimensions provide the following\nhints.\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nAdditionally, a `text` representation is available for all\ndocument file types in Box using the `[extracted_text]`\nrepresentation.\n\n`x-rep-hints: [extracted_text]`", "key": "x-rep-hints", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Unsupported Media Type", "code": 415, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d29b85c2-3522-4ce9-bfe1-fc14e9076d77" }, { "id": "402301c5-f6ee-4b5f-8918-f0bd0f8bf19a", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "description": "A header required to request specific `representations`\nof a file. Use this in combination with the `fields` query\nparameter to request a specific file representation.\n\nThe general format for these representations is\n`X-Rep-Hints: [...]` where `[...]` is one or many\nhints in the format `[fileType?query]`.\n\nFor example, to request a `png` representation in `32x32`\nas well as `64x64` pixel dimensions provide the following\nhints.\n\n`x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64]`\n\nAdditionally, a `text` representation is available for all\ndocument file types in Box using the `[extracted_text]`\nrepresentation.\n\n`x-rep-hints: [extracted_text]`", "key": "x-rep-hints", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-402301c5-f6ee-4b5f-8918-f0bd0f8bf19a" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-275ded60-8375-4040-a6c9-d00a21ad33c5" }, { "name": "Box Update file", "id": "4bc3b74f-d871-4f9a-a0aa-ceb4c6972766", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"lock\": {\n \"access\": \"lock\",\n \"expires_at\": \"\",\n \"is_download_prevented\": \"\"\n },\n \"disposition_at\": \"\",\n \"permissions\": {\n \"can_download\": \"open\"\n },\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "id": "99a1a490-f095-4bd6-b90e-c8d04252231c", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Updates a file. This can be used to rename or move a file,\ncreate a shared link, or lock a file." }, "response": [ { "id": "77335b29-da38-4bd5-aa8f-a39606e1bf0f", "name": "Returns a file object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"lock\": {\n \"access\": \"lock\",\n \"expires_at\": \"\",\n \"is_download_prevented\": \"\"\n },\n \"disposition_at\": \"\",\n \"permissions\": {\n \"can_download\": \"open\"\n },\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"open\",\n \"effective_permission\": \"no_access\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopi\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_download\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"annotation_edit\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"previewer uploader\",\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"utb3\": {\n \"inc7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_preview\",\n \"can_download\"\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-77335b29-da38-4bd5-aa8f-a39606e1bf0f" }, { "id": "046ac50e-7e2d-4e59-9b10-e233d6ca30bd", "name": "Returned when the new retention time > maximum retention length.", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"lock\": {\n \"access\": \"lock\",\n \"expires_at\": \"\",\n \"is_download_prevented\": \"\"\n },\n \"disposition_at\": \"\",\n \"permissions\": {\n \"can_download\": \"open\"\n },\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-046ac50e-7e2d-4e59-9b10-e233d6ca30bd" }, { "id": "00417e31-36f0-4665-8a86-bbc97359ee82", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"lock\": {\n \"access\": \"lock\",\n \"expires_at\": \"\",\n \"is_download_prevented\": \"\"\n },\n \"disposition_at\": \"\",\n \"permissions\": {\n \"can_download\": \"open\"\n },\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-00417e31-36f0-4665-8a86-bbc97359ee82" }, { "id": "54119985-c7e1-46db-8490-26b1040fa420", "name": "Returned if the user does not have all the permissions to complete the\nupdate.\n\n* `access_denied_insufficient_permissions` returned\nwhen the authenticated user does not have access\nto the destination folder to move the file to.\n* Returned when retention t", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"lock\": {\n \"access\": \"lock\",\n \"expires_at\": \"\",\n \"is_download_prevented\": \"\"\n },\n \"disposition_at\": \"\",\n \"permissions\": {\n \"can_download\": \"open\"\n },\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-54119985-c7e1-46db-8490-26b1040fa420" }, { "id": "839dd562-40e7-40ad-b915-1a97dcdceed6", "name": "Returned if the file is not found, or the user does not\nhave access to the file.", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"lock\": {\n \"access\": \"lock\",\n \"expires_at\": \"\",\n \"is_download_prevented\": \"\"\n },\n \"disposition_at\": \"\",\n \"permissions\": {\n \"can_download\": \"open\"\n },\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-839dd562-40e7-40ad-b915-1a97dcdceed6" }, { "id": "2be7f512-6e23-43fe-81ac-5743d49f08e4", "name": "Returned if the `file_id` is not in a recognized format.", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"lock\": {\n \"access\": \"lock\",\n \"expires_at\": \"\",\n \"is_download_prevented\": \"\"\n },\n \"disposition_at\": \"\",\n \"permissions\": {\n \"can_download\": \"open\"\n },\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-2be7f512-6e23-43fe-81ac-5743d49f08e4" }, { "id": "77469a20-e7b3-4e6e-8fe5-1f944213250a", "name": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file. This indicates that the file\nhas changed since it was last requested.", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"lock\": {\n \"access\": \"lock\",\n \"expires_at\": \"\",\n \"is_download_prevented\": \"\"\n },\n \"disposition_at\": \"\",\n \"permissions\": {\n \"can_download\": \"open\"\n },\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-77469a20-e7b3-4e6e-8fe5-1f944213250a" }, { "id": "651965b3-8e6a-4f67-89c2-4a06225c3c0c", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"lock\": {\n \"access\": \"lock\",\n \"expires_at\": \"\",\n \"is_download_prevented\": \"\"\n },\n \"disposition_at\": \"\",\n \"permissions\": {\n \"can_download\": \"open\"\n },\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"tags\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-651965b3-8e6a-4f67-89c2-4a06225c3c0c" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-4bc3b74f-d871-4f9a-a0aa-ceb4c6972766" }, { "name": "Box Delete file", "id": "6c7b37ba-47dd-4dc0-b437-99a7e4e3ab96", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "variable": [ { "id": "38ff2821-2a46-4ef6-83f3-e4906aefdf36", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Deletes a file, either permanently or by moving it to\nthe trash.\n\nThe the enterprise settings determine whether the item will\nbe permanently deleted from Box or moved to the trash." }, "response": [ { "id": "1e339080-5568-437c-9614-9f3873d5a1c8", "name": "Returns an empty response when the file has been successfully\ndeleted.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" } ], "url": { "raw": "{{baseUrl}}/files/:file_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "variable": [ { "key": "file_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-1e339080-5568-437c-9614-9f3873d5a1c8" }, { "id": "109945fb-7536-4ff4-9b21-861074818496", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "variable": [ { "key": "file_id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-109945fb-7536-4ff4-9b21-861074818496" }, { "id": "d8d29383-94d2-4411-828a-f7a776494294", "name": "Returned if the file is not found or has already been deleted, or the user\ndoes not have access to the file.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d8d29383-94d2-4411-828a-f7a776494294" }, { "id": "df45b23f-d723-42c1-b7f8-b224dac5ef49", "name": "Returned if the `file_id` is not in a recognized format.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "variable": [ { "key": "file_id" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-df45b23f-d723-42c1-b7f8-b224dac5ef49" }, { "id": "68f0826d-c571-4d0c-9219-34ec985eae4b", "name": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file. This indicates that the file\nhas changed since it was last requested.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "variable": [ { "key": "file_id" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-68f0826d-c571-4d0c-9219-34ec985eae4b" }, { "id": "19dd25e7-7281-4e61-95b7-886cd8aafc89", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:file_id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-19dd25e7-7281-4e61-95b7-886cd8aafc89" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-6c7b37ba-47dd-4dc0-b437-99a7e4e3ab96" }, { "name": "Box Restore file", "id": "591e33a1-5005-4167-81ff-015333a53434", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "id": "e830000e-86d0-4d35-b679-abb791c85178", "key": "file_id", "value": "", "description": "(Required) The unique identifier that represents a file.\n\nThe ID for any file can be determined\nby visiting a file in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/files/123`\nthe `file_id` is `123`." } ] }, "description": "Restores a file that has been moved to the trash.\n\nAn optional new parent ID can be provided to restore the file to in case the\noriginal folder has been deleted." }, "response": [ { "id": "9c8927c4-1cda-455f-9781-2a129bf66cef", "name": "Returns a file object when the file has been restored.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/components/schemas/TrashFileRestored not found in the OpenAPI spec\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-9c8927c4-1cda-455f-9781-2a129bf66cef" }, { "id": "06e68c86-750f-4aa2-b30e-b3408769c210", "name": "Returns an error if the user does not have access to the folder\nthe file is being restored to, or the user does not have permission\nto restore files from the trash.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-06e68c86-750f-4aa2-b30e-b3408769c210" }, { "id": "55f8515b-09ef-4441-83cf-d2653fda750e", "name": "Returns an error if the file is not in the trash.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-55f8515b-09ef-4441-83cf-d2653fda750e" }, { "id": "baf28220-f261-4883-9d99-4c94b5d26b9a", "name": "Returns an error if there is an file with the same name\nin the folder the file is being restored to.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-baf28220-f261-4883-9d99-4c94b5d26b9a" }, { "id": "c31fbfa4-aaff-45d4-a99c-e917fe0328ce", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:file_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "files", ":file_id" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ], "variable": [ { "key": "file_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-c31fbfa4-aaff-45d4-a99c-e917fe0328ce" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-591e33a1-5005-4167-81ff-015333a53434" } ], "id": "dd646c07-4650-4327-a4ce-cdb96d0b0d7c", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-dd646c07-4650-4327-a4ce-cdb96d0b0d7c" }, { "name": "content", "item": [ { "name": "Box Preflight check before upload", "id": "b6c298a4-fc1c-4b66-864b-06206091a3e9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "OPTIONS", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"size\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/content", "host": [ "{{baseUrl}}" ], "path": [ "files", "content" ] }, "description": "Performs a check to verify that a file will be accepted by Box\nbefore you upload the entire file." }, "response": [ { "id": "debb507f-43cf-4acc-83e0-c3c09e6e745f", "name": "If the check passed, the response will include a session URL that\ncan be used to upload the file to.", "originalRequest": { "method": "OPTIONS", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"size\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/content", "host": [ "{{baseUrl}}" ], "path": [ "files", "content" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"upload_url\": \"\",\n \"upload_token\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-debb507f-43cf-4acc-83e0-c3c09e6e745f" }, { "id": "17ea451d-9547-4840-87b1-13047774cdd0", "name": "If the check did not pass, the response will include some details on\nwhy it did not pass.", "originalRequest": { "method": "OPTIONS", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"size\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/content", "host": [ "{{baseUrl}}" ], "path": [ "files", "content" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"too_many_requests\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\",\n \"conflicts\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n }\n }\n ]\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-17ea451d-9547-4840-87b1-13047774cdd0" }, { "id": "3dda46ed-5690-4d0b-8d97-212c285a2041", "name": "An unexpected client error.", "originalRequest": { "method": "OPTIONS", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"size\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/content", "host": [ "{{baseUrl}}" ], "path": [ "files", "content" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-3dda46ed-5690-4d0b-8d97-212c285a2041" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-b6c298a4-fc1c-4b66-864b-06206091a3e9" }, { "name": "Box Upload file", "id": "4aca577f-3316-4369-9777-81285f1f9b5f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "An optional header containing the SHA1 hash of the file to\nensure that the file was not corrupted in transit.", "key": "content-md5", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The additional attributes of the file being uploaded. Mainly the\nname and the parent folder. These attributes are part of the multi\npart request body and are in JSON format.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "attributes", "value": "[object Object]", "type": "text" }, { "description": "(Required) The content of the file to upload to Box.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "file", "type": "file", "value": null } ] }, "url": { "raw": "https://upload.box.com/api/2.0/files/content?fields=,", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "content" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ] }, "description": "Uploads a small file to Box. For file sizes over 50MB we recommend\nusing the Chunk Upload APIs.\n\n# Request body order\n\nThe `attributes` part of the body must come **before** the\n`file` part. Requests that do not follow this format when\nuploading the file will receive a HTTP `400` error with a\n`metadata_after_file_contents` error code." }, "response": [ { "id": "eafb3810-c942-4cce-9b80-3e4468e973ef", "name": "Returns the new file object in a list.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header containing the SHA1 hash of the file to\nensure that the file was not corrupted in transit.", "key": "content-md5", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The additional attributes of the file being uploaded. Mainly the\nname and the parent folder. These attributes are part of the multi\npart request body and are in JSON format.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "attributes", "value": "[object Object]", "type": "text" }, { "description": "(Required) The content of the file to upload to Box.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "file", "type": "file" } ] }, "url": { "raw": "https://upload.box.com/api/2.0/files/content?fields=,", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "content" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"collaborators\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"other\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"annotation_view_self\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"annotation_view_all\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"allowed_invitee_roles\": [\n \"previewer uploader\",\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"eu_69d\": {\n \"ipsuma_a\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"suntf6\": {\n \"fugiat3_4\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"pending\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\",\n \"can_edit\"\n ]\n },\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_edit\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"collaborators\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"trashed\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopi\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"annotation_edit\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"base_upload\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"allowed_invitee_roles\": [\n \"co-owner\",\n \"uploader\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"Ut_b_\": {\n \"ea_e\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sita0f\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"do_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"in_3c_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"amet338\": {\n \"aute__3\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"fugiat0c\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"elit_b5\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"tempor_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"dolore48\": {\n \"mollit_3_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"pariatura1\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sunt_15\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_preview\",\n \"can_edit\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-eafb3810-c942-4cce-9b80-3e4468e973ef" }, { "id": "d3d49360-e4f4-4cb3-b980-3790a04e48b1", "name": "Returns an error if some of the parameters are missing or\nnot valid.\n* `bad_request` when a parameter is missing or incorrect.\n* `item_name_too_long` when the folder name is too long.\n* `item_name_invalid` when the folder name contains\n non-valid charact", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header containing the SHA1 hash of the file to\nensure that the file was not corrupted in transit.", "key": "content-md5", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The additional attributes of the file being uploaded. Mainly the\nname and the parent folder. These attributes are part of the multi\npart request body and are in JSON format.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "attributes", "value": "[object Object]", "type": "text" }, { "description": "(Required) The content of the file to upload to Box.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "file", "type": "file" } ] }, "url": { "raw": "https://upload.box.com/api/2.0/files/content?fields=,", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "content" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d3d49360-e4f4-4cb3-b980-3790a04e48b1" }, { "id": "b89bbb49-c1f4-4e4b-a0f2-80a699b026b5", "name": "Returns an error if the parent folder\ndoes not exist or if the user\nis not authorized to access the parent folder.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header containing the SHA1 hash of the file to\nensure that the file was not corrupted in transit.", "key": "content-md5", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The additional attributes of the file being uploaded. Mainly the\nname and the parent folder. These attributes are part of the multi\npart request body and are in JSON format.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "attributes", "value": "[object Object]", "type": "text" }, { "description": "(Required) The content of the file to upload to Box.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "file", "type": "file" } ] }, "url": { "raw": "https://upload.box.com/api/2.0/files/content?fields=,", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "content" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-b89bbb49-c1f4-4e4b-a0f2-80a699b026b5" }, { "id": "8618a3c4-71f5-451d-b9d8-129f9546c5a2", "name": "Returns an error if the file already exists,\nor the account has run out of disk space.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header containing the SHA1 hash of the file to\nensure that the file was not corrupted in transit.", "key": "content-md5", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The additional attributes of the file being uploaded. Mainly the\nname and the parent folder. These attributes are part of the multi\npart request body and are in JSON format.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "attributes", "value": "[object Object]", "type": "text" }, { "description": "(Required) The content of the file to upload to Box.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "file", "type": "file" } ] }, "url": { "raw": "https://upload.box.com/api/2.0/files/content?fields=,", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "content" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-8618a3c4-71f5-451d-b9d8-129f9546c5a2" }, { "id": "f9d38917-c9ad-4d08-b66f-5a4166571070", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header containing the SHA1 hash of the file to\nensure that the file was not corrupted in transit.", "key": "content-md5", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The additional attributes of the file being uploaded. Mainly the\nname and the parent folder. These attributes are part of the multi\npart request body and are in JSON format.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "attributes", "value": "[object Object]", "type": "text" }, { "description": "(Required) The content of the file to upload to Box.\n\n\n\n The `attributes` part of the body must come **before** the\n `file` part. Requests that do not follow this format when\n uploading the file will receive a HTTP `400` error with a\n `metadata_after_file_contents` error code.\n\n", "key": "file", "type": "file" } ] }, "url": { "raw": "https://upload.box.com/api/2.0/files/content?fields=,", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "content" ], "query": [ { "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.", "key": "fields", "value": "," } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-f9d38917-c9ad-4d08-b66f-5a4166571070" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-4aca577f-3316-4369-9777-81285f1f9b5f" } ], "id": "07efb516-99c2-4c4b-9ac0-2b1cf321b14d", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-07efb516-99c2-4c4b-9ac0-2b1cf321b14d" }, { "name": "upload_sessions", "item": [ { "name": "{upload_session_id}", "item": [ { "name": "parts", "item": [ { "name": "Box List parts", "id": "130d30f1-4ef3-4230-9986-9e8dca124f25", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id/parts?offset=0&limit=", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id", "parts" ], "query": [ { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" } ], "variable": [ { "id": "816e5966-a999-4a10-a63a-a9ba491a2a70", "key": "upload_session_id", "value": "", "description": "(Required) The ID of the upload session." } ] }, "description": "Return a list of the chunks uploaded to the upload\nsession so far." }, "response": [ { "id": "077348b0-7996-4e1e-b759-d2d6e1c0d55a", "name": "Returns a list of parts that have been uploaded.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id/parts?offset=0&limit=", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id", "parts" ], "query": [ { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" } ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n },\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n }\n ],\n \"entries\": [\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n }\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-077348b0-7996-4e1e-b759-d2d6e1c0d55a" }, { "id": "d908573b-17f1-4587-9222-65a733f28a3a", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id/parts?offset=0&limit=", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id", "parts" ], "query": [ { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" } ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-d908573b-17f1-4587-9222-65a733f28a3a" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-130d30f1-4ef3-4230-9986-9e8dca124f25" } ], "id": "1dca4204-3bdc-405e-a5dd-c756d409ef3b", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-1dca4204-3bdc-405e-a5dd-c756d409ef3b" }, { "name": "commit", "item": [ { "name": "Box Commit upload session", "id": "670fcb0d-c12f-48da-9776-1d18f8b39c9b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) The [RFC3230][1] message digest of the whole file.\n\nOnly SHA1 is supported. The SHA1 digest must be Base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\n[1]: https://tools.ietf.org/html/rfc3230", "key": "digest", "value": "" }, { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parts\": [\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id/commit", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id", "commit" ], "variable": [ { "id": "68e8a44f-f6fe-423a-a555-a4c4352d243b", "key": "upload_session_id", "value": "", "description": "(Required) The ID of the upload session." } ] }, "description": "Close an upload session and create a file from the\nuploaded chunks." }, "response": [ { "id": "8549b883-d363-4142-95b3-fd5e26f34d76", "name": "Returns the file object in a list.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The [RFC3230][1] message digest of the whole file.\n\nOnly SHA1 is supported. The SHA1 digest must be Base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\n[1]: https://tools.ietf.org/html/rfc3230", "key": "digest", "value": "" }, { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parts\": [\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id/commit", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id", "commit" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"collaborators\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"other\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"annotation_view_self\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"annotation_view_all\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"allowed_invitee_roles\": [\n \"previewer uploader\",\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"eu_69d\": {\n \"ipsuma_a\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"suntf6\": {\n \"fugiat3_4\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"pending\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\",\n \"can_edit\"\n ]\n },\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_edit\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"collaborators\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"trashed\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopi\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"annotation_edit\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"base_upload\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"allowed_invitee_roles\": [\n \"co-owner\",\n \"uploader\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"Ut_b_\": {\n \"ea_e\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sita0f\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"do_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"in_3c_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"amet338\": {\n \"aute__3\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"fugiat0c\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"elit_b5\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"tempor_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"dolore48\": {\n \"mollit_3_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"pariatura1\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sunt_15\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_preview\",\n \"can_edit\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-8549b883-d363-4142-95b3-fd5e26f34d76" }, { "id": "e08416ae-0bb7-46c7-88b3-84e069b7299a", "name": "Returns when all chunks have been uploaded but not yet processed.\n\nInspect the upload session to get more information about the\nprogress of processing the chunks, then retry committing the file\nwhen all chunks have processed.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The [RFC3230][1] message digest of the whole file.\n\nOnly SHA1 is supported. The SHA1 digest must be Base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\n[1]: https://tools.ietf.org/html/rfc3230", "key": "digest", "value": "" }, { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parts\": [\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id/commit", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id", "commit" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [ { "disabled": false, "description": { "content": "Indicates the number of seconds the client should wait before\nattempting their commit request again.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e08416ae-0bb7-46c7-88b3-84e069b7299a" }, { "id": "b87f65f9-7b80-49bb-882a-1121f5690294", "name": "Returns an error if there is already a file with the same name\nin the target folder.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The [RFC3230][1] message digest of the whole file.\n\nOnly SHA1 is supported. The SHA1 digest must be Base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\n[1]: https://tools.ietf.org/html/rfc3230", "key": "digest", "value": "" }, { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parts\": [\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id/commit", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id", "commit" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-b87f65f9-7b80-49bb-882a-1121f5690294" }, { "id": "99e1cb80-1796-4a55-b000-6b63bcdea7c0", "name": "Returns an error if the `If-Match` or `If-None-Match` conditions fail.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The [RFC3230][1] message digest of the whole file.\n\nOnly SHA1 is supported. The SHA1 digest must be Base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\n[1]: https://tools.ietf.org/html/rfc3230", "key": "digest", "value": "" }, { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parts\": [\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id/commit", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id", "commit" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-99e1cb80-1796-4a55-b000-6b63bcdea7c0" }, { "id": "85c4f515-1f0b-4786-bc1f-66e89e650198", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) The [RFC3230][1] message digest of the whole file.\n\nOnly SHA1 is supported. The SHA1 digest must be Base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\n[1]: https://tools.ietf.org/html/rfc3230", "key": "digest", "value": "" }, { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parts\": [\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n },\n {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id/commit", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id", "commit" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-85c4f515-1f0b-4786-bc1f-66e89e650198" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-670fcb0d-c12f-48da-9776-1d18f8b39c9b" } ], "id": "aee2793c-4055-4c7d-b1b0-b990b4e4c109", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-aee2793c-4055-4c7d-b1b0-b990b4e4c109" }, { "name": "Box Get upload session", "id": "a5e3cc55-6a30-4ff3-afd1-624df47dc640", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id" ], "variable": [ { "id": "d5421f36-3c32-482c-9805-d5a842b308c0", "key": "upload_session_id", "value": "", "description": "(Required) The ID of the upload session." } ] }, "description": "Return information about an upload session." }, "response": [ { "id": "74f02dac-6bae-4362-9d3c-a3a5883b4dfa", "name": "Returns an upload session object.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"upload_session\",\n \"session_expires_at\": \"\",\n \"part_size\": \"\",\n \"total_parts\": \"\",\n \"num_parts_processed\": \"\",\n \"session_endpoints\": {\n \"upload_part\": \"\",\n \"commit\": \"\",\n \"abort\": \"\",\n \"list_parts\": \"\",\n \"status\": \"\",\n \"log_event\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-74f02dac-6bae-4362-9d3c-a3a5883b4dfa" }, { "id": "04721c64-50b4-4398-b8c9-b5e3058cf1e0", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-04721c64-50b4-4398-b8c9-b5e3058cf1e0" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a5e3cc55-6a30-4ff3-afd1-624df47dc640" }, { "name": "Box Upload part of file", "id": "2e9bd2e5-fa5b-406f-886d-ecb567363b5e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "(Required) The [RFC3230][1] message digest of the chunk uploaded.\n\nOnly SHA1 is supported. The SHA1 digest must be base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\nTo get the value for the `SHA` digest, use the\nopenSSL command to encode the file part:\n`openssl sha1 -binary | base64`\n\n[1]: https://tools.ietf.org/html/rfc3230", "key": "digest", "value": "" }, { "description": "(Required) The byte range of the chunk.\n\nMust not overlap with the range of a part already\nuploaded this session. Each part\u2019s size must be\nexactly equal in size to the part size specified\nin the upload session that you created.\nOne exception is the last part of the file, as this can be smaller.\n\nWhen providing the value for `content-range`, remember that:\n\n* The lower bound of each part's byte range\n must be a multiple of the part size.\n* The higher bound must be a multiple of the part size - 1.", "key": "content-range", "value": "" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id" ], "variable": [ { "id": "085641c3-15a6-4e07-b3f9-7ce15d325246", "key": "upload_session_id", "value": "", "description": "(Required) The ID of the upload session." } ] }, "description": "Updates a chunk of an upload session for a file." }, "response": [ { "id": "680e527d-261e-44c8-baa8-b1bb1c28b628", "name": "Chunk has been uploaded successfully.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The [RFC3230][1] message digest of the chunk uploaded.\n\nOnly SHA1 is supported. The SHA1 digest must be base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\nTo get the value for the `SHA` digest, use the\nopenSSL command to encode the file part:\n`openssl sha1 -binary | base64`\n\n[1]: https://tools.ietf.org/html/rfc3230", "key": "digest", "value": "" }, { "description": "(Required) The byte range of the chunk.\n\nMust not overlap with the range of a part already\nuploaded this session. Each part\u2019s size must be\nexactly equal in size to the part size specified\nin the upload session that you created.\nOne exception is the last part of the file, as this can be smaller.\n\nWhen providing the value for `content-range`, remember that:\n\n* The lower bound of each part's byte range\n must be a multiple of the part size.\n* The higher bound must be a multiple of the part size - 1.", "key": "content-range", "value": "" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"part\": {\n \"value\": \"reference #/components/schemas/UploadPart not found in the OpenAPI spec\"\n }\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-680e527d-261e-44c8-baa8-b1bb1c28b628" }, { "id": "2d12a9e1-231e-41e5-910d-32ab55f4a4a5", "name": "Returns an error if the chunk conflicts with another\nchunk previously uploaded.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The [RFC3230][1] message digest of the chunk uploaded.\n\nOnly SHA1 is supported. The SHA1 digest must be base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\nTo get the value for the `SHA` digest, use the\nopenSSL command to encode the file part:\n`openssl sha1 -binary | base64`\n\n[1]: https://tools.ietf.org/html/rfc3230", "key": "digest", "value": "" }, { "description": "(Required) The byte range of the chunk.\n\nMust not overlap with the range of a part already\nuploaded this session. Each part\u2019s size must be\nexactly equal in size to the part size specified\nin the upload session that you created.\nOne exception is the last part of the file, as this can be smaller.\n\nWhen providing the value for `content-range`, remember that:\n\n* The lower bound of each part's byte range\n must be a multiple of the part size.\n* The higher bound must be a multiple of the part size - 1.", "key": "content-range", "value": "" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-2d12a9e1-231e-41e5-910d-32ab55f4a4a5" }, { "id": "f5e94435-0de2-4a62-b949-682bd230cf73", "name": "Returns an error if a precondition was not met.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The [RFC3230][1] message digest of the chunk uploaded.\n\nOnly SHA1 is supported. The SHA1 digest must be base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\nTo get the value for the `SHA` digest, use the\nopenSSL command to encode the file part:\n`openssl sha1 -binary | base64`\n\n[1]: https://tools.ietf.org/html/rfc3230", "key": "digest", "value": "" }, { "description": "(Required) The byte range of the chunk.\n\nMust not overlap with the range of a part already\nuploaded this session. Each part\u2019s size must be\nexactly equal in size to the part size specified\nin the upload session that you created.\nOne exception is the last part of the file, as this can be smaller.\n\nWhen providing the value for `content-range`, remember that:\n\n* The lower bound of each part's byte range\n must be a multiple of the part size.\n* The higher bound must be a multiple of the part size - 1.", "key": "content-range", "value": "" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-f5e94435-0de2-4a62-b949-682bd230cf73" }, { "id": "50dea52d-9af7-488a-bf4b-c875873a0786", "name": "Returns an error if the content range does not match a specified range\nfor the session.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The [RFC3230][1] message digest of the chunk uploaded.\n\nOnly SHA1 is supported. The SHA1 digest must be base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\nTo get the value for the `SHA` digest, use the\nopenSSL command to encode the file part:\n`openssl sha1 -binary | base64`\n\n[1]: https://tools.ietf.org/html/rfc3230", "key": "digest", "value": "" }, { "description": "(Required) The byte range of the chunk.\n\nMust not overlap with the range of a part already\nuploaded this session. Each part\u2019s size must be\nexactly equal in size to the part size specified\nin the upload session that you created.\nOne exception is the last part of the file, as this can be smaller.\n\nWhen providing the value for `content-range`, remember that:\n\n* The lower bound of each part's byte range\n must be a multiple of the part size.\n* The higher bound must be a multiple of the part size - 1.", "key": "content-range", "value": "" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "Requested Range Not Satisfiable", "code": 416, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-50dea52d-9af7-488a-bf4b-c875873a0786" }, { "id": "e9961636-a5f4-46a6-bcf4-5cb17fc4e76c", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "description": "(Required) The [RFC3230][1] message digest of the chunk uploaded.\n\nOnly SHA1 is supported. The SHA1 digest must be base64\nencoded. The format of this header is as\n`sha=BASE64_ENCODED_DIGEST`.\n\nTo get the value for the `SHA` digest, use the\nopenSSL command to encode the file part:\n`openssl sha1 -binary | base64`\n\n[1]: https://tools.ietf.org/html/rfc3230", "key": "digest", "value": "" }, { "description": "(Required) The byte range of the chunk.\n\nMust not overlap with the range of a part already\nuploaded this session. Each part\u2019s size must be\nexactly equal in size to the part size specified\nin the upload session that you created.\nOne exception is the last part of the file, as this can be smaller.\n\nWhen providing the value for `content-range`, remember that:\n\n* The lower bound of each part's byte range\n must be a multiple of the part size.\n* The higher bound must be a multiple of the part size - 1.", "key": "content-range", "value": "" }, { "key": "Content-Type", "value": "application/octet-stream" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e9961636-a5f4-46a6-bcf4-5cb17fc4e76c" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-2e9bd2e5-fa5b-406f-886d-ecb567363b5e" }, { "name": "Box Remove upload session", "id": "ea0ea53a-7dce-4ac2-829f-a4b153f5a233", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id" ], "variable": [ { "id": "9325fb96-a557-4620-a600-fd6dfab73798", "key": "upload_session_id", "value": "", "description": "(Required) The ID of the upload session." } ] }, "description": "Abort an upload session and discard all data uploaded.\n\nThis cannot be reversed." }, "response": [ { "id": "e53b653b-3505-4004-adf0-166c3c6d6312", "name": "A blank response is returned if the session was\nsuccessfully aborted.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e53b653b-3505-4004-adf0-166c3c6d6312" }, { "id": "e4591143-8571-4f78-86f1-40082fb1bbda", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions", ":upload_session_id" ], "variable": [ { "key": "upload_session_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e4591143-8571-4f78-86f1-40082fb1bbda" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-ea0ea53a-7dce-4ac2-829f-a4b153f5a233" } ], "id": "e35cd202-0ec5-4118-af54-b9608f9c2cfe", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e35cd202-0ec5-4118-af54-b9608f9c2cfe" }, { "name": "Box Create upload session", "id": "ce3a60ed-7569-4a9e-85b7-3f4d2b966455", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"\",\n \"file_size\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions" ] }, "description": "Creates an upload session for a new file." }, "response": [ { "id": "81ae2e4e-b792-49a9-8fb6-52b758b60949", "name": "Returns a new upload session.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"\",\n \"file_size\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"upload_session\",\n \"session_expires_at\": \"\",\n \"part_size\": \"\",\n \"total_parts\": \"\",\n \"num_parts_processed\": \"\",\n \"session_endpoints\": {\n \"upload_part\": \"\",\n \"commit\": \"\",\n \"abort\": \"\",\n \"list_parts\": \"\",\n \"status\": \"\",\n \"log_event\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-81ae2e4e-b792-49a9-8fb6-52b758b60949" }, { "id": "ae3c337a-6357-45bc-9f00-393cbfaa5d71", "name": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `missing_destination`: No `folder_id` was provided\n* `invalid_folder_id`: `folder_id` is not valid\n* `item_name_invalid`: `file_name` is not valid\n* `missing_file_size`: `file_size` w", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"\",\n \"file_size\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-ae3c337a-6357-45bc-9f00-393cbfaa5d71" }, { "id": "55770e38-51bf-411e-8ee6-74c192a169f9", "name": "Returns an error if the operation is not allowed for some reason.\n\n* `storage_limit_exceeded`: Account storage limit reached", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"\",\n \"file_size\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-55770e38-51bf-411e-8ee6-74c192a169f9" }, { "id": "034c43f9-3873-4057-87a2-f3ec344c9584", "name": "Returns an error if the parent folder could not be found, or\nthe authenticated user does not have access to it.\n\n* `invalid_parameter`: The `folder_id` value represents a\n folder that the user does not have access to, or does not\n exist.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"\",\n \"file_size\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-034c43f9-3873-4057-87a2-f3ec344c9584" }, { "id": "adf20fef-85c2-4fb7-9ca2-b39fb347736a", "name": "Returns an error if the file already exists,\nor the account has run out of disk space.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"\",\n \"file_size\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-adf20fef-85c2-4fb7-9ca2-b39fb347736a" }, { "id": "e422b284-8dbd-48b0-9fae-dfe3670d407a", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"\",\n \"file_size\": \"\",\n \"file_name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "https://upload.box.com/api/2.0/files/upload_sessions", "protocol": "https", "host": [ "upload", "box", "com" ], "path": [ "api", "2.0", "files", "upload_sessions" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e422b284-8dbd-48b0-9fae-dfe3670d407a" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-ce3a60ed-7569-4a9e-85b7-3f4d2b966455" } ], "id": "dce3c05f-b6c5-4dab-820a-d2359c96dd26", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-dce3c05f-b6c5-4dab-820a-d2359c96dd26" }, { "name": "{file_id}#get_shared_link", "item": [ { "name": "Box Get shared link for file", "id": "ec842add-9836-47e0-b7cd-81db593de587", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#get_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "get_shared_link" }, "description": "Gets the information for a shared link on a file." }, "response": [ { "id": "82172875-d3a0-4cb7-9883-ca7060d21a80", "name": "Returns the base representation of a file with the\nadditional shared link information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#get_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "get_shared_link" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"open\",\n \"effective_permission\": \"no_access\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopi\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_download\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"annotation_edit\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"previewer uploader\",\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"utb3\": {\n \"inc7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_preview\",\n \"can_download\"\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-82172875-d3a0-4cb7-9883-ca7060d21a80" }, { "id": "7de8afa8-4e96-4484-b14d-04166d311e5e", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#get_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "get_shared_link" } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-7de8afa8-4e96-4484-b14d-04166d311e5e" }, { "id": "6af98021-b3ab-42e6-a251-8971c0890e37", "name": "Returned if the file is not found, or the user does not\nhave access to the file.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#get_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "get_shared_link" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-6af98021-b3ab-42e6-a251-8971c0890e37" }, { "id": "f2fda758-66af-4dc1-82e3-29530d5d578f", "name": "Returned if the `file_id` is not in a recognized format.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#get_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "get_shared_link" } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-f2fda758-66af-4dc1-82e3-29530d5d578f" }, { "id": "f24cb9f4-fec9-4f4b-8062-325411e14b68", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#get_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "get_shared_link" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-f24cb9f4-fec9-4f4b-8062-325411e14b68" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-ec842add-9836-47e0-b7cd-81db593de587" } ], "id": "8a7070f9-1395-4841-b8c5-0f0d3f818640", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-8a7070f9-1395-4841-b8c5-0f0d3f818640" }, { "name": "{file_id}#add_shared_link", "item": [ { "name": "Box Add shared link to file", "id": "583a6e3b-9049-4701-85ab-948ba684ae07", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" }, "description": "Adds a shared link to a file." }, "response": [ { "id": "a32f6225-4ac4-41b9-8158-662c09d42d31", "name": "Returns the base representation of a file with a new shared\nlink attached.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"open\",\n \"effective_permission\": \"no_access\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopi\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_download\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"annotation_edit\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"previewer uploader\",\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"utb3\": {\n \"inc7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_preview\",\n \"can_download\"\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-a32f6225-4ac4-41b9-8158-662c09d42d31" }, { "id": "c709aa82-62f2-44e3-8ce9-bdd27756a117", "name": "Returned when there is an incorrect permission combination", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-c709aa82-62f2-44e3-8ce9-bdd27756a117" }, { "id": "cba447ba-4635-4757-88a0-dc58961136d7", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-cba447ba-4635-4757-88a0-dc58961136d7" }, { "id": "e46d8aa4-4cf5-414c-9b13-d502d83f5cc9", "name": "Returned if the user does not have all the permissions to complete the\nupdate.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-e46d8aa4-4cf5-414c-9b13-d502d83f5cc9" }, { "id": "295e060a-b74b-4056-9460-a5c4e650af9c", "name": "Returned if the file is not found, or the user does not\nhave access to the file.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-295e060a-b74b-4056-9460-a5c4e650af9c" }, { "id": "14cbb678-cd9c-4d17-806a-6d483b18af85", "name": "Returned if the `file_id` is not in a recognized format.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-14cbb678-cd9c-4d17-806a-6d483b18af85" }, { "id": "716ef47c-7858-49d1-bf17-30811eeea748", "name": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file. This indicates that the file\nhas changed since it was last requested.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-716ef47c-7858-49d1-bf17-30811eeea748" }, { "id": "74852113-ea11-43cd-9777-379fc5909ed2", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-74852113-ea11-43cd-9777-379fc5909ed2" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-583a6e3b-9049-4701-85ab-948ba684ae07" } ], "id": "68e2fd57-07f5-4d82-a3e2-9b6d03357318", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-68e2fd57-07f5-4d82-a3e2-9b6d03357318" }, { "name": "{file_id}#update_shared_link", "item": [ { "name": "Box Update shared link on file", "id": "b3e3afd1-572b-40fb-a7bf-dca093317cc6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" }, "description": "Updates a shared link on a file." }, "response": [ { "id": "2d7fe77d-7ae6-40ec-8d9f-4279ec8af566", "name": "Returns a basic representation of the file, with the updated shared\nlink attached.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"open\",\n \"effective_permission\": \"no_access\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopi\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_download\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"annotation_edit\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"previewer uploader\",\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"utb3\": {\n \"inc7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_preview\",\n \"can_download\"\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-2d7fe77d-7ae6-40ec-8d9f-4279ec8af566" }, { "id": "88cbee93-ee8d-44c2-98d4-e3fcf5da7fc8", "name": "Returned when there is an incorrect permission combination", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-88cbee93-ee8d-44c2-98d4-e3fcf5da7fc8" }, { "id": "60c49e86-56a1-404b-90ec-1ec8f9280391", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-60c49e86-56a1-404b-90ec-1ec8f9280391" }, { "id": "51b1447f-f85c-4959-b68e-fd231959a6fc", "name": "Returned if the user does not have all the permissions to complete the\nupdate.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-51b1447f-f85c-4959-b68e-fd231959a6fc" }, { "id": "314c6830-c244-47a0-9f0a-fe18a2c95f79", "name": "Returned if the file is not found, or the user does not\nhave access to the file.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-314c6830-c244-47a0-9f0a-fe18a2c95f79" }, { "id": "22856172-ddc9-4945-aca4-30009a2714e4", "name": "Returned if the `file_id` is not in a recognized format.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-22856172-ddc9-4945-aca4-30009a2714e4" }, { "id": "efd9d825-fc4a-4a1b-b065-ade699bb14d2", "name": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file. This indicates that the file\nhas changed since it was last requested.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-efd9d825-fc4a-4a1b-b065-ade699bb14d2" }, { "id": "6c24b508-fdd1-4f8d-b18c-aa9c725973f0", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-6c24b508-fdd1-4f8d-b18c-aa9c725973f0" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-b3e3afd1-572b-40fb-a7bf-dca093317cc6" } ], "id": "9e567762-bb30-4ac1-ab2d-4b1532942188", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-9e567762-bb30-4ac1-ab2d-4b1532942188" }, { "name": "{file_id}#remove_shared_link", "item": [ { "name": "Box Remove shared link from file", "id": "080870ac-0503-4639-ba8d-2f73f2013b46", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" }, "description": "Removes a shared link from a file." }, "response": [ { "id": "fd837838-dbd8-44aa-94d7-f61b556163d5", "name": "Returns a basic representation of a file, with the shared link removed.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"open\",\n \"effective_permission\": \"no_access\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopi\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_download\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"annotation_edit\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"previewer uploader\",\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"utb3\": {\n \"inc7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_preview\",\n \"can_download\"\n ]\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-fd837838-dbd8-44aa-94d7-f61b556163d5" }, { "id": "78528d1d-0220-41c8-ba3a-b4ba71889aa7", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-78528d1d-0220-41c8-ba3a-b4ba71889aa7" }, { "id": "1f7d3420-f38c-4ec3-bb41-967ae14216b3", "name": "Returned if the user does not have all the permissions to complete the\nupdate.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-1f7d3420-f38c-4ec3-bb41-967ae14216b3" }, { "id": "24a562d5-310f-4ea9-9f7a-29d517fc6104", "name": "Returned if the file is not found, or the user does not\nhave access to the file.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-24a562d5-310f-4ea9-9f7a-29d517fc6104" }, { "id": "7ed07192-f607-4b17-a552-cda813d9ef7b", "name": "Returned if the `file_id` is not in a recognized format.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-7ed07192-f607-4b17-a552-cda813d9ef7b" }, { "id": "0a8fd3ee-4ce7-47e5-bafc-038311e28c14", "name": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the file. This indicates that the file\nhas changed since it was last requested.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-0a8fd3ee-4ce7-47e5-bafc-038311e28c14" }, { "id": "1078ed37-7417-47fb-8c26-cf343271a772", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/{{file_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "files", "{{file_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"method_not_allowed\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-1078ed37-7417-47fb-8c26-cf343271a772" } ], "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-080870ac-0503-4639-ba8d-2f73f2013b46" } ], "id": "10c7e4a0-333e-4688-bd2b-93e2a57c2ac7", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-10c7e4a0-333e-4688-bd2b-93e2a57c2ac7" } ], "id": "bd772f75-be05-4cdc-9f37-e9db7ca1abb6", "createdAt": "2026-07-28T01:16:06.000Z", "updatedAt": "2026-07-28T01:16:06.000Z", "uid": "35240-bd772f75-be05-4cdc-9f37-e9db7ca1abb6" } ], "variable": [ { "key": "baseUrl", "value": "/" }, { "key": "extension", "value": "png" }, { "key": "file_id", "value": "" } ] }