Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

POST/projects/{project}/tasks

Create a task on a project

POSThttps://<your-url>/api/v2/projects/{project}/tasks

MCP id projects.tasks.storeAlso on this path: GET List a project's tasks

View as Markdown openapi.json

Creates a kanban task under one of the project's budgets and returns it with a Location header pointing at the flat item path.

Access

Token scope
api:write:kanban

Without it: 403 insufficient-token-scope.

Permission
kanban::manage_self

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

The project comes from the path, so project_id is not accepted in the body, and a task has no project_id of its own anyway: budget_id is the task's only link to a project, it is settable here and nowhere else, and a budget belonging to a different project is rejected as an unprocessable relationship. The task is always created for the authenticated user: user_id is not accepted, so creating a card on a colleague's board is not available through the API even to a holder of kanban::manage_for_others. Creating additionally requires projects::read for the parent project, plus budgets::read and a token satisfying api:read:budgets for the budget reference; a token created with api:write:kanban alone gets a permanent 422 on budget_id. A trashed project answers 404 with no escape.

Path parameters

projectintegerRequired

The Project'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

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.

budget_idinteger → Budget.idRequired

Budget the task is filed under. This is the task's only link to a project (a task has no project_id of its own), and it is settable at create time only; a task cannot be re-budgeted through the API.

due_datedate (YYYY-MM-DD)Required

Day the task is due. Required when creating a task through the API, and clearable afterwards; tasks created in plnnrly may carry null.

minutesinteger≥ 0Required

Estimated effort, in minutes.

descriptionstring≤ 255Required

Short description shown on the kanban card. This is the task's label and the only field ?q= searches.

commentstring or null≤ 255

Optional longer comment on the card, capped at 255 characters.

statusstring

Kanban column the card sits in.

on-hold
Paused, waiting on something off the board.
new
The default for a new card: not picked up yet.
active
Being worked on.
internal-test
Awaiting internal review or testing.
external-test
With the customer for acceptance.
finished
Done. The only status for which is_finished is true.

New values may be added.

is_finishedboolean

Whether the task is done. Cross-synced with status on every write: setting status to finished sets this true and any other status sets it false, while setting this false on a finished task moves status back to active. status wins when both are sent.

is_billableboolean

Whether time logged on this task is billable. Defaults to true when a task is created through the API, regardless of the budget's own setting.

Response 201

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

Errors

7 errors every operation can return: 400, 401, 404, 406, 429, 500, 503

This path allows GET, POST. Anything else answers 405.