Create a drive folder

POSThttps://<your-url>/api/v2/drive-folders

MCP id drive-folders.storeAlso on this path: GET List drive folders

Creates a folder under a project, a customer, the organisation drive or the caller's own drive (plnnrly's create-folder and create-subfolder actions) and returns it with a Location header.

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 Idempotency-Key. 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: A folder at a project's drive root

curl -X POST \
  'https://<your-url>/api/v2/drive-folders' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <key>' \
  -d '{
    "owner_type": "project",
    "owner_id": 1,
    "name": "Kick-off"
  }'

const response = await fetch('https://<your-url>/api/v2/drive-folders', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Idempotency-Key': '<key>',
  },
  body: JSON.stringify({
    "owner_type": "project",
    "owner_id": 1,
    "name": "Kick-off"
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('Idempotency-Key', '<key>')
    ->post('https://<your-url>/api/v2/drive-folders', [
        'owner_type' => 'project',
        'owner_id' => 1,
        'name' => 'Kick-off',
    ]);

import requests
response = requests.request(
    'POST',
    'https://<your-url>/api/v2/drive-folders',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'Idempotency-Key': '<key>'},
    json={'owner_type': 'project', 'owner_id': 1, 'name': 'Kick-off'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "name": "Kick-off",
    "parent_id": 1,
    "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/state-conflict",
  "title": "State conflict",
  "status": 409,
  "detail": "The target status is not reachable from this work item's current status.",
  "instance": "/api/v2/work-items/812/actions/transition",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S",
  "conflict": {
    "reason": "illegal_transition",
    "from_workflow_status_id": 3,
    "to_workflow_status_id": 9
  }
}

{
  "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

The drive is named by the owner_type/owner_id pair, this being one of the few flat creates that accepts a type and id pair, and a record the caller cannot read is refused exactly as a nonexistent one is. For owner_type=organization there is no owner_id to send: it is always your own organisation. A parent_id must belong to the same owner and be a folder you can edit; omit it, or send null, to create at the drive root. The new folder inherits its parent's permissions, and its sort position stays 0 until it is placed in plnnrly. The declared permission is project_drive::create; the other three drive prefixes apply by owner type, and the record rule is what actually decides.

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.

Idempotency-Keystring≤ 255

A caller-chosen key that makes this POST safe to retry. Replaying it returns the original response with Idempotency-Replayed: true.

Request body

Unknown keys are refused with 422, naming the key.

owner_typestringRequired

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

projectcustomerorganizationuser

owner_idintegerRequired

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

namestring≤ 255Required

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 201

Returns a DriveFolder in the detail view.

Headers

ETag: A strong validator of exactly this representation.
Idempotency-Replayed: true when this response was replayed from a stored Idempotency-Key rather than produced by a new write.
Location: The absolute URL of the created or queued resource.
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.