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/work-items/{work_item}/subtasks

Add a subtask to a work item

POSThttps://<your-url>/api/v2/work-items/{work_item}/subtasks

MCP id work-items.subtasks.storeAlso on this path: GET List a work item's subtasks

View as Markdown openapi.json

Creates one checklist subtask on the work item named in the path and returns it in the detail view, with a Location header pointing at the flat item path.

Access

Token scope
api:write:project_management

Without it: 403 insufficient-token-scope.

Permission
project_management::manage_work_items

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 work item comes from the path, so work_item_id is not accepted in the body and a subtask can never be moved between work items. The new subtask is appended to the end of that work item's checklist; order is not accepted, and reordering is not available through the API. There is no batch create: post one subtask per request.

Path parameters

work_iteminteger or stringRequired

The WorkItem's numeric id. Or its issue_key, matching [A-Z][A-Z0-9]*-[0-9]+.

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.

titlestring≤ 255Required

Subtask title, as shown on the checklist row. This is the field ?q= searches.

descriptionstring or null

Optional note on the subtask. HTML from the rich editor, sanitised on read and on write. Null when the subtask is just a title.

is_resolvedboolean

Whether the subtask is ticked off.

Response 201

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