Update a Vault document

Renames, re-tags, moves or rewrites an item. A system folder cannot be renamed — both the console and the code that keeps those folders in sync look them up by name.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

vault:admin

Path Parameters

Name	Type	Required	Description
`documentId`	string	Required	Document ID.

Request Body

Property	Type	Required	Description
`name`	string	Optional
`content`	string	Optional
`description`	string	Optional
`parentId`	string	Optional	Move it. Send null to put it at the Vault root.
`tags`	array	Optional	Replaces the whole set.

PATCHExample request

curl

curl -X PATCH "https://www.pxb.app/api/public/v1/vault-documents/{documentId}" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Q3 board pack (final).pdf",
    "tags": [
      "board",
      "final"
    ]
  }'

200Example response

json

{
  "message": "Vault document updated successfully!",
  "content": {
    "document": {
      "id": "vdoc_4410",
      "referenceId": 318,
      "name": "Q3 board pack.pdf",
      "type": "FILE",
      "parentId": "vdoc_0001",
      "description": null,
      "fileSize": 2418123,
      "mimeType": "application/pdf",
      "tags": [
        "board"
      ],
      "isSystem": false,
      "systemType": null,
      "createdById": "emp_12ab",
      "updatedById": null,
      "createdAt": "2026-08-12T11:00:00.000Z",
      "updatedAt": "2026-08-12T11:00:00.000Z",
      "archivedAt": null
    }
  }
}

400Example response

json

{
  "message": "System folders cannot be renamed."
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Vault

/vault

Open an item and edit it.