Create a note

POSThttps://<your-url>/api/v2/notes

MCP id notes.storeAlso on this path: GET List notes

Attaches a note to a project, a customer or a work item and returns it with a Location header, mirroring the Notes sub-page in plnnrly.

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 note on a project

curl -X POST \
  'https://<your-url>/api/v2/notes' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <key>' \
  -d '{
    "notable_type": "project",
    "notable_id": 1,
    "content": "<p>Kick-off moved to Monday; the client will confirm scope by Friday.</p>"
  }'

const response = await fetch('https://<your-url>/api/v2/notes', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Idempotency-Key': '<key>',
  },
  body: JSON.stringify({
    "notable_type": "project",
    "notable_id": 1,
    "content": "<p>Kick-off moved to Monday; the client will confirm scope by Friday.</p>"
  }),
});

use Illuminate\Support\Facades\Http;

$response = Http::withToken('<token>')
    ->acceptJson()
    ->withHeader('Idempotency-Key', '<key>')
    ->post('https://<your-url>/api/v2/notes', [
        'notable_type' => 'project',
        'notable_id' => 1,
        'content' => '<p>Kick-off moved to Monday; the client will confirm scope by Friday.</p>',
    ]);

import requests
response = requests.request(
    'POST',
    'https://<your-url>/api/v2/notes',
    headers={'Authorization': 'Bearer <token>', 'Accept': 'application/json', 'Content-Type': 'application/json', 'Idempotency-Key': '<key>'},
    json={'notable_type': 'project', 'notable_id': 1, 'content': '<p>Kick-off moved to Monday; the client will confirm scope by Friday.</p>'},
)

Response

The shape of the response, with sample values.

{
  "data": {
    "id": 1,
    "content": "<p>Kick-off moved to Monday; the client will confirm scope by Friday.</p>",
    "order_column": 1,
    "user_id": 1,
    "created_at": "2026-03-04T09:15:00Z",
    "updated_at": "2026-03-04T09:15:00Z",
    "notable_type": "project",
    "notable_id": 1,
    "notable": {
      "id": 1
    },
    "user": null,
    "links": {
      "self": "https://<your-url>/api/v2/work-items/1"
    }
  }
}

{
  "type": "https://developers.plnnrly.com/api/v2/problems/idempotency-key-in-flight",
  "title": "Idempotency key in flight",
  "status": 409,
  "detail": "The original request for this Idempotency-Key is still being processed. Retry shortly.",
  "instance": "/api/v2/worklogs",
  "request_id": "01K4B7Q9YV3PZ2N8T1E6M0XR4S"
}

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

The parent is named by the notable_type/notable_id pair (one of the few flat creates that accepts a type and id pair), and a parent the caller cannot read is refused exactly as a nonexistent one is. Writing a note also needs the parent's own note permission, as in plnnrly: projects::notes for a project, customers::update for a customer and project_management::manage_work_items for a work item; without it the request is 403 forbidden-by-policy. The author is always the authenticated user and cannot be set; the sort position is assigned by the server. The declared permission is project_drive::create; the other three drive prefixes apply by owner type.

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.

contentstring≤ 500000Required

Note body as rich-text HTML, sanitised on read.

notable_typestringRequired

The project, customer or work item this note is attached to.

projectcustomerwork_item

notable_idintegerRequired

The project, customer or work item this note is attached to.

Response 201

Returns a Note 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