Rename explorer folder

PATCH/api/v1/workspace-nodes/{nodeId}/rename

Renames an Explorer folder and updates descendant paths.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*nonEmptyString

a non empty string

Length1 <= length

Response Body

`application/json`

curl -X PATCH "https://loading/api/v1/workspace-nodes/{nodeId}/rename" \  -H "Content-Type: application/json" \  -d '{    "name": "Invoices Archive"  }'

{
  "id": "2f96de8b-74b2-4fc0-93af-528b4f8d4ba7",
  "name": "Customers",
  "owner": null,
  "updatedAt": "2026-03-10T18:00:00.000Z",
  "createdAt": "2026-03-08T18:00:00.000Z",
  "type": "Folder",
  "sizeBytes": null,
  "path": "Customers",
  "kind": "folder",
  "sourceId": null,
  "parentId": null,
  "href": null
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

{
  "code": "authentication_required",
  "message": "Authentication required. Send Authorization: Bearer <api-key>, x-api-key, or a signed-in session."
}

{
  "code": "insufficient_permissions",
  "message": "This API key does not have files.write permission.",
  "details": {
    "requiredPermission": "files.write"
  }
}

{
  "code": "not_found",
  "message": "The requested resource was not found."
}

{
  "code": "internal_error",
  "message": "An unexpected server error occurred."
}

Rename explorer folder

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`