Update metadata on an item

Updating the metadata applied to a file or folder can be done by using the item’s id, the template’s templateKey and scope, and a set of JSON operations to manipulate the data on the template instance.

Update metadata on a file

To update the metadata to a file, call the PUT /files/:file_id/metadata/:scope/:templateKey API endpoint with the file’s file_id, the template’s scope and templateKey, set of JSON operations to manipulate the data on the template instance.

curl -i -X PUT "https://api.box.com/2.0/files/12345/metadata/enterprise_27335/blueprintTemplate" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json-patch+json" \
     -d '[
        {
          "op": "test",
          "path": "/competitiveDocument",
          "value": "no"
        },
        {
          "op": "remove",
          "path": "/competitiveDocument"
        },
        {
          "op": "test",
          "path": "/status",
          "value": "active"
        },
        {
          "op": "replace",
          "path": "/status",
          "value": "inactive"
        },
        {
          "op": "test",
          "path": "/author",
          "value": "Jones"
        },
        {
          "op": "copy",
          "from": "/author",
          "path": "/editor"
        },
        {
          "op": "test",
          "path": "/currentState",
          "value": "proposal"
        },
        {
          "op": "move",
          "from": "/currentState",
          "path": "/previousState"
        },
        {
          "op": "add",
          "path": "/currentState",
          "value": "reviewed"
        }
      ]'

The authenticated user needs to have write access on the file to be able to write changes to the metadata on a file.

Update metadata on a folder

To update the metadata to a folder, call the PUT /folders/:folder_id/metadata/:scope/:templateKey API endpoint with the folder’s folder_id, the template’s scope and templateKey, set of JSON operations to manipulate the data on the template instance.

curl -i -X PUT "https://api.box.com/2.0/folders/4353455/metadata/enterprise_27335/blueprintTemplate" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json-patch+json" \
     -d '[
        {
          "op": "test",
          "path": "/competitiveDocument",
          "value": "no"
        },
        {
          "op": "remove",
          "path": "/competitiveDocument"
        },
        {
          "op": "test",
          "path": "/status",
          "value": "active"
        },
        {
          "op": "replace",
          "path": "/status",
          "value": "inactive"
        },
        {
          "op": "test",
          "path": "/author",
          "value": "Jones"
        },
        {
          "op": "copy",
          "from": "/author",
          "path": "/editor"
        },
        {
          "op": "test",
          "path": "/currentState",
          "value": "proposal"
        },
        {
          "op": "move",
          "from": "/currentState",
          "path": "/previousState"
        },
        {
          "op": "add",
          "path": "/currentState",
          "value": "reviewed"
        }
      ]'

The authenticated user needs to have write access on the file to be able to write changes to the metadata on a file.

JSON Operations

Updating an piece of metadata follow the JSON-Patch specification, which is represented as a list of operation objects. For metadata instances, these operations can be either add, replace, remove , test, move, or copy. Every operation exists out of an op name, the JSON Pointer path that points to the field to changes, and an optional value or from value depending on the operation being made.

[
  { "op": "test", "path": "/competitiveDocument", "value": "no" },
  { "op": "remove", "path": "/competitiveDocument" },
  { "op": "test", "path": "/status", "value": "active" },
  { "op": "replace", "path": "/status", "value": "inactive" },
  { "op": "test", "path": "/author", "value": "Jones" },
  { "op": "copy", "from": "/author", "path": "/editor" },
  { "op": "move", "from": "/currentState", "path": "/previousState" },
  { "op": "add", "path": "/currentState", "value": "reviewed" }
]

When editing metadata, only values that adhere to the metadata template schema will be accepted. The update is applied completely or not at all. If any errors occur during the application of the update operations, the metadata instance is not changed.The template instance can only be updated if the template has already been assigned to the file or folder.

Add a new value

To add a new value on a template, use the add operation.

[
  {
    "op": "add",
    "path": "/name",
    "value": "Model 3"
  }
]

This will add the name field with a value of Model 3 . Before this operation, the template did not have a value for the name field.

{
  // "name": null, // old value
  "name": "Model 3", // new value
  "category": "SUVs",
  "$type": "productInfo-8120731a-41e4-11ea-b77f-2e728ce88125",
  "$parent": "folder_3456",
  "$id": "22ba8c96-41e6-11ea-b77f-2e728ce88125",
  "$version": 3,
  "$typeVersion": 0,
  "$template": "productInfo",
  "$scope": "enterprise_1234567",
  "$canEdit": true
}