{ "info": { "_postman_id": "6f0345da-56ac-4c7c-aeff-ee6d8f24df48", "name": "Box Authorize Authorization Metadata Instances (Files) API", "description": "Needs a description.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:16:42.000Z", "updatedAt": "2026-07-28T01:16:42.000Z", "lastUpdatedBy": "35240", "uid": "35240-6f0345da-56ac-4c7c-aeff-ee6d8f24df48" }, "item": [ { "name": "files", "item": [ { "name": "{file_id}", "item": [ { "name": "metadata", "item": [ { "name": "{scope}", "item": [ { "name": "{template_key}", "item": [ { "name": "Box Get metadata instance on file", "id": "bd10c559-cb88-42c1-b9b4-3359f65c135e", "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": "20f1bdc9-e0ab-4ec1-821b-8cf75cea4f1e", "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": "56ba2c8e-110e-4789-9722-f5c1ce928568", "key": "scope", "value": "enterprise", "description": "(Required) The scope of the metadata template" }, { "id": "f8d4aa66-2e03-4b37-9d8c-a6bdfac25235", "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": "ce6b0c43-ec0d-41fa-992f-87092805c03a", "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:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-ce6b0c43-ec0d-41fa-992f-87092805c03a" }, { "id": "a6d28051-27dc-4863-91bc-c424a8766413", "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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-a6d28051-27dc-4863-91bc-c424a8766413" }, { "id": "ca63fa2b-f885-47ba-9475-f9b6ff3ccb35", "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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-ca63fa2b-f885-47ba-9475-f9b6ff3ccb35" }, { "id": "e8779f21-000a-46eb-bd48-b0d073e3face", "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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-e8779f21-000a-46eb-bd48-b0d073e3face" }, { "id": "4e43162b-1bd7-4a46-a6a1-cb7f9cf36ff8", "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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-4e43162b-1bd7-4a46-a6a1-cb7f9cf36ff8" } ], "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-bd10c559-cb88-42c1-b9b4-3359f65c135e" }, { "name": "Box Create metadata instance on file", "id": "8ff8e729-3e21-4808-b6b0-e266762f5dd5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"commodo_8\": {\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 \"labore_1__\": {\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": "1eb852e4-ab93-4a56-ac87-461848ff3a22", "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": "c5fdb861-58d9-4edb-868f-99d9cdc1db1f", "key": "scope", "value": "enterprise", "description": "(Required) The scope of the metadata template" }, { "id": "99f8b973-5704-4f71-9351-52db8b6c69ee", "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": "5e96dc23-cc9c-4283-bd22-67bf051d8628", "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 \"commodo_8\": {\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 \"labore_1__\": {\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:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-5e96dc23-cc9c-4283-bd22-67bf051d8628" }, { "id": "33d749b2-f154-4359-84de-447d22d0b6f9", "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 \"commodo_8\": {\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 \"labore_1__\": {\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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-33d749b2-f154-4359-84de-447d22d0b6f9" }, { "id": "96115c71-f528-4caa-ae4f-7a4e43d94b32", "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 \"commodo_8\": {\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 \"labore_1__\": {\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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-96115c71-f528-4caa-ae4f-7a4e43d94b32" }, { "id": "3cdc1c8d-4f29-4b1d-8981-8c0138e2ff69", "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 \"commodo_8\": {\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 \"labore_1__\": {\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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-3cdc1c8d-4f29-4b1d-8981-8c0138e2ff69" }, { "id": "7dac9e31-1bee-4e05-8923-4a7e342c5c63", "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 \"commodo_8\": {\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 \"labore_1__\": {\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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-7dac9e31-1bee-4e05-8923-4a7e342c5c63" } ], "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-8ff8e729-3e21-4808-b6b0-e266762f5dd5" }, { "name": "Box Update metadata instance on file", "id": "711cd920-f3f1-4a8f-8e29-b67f542a3d54", "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\": \"copy\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"test\",\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": "a439f01b-e785-41bc-8855-878e7b024e38", "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": "4c973434-4e93-4158-bdb3-bc5946e5d181", "key": "scope", "value": "enterprise", "description": "(Required) The scope of the metadata template" }, { "id": "99e4d222-00ef-4420-9bc5-1a6cff2d8aaf", "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": "19f3ab8e-6cd8-4944-a2d0-2f52b92a752f", "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\": \"copy\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"test\",\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:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-19f3ab8e-6cd8-4944-a2d0-2f52b92a752f" }, { "id": "865c7b2f-39dd-4ecd-a71e-fdfb2bdbe584", "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\": \"copy\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"test\",\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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-865c7b2f-39dd-4ecd-a71e-fdfb2bdbe584" }, { "id": "5f7ab46a-1af6-4dae-97e9-06997ff15f38", "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\": \"copy\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"test\",\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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-5f7ab46a-1af6-4dae-97e9-06997ff15f38" }, { "id": "b8eea97a-e8bc-4f82-ab6d-3853e47bc1e7", "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\": \"copy\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"test\",\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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-b8eea97a-e8bc-4f82-ab6d-3853e47bc1e7" } ], "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-711cd920-f3f1-4a8f-8e29-b67f542a3d54" }, { "name": "Box Remove metadata instance from file", "id": "25db16c6-62f7-406d-aae0-bf774f642c1b", "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": "da4126ec-1719-49d7-9917-4385e3824ba3", "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": "7f9dd4fc-23d1-4352-a586-d84739c35ba9", "key": "scope", "value": "enterprise", "description": "(Required) The scope of the metadata template" }, { "id": "e4b090e2-8ad1-4f88-b76d-5436bc1935b4", "key": "template_key", "value": "", "description": "(Required) The name of the metadata template" } ] }, "description": "Deletes a piece of file metadata." }, "response": [ { "id": "2c50e5f3-3fe4-43e6-b327-934e2dac2253", "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:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-2c50e5f3-3fe4-43e6-b327-934e2dac2253" }, { "id": "e595d07b-e0ca-4500-bdb6-0bca196be645", "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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-e595d07b-e0ca-4500-bdb6-0bca196be645" }, { "id": "712f9760-668a-49a0-aa4c-b751cd4b3215", "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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-712f9760-668a-49a0-aa4c-b751cd4b3215" }, { "id": "456577ea-4261-43bd-9add-4a5286ba4b8b", "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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-456577ea-4261-43bd-9add-4a5286ba4b8b" }, { "id": "7aa84367-1ae2-4faa-a0be-48e81e74e32f", "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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-7aa84367-1ae2-4faa-a0be-48e81e74e32f" } ], "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-25db16c6-62f7-406d-aae0-bf774f642c1b" } ], "id": "ae8e8d20-0e01-4cf6-a4d7-07dbe1a922e7", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-ae8e8d20-0e01-4cf6-a4d7-07dbe1a922e7" } ], "id": "daac2fb4-2b0d-4682-aa2c-a65c6c7894aa", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-daac2fb4-2b0d-4682-aa2c-a65c6c7894aa" }, { "name": "Box List metadata instances on file", "id": "ba96481d-f9c9-4039-8df6-2d07ecf6b331", "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": "629152de-89b9-4f24-a36e-cf3275be1015", "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": "a10e3a32-57e4-4f30-9008-0115b433bc51", "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:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-a10e3a32-57e4-4f30-9008-0115b433bc51" }, { "id": "a86c8ac9-abf4-4a34-b338-8c73f138585b", "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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-a86c8ac9-abf4-4a34-b338-8c73f138585b" }, { "id": "202352f6-718a-4dae-9a8f-ec671f244ba4", "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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-202352f6-718a-4dae-9a8f-ec671f244ba4" }, { "id": "784662f8-2eae-4e7d-9bb8-c7984e8751a5", "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\": \"insufficient_scope\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-784662f8-2eae-4e7d-9bb8-c7984e8751a5" } ], "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-ba96481d-f9c9-4039-8df6-2d07ecf6b331" } ], "id": "c6fd15cc-d381-49a6-8bfe-e5e97af4b1c1", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-c6fd15cc-d381-49a6-8bfe-e5e97af4b1c1" } ], "id": "bf27f503-3c56-4919-991e-9eec5f304c70", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-bf27f503-3c56-4919-991e-9eec5f304c70" } ], "id": "0f918f84-a4dc-480e-92fa-64f3298f9fd3", "createdAt": "2026-07-28T01:16:43.000Z", "updatedAt": "2026-07-28T01:16:43.000Z", "uid": "35240-0f918f84-a4dc-480e-92fa-64f3298f9fd3" } ], "variable": [ { "key": "baseUrl", "value": "/" } ] }