Update a drive item

PATCHhttps://<your-url>/api/v2/drive-items/{drive_item}

MCP id drive-items.updateAlso on this path: GET Read a drive item, DELETE Archive a drive item

Partially updates a drive item: 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 an item and replace its tags

curl -X PATCH \
  'https://<your-url>/api/v2/drive-items/1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: *' \
  -d '{
    "title": "Kick-off notes (final)",
    "tag_ids": []
  }'

const response = await fetch('https://<your-url>/api/v2/drive-items/1', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'If-Match': '*',
  },
  body: JSON.stringify({
    "title": "Kick-off notes (final)",
    "tag_ids": []
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('If-Match', '*')
    ->patch('https://<your-url>/api/v2/drive-items/1', [
        'title' => 'Kick-off notes (final)',
        'tag_ids' => [],
    ]);

import requests
response = requests.request(
    'PATCH',
    'https://<your-url>/api/v2/drive-items/1',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'If-Match': '*'},
    json={'title': 'Kick-off notes (final)', 'tag_ids': []},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "title": "Kick-off notes (final)",
    "group": "…",
    "kind": "document",
    "source": "builtin",
    "folder_id": 1,
    "drive_folder": null,
    "owner_type": "project",
    "owner_id": 1,
    "owner": {
      "id": 1
    },
    "content_record_type": "drive_document",
    "content_record_id": 1
  }
}

{
  "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."
    }
  ]
}

15 more fields, listed under Response

title, group, folder_id and tag_ids are the writable keys; tag_ids replaces the whole tag set. Moving an item to another folder within the same drive is folder_id: the folder must belong to the same owner and be one you can edit. Moving an item to a different drive is not possible in v2.0: neither half of the owner pair is accepted on a PATCH, so plnnrly's move-between-drives action has no API equivalent. The body is not writable here either (PATCH /api/v2/drive-documents/{drive_document} is the one route that writes a document body), and neither are kind, source, order_column, the content_record pair, 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 item, which is exactly what plnnrly enforces.

Path parameters

drive_itemintegerRequired

The DriveItem's numeric id. Accepts a soft-deleted record.

Query parameters

Unknown parameters are refused with 400, naming the parameter.

viewstring

Which field set to render.

summarydetaildefault

trashedstring

Whether soft-deleted rows are included.

withoutdefaultwithonly

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.

titlestring≤ 255

Item title.

groupstring or null≤ 255

Free-text grouping label shown in the drive tree.

folder_idinteger or null → DriveFolder.id

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

tag_idsarray of integer → Tag.id≤ 50

Tags on this item. An item takes at most 50 tags, so the include lists them all. tag_ids replaces the whole set.

Response 200

Returns a DriveItem 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.

titlestring≤ 255

Item title.

groupstring or null≤ 255

Free-text grouping label shown in the drive tree.

kindstring

What this item is. Everything created through the API is a document; the other kinds come from uploads in plnnrly.

document
pdf
image
audio
video
office
other

New values may be added.

sourcestring

Where the item came from: builtin for an editor document, upload for a file uploaded in plnnrly.

builtinupload

New values may be added.

folder_idinteger or null

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

drive_folderRef or DriveFolderSummary or null

The folder this item sits in; absent for items 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 item lives in. An organisation-owned item renders as a bare {"id": N} reference.

Which form you get depends on owner_type.

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

content_record_typestring or null

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

drive_document

New values may be added.

content_record_idinteger or null

The id of the record content_record points at.

content_recordRef or null

The body this item points at: a drive document for an editor document, null for an item with no body yet. Renders as a bare {"id": N} reference; read the body from GET /api/v2/drive-documents/{drive_document}.

Which form you get depends on content_record_type.

drive_document: Ref

order_columnintegerServer-assigned

Sort position, assigned by the server. Positions count per drive and folder, so the sequence is only meaningful once the collection is narrowed to one drive and one folder. 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.

archived_byinteger or nullServer-assigned

The user who archived this item; set on delete and cleared on restore.

inherits_permissionsboolean

Whether this item takes its permissions from its folder.

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 item, after the permission for the owner type, the access inherited from folders and any per-item 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.

deleted_attimestamp (YYYY-MM-DDThh:mm:ssZ) or null

When this item was archived, or null while it is live.