Update a drive folder

PATCHhttps://<your-url>/api/v2/drive-folders/{drive_folder}

MCP id drive-folders.updateAlso on this path: GET Read a drive folder, DELETE Delete a drive folder

Partially updates a drive folder: absent keys are untouched, an empty body is rejected.

Token scope: api:write:project_driveorapi:write:customer_driveorapi:write:organization_driveorapi:write:user_drive
Without it: 403 insufficient-token-scope.
Permission: project_drive::create
Without it: 403 insufficient-permission.
Rate cost: 1 unit, write bucket. A write costs the same whatever view you ask for.
Also: Accepts If-Match. Never cached: private, no-store. Unknown body keys are refused, never dropped.

Both are checked, scope first. A token never does more than its user. How access is checked

Request

Example: Rename a folder and move it to the drive root

curl -X PATCH \
  'https://<your-url>/api/v2/drive-folders/1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: *' \
  -d '{
    "name": "Kick-off (archive)",
    "parent_id": null
  }'

const response = await fetch('https://<your-url>/api/v2/drive-folders/1', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'If-Match': '*',
  },
  body: JSON.stringify({
    "name": "Kick-off (archive)",
    "parent_id": null
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('If-Match', '*')
    ->patch('https://<your-url>/api/v2/drive-folders/1', [
        'name' => 'Kick-off (archive)',
        'parent_id' => null,
    ]);

import requests
response = requests.request(
    'PATCH',
    'https://<your-url>/api/v2/drive-folders/1',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'If-Match': '*'},
    json={'name': 'Kick-off (archive)', 'parent_id': None},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "name": "Kick-off (archive)",
    "parent_id": null,
    "parent_folder": null,
    "owner_type": "project",
    "owner_id": 1,
    "owner": {
      "id": 1
    },
    "order": 1,
    "created_by": 1,
    "inherits_permissions": false,
    "general_access": "everyone_edit",
    "access": "view"
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/precondition-failed",
  "title": "Precondition failed",
  "status": 412,
  "detail": "The record changed since the version named in If-Match. Re-read it and retry.",
  "instance": "/api/v2/work-items/812",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "current_version": 12
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "3 fields failed validation.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "errors": [
    {
      "pointer": "/date",
      "code": "date_format",
      "detail": "The date does not match the format Y-m-d."
    },
    {
      "pointer": "/minutes",
      "code": "min",
      "detail": "The minutes must be at least 1."
    },
    {
      "pointer": "/description",
      "code": "required",
      "detail": "The description field is required."
    }
  ]
}

4 more fields, listed under Response

name and parent_id are the writable keys: a rename, and a move to another folder within the same drive, which is plnnrly's folder drag-and-drop minus the position. The new parent must belong to the same owner, be a folder you can edit, and be neither this folder nor one of its descendants; null moves the folder to the drive root. Moving a folder to a different drive is not possible in v2.0: neither half of the owner pair is accepted on a PATCH, and neither are order, created_by, general_access or inherits_permissions. Send If-Match with the ETag from your last read to detect a concurrent edit, which answers 412. Treat it as best-effort only: this resource carries no concurrency token and updated_at is second-precision, so two writes inside the same second are indistinguishable. The declared permission is project_drive::create (editing is part of the create permission), and it is a superset of what is checked: the record rule needs the owner type's {owner}_drive::access plus edit access on the folder, which is exactly what plnnrly enforces.

Path parameters

drive_folderintegerRequired

The DriveFolder's numeric id.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

Request headers

X-Request-Idstringpattern

A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.

If-Matchstring

The ETag a write is conditional on. A stale validator is 412 precondition-failed.

Request body

Unknown keys are refused with 422, naming the key.

namestring≤ 255

Folder name as shown in the drive tree.

parent_idinteger or null → DriveFolder.id

Folder this one sits in, or null at the drive root.

Response 200

Returns a DriveFolder in the detail view.

Headers

ETag: A strong validator of exactly this representation.
RateLimit: The IETF httpapi-ratelimit-headers form of your remaining allowance on the tightest bucket this request touched.
RateLimit-Policy: The ceiling and window of that bucket, as <limit>;w=<seconds>.
X-Request-Id: The server-generated ULID correlating this response with our logs.

Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning

idinteger

Unique identifier.

namestring≤ 255

Folder name as shown in the drive tree.

parent_idinteger or null

Folder this one sits in, or null at the drive root.

parent_folderRef or DriveFolderSummary or null

The folder this one sits in; absent for folders at the drive root.

owner_typestring

The kind of record owner points at; it says which branch of owner applies.

projectcustomerorganizationuser

New values may be added.

owner_idinteger

The id of the record owner points at.

ownerRef or ProjectSummary or CustomerSummary or UserSummary

The project, customer, organisation or user whose drive this folder lives in. An organisation-owned folder renders as a bare {"id": N} reference.

Which form you get depends on owner_type.

project: ProjectSummary
customer: CustomerSummary
organization: Ref
user: UserSummary

orderintegerServer-assigned

Sort position within the drive and level, as shown in the drive tree. Positions count per drive and level, so the sequence is only meaningful once the collection is narrowed to one drive and one level. It is not assigned on create, so a folder created through the API stays at 0 until it is positioned in plnnrly; reordering is not exposed in v2.0.

created_byinteger or nullServer-assigned

Author; always the authenticated user at create time. Null on legacy rows and where the author has since been deleted.

inherits_permissionsboolean

Whether this folder takes its permissions from its parent.

general_accessstring

Baseline sharing tier, consulted only while inherits_permissions is false.

everyone_editeveryone_viewrestricted

New values may be added.

accessstring or null

The calling user's effective access level on this folder, after the permission for the owner type, the access inherited from folders and any per-folder grant.

viewedit

New values may be added.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

drive_items_countinteger≥ 0

Live drive items directly in this folder that the caller may see. Archived items are not counted, and neither are items in subfolders.

linksDriveFolderLinks

Show 2 child fields

links.selfurl

The canonical URI of this record.