PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List labels in a project GETList roles that can be assigned in a project GETList tasks in a project GETCreate a task POSTGet a task GETUpdate a task PATCHDelete a task DELETE
Tasks

Update a task

All fields are applied in one write with one `version` bump. Moving the task to a Done status sets `completedAt` and schedules auto-archive (an archived task then answers 404); moving it out clears `completedAt`. A status change puts the task at the end of the new column. A status at its blocking WIP limit answers 409. Send `expectedVersion` to reject the write with 409 when someone else changed the task first; omit it and the last write wins.

PATCH
/tasks/{taskId}

All fields are applied in one write with one version bump. Moving the task to a Done status sets completedAt and schedules auto-archive (an archived task then answers 404); moving it out clears completedAt. A status change puts the task at the end of the new column. A status at its blocking WIP limit answers 409. Send expectedVersion to reject the write with 409 when someone else changed the task first; omit it and the last write wins.

Authorization

x-api-key<token>

In: header

Path Parameters

taskId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/tasks/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "string",    "workspaceId": "string",    "projectId": "string",    "title": "string",    "description": "string",    "descriptionContent": [      {}    ],    "statusId": "string",    "parentId": "string",    "priority": "NO_PRIORITY",    "startDate": "2019-08-24T14:15:22Z",    "dueDate": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "version": 0,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "assignees": [      {        "membershipId": "string",        "displayName": "string",        "image": "string"      }    ],    "assigneeRoles": [      {        "roleId": "string",        "name": "string"      }    ],    "label": {      "id": "string",      "name": "string",      "color": "string",      "icon": "string",      "description": "string"    }  }}

Get a task GET

Previous Page

Delete a task DELETE

Next Page

title?string
Length1 <= length <= 500
description?string

Plain text used only when descriptionContent is omitted. Converted into paragraph nodes. Ignored when descriptionContent is sent.

descriptionContent?array<>

Plate JSON task RTE document (array of nodes). Canonical store. Allowed types, URL rules, and size limits are documented at /docs/task-content. Unknown types and unsafe URLs are rejected.

statusId?string
priority?string

Value in

  • "NO_PRIORITY"
  • "LOW"
  • "MEDIUM"
  • "HIGH"
  • "URGENT"
startDate?string
Formatdate-time
dueDate?string
Formatdate-time
assigneeMembershipIds?array<string>
Itemsitems <= 100
assigneeRoleIds?array<string>

Workspace role ids from GET /projects/{projectId}/roles. A role must have Manage any project, or Editor or Project manager access to the project; otherwise the request fails with "One or more assignee roles are invalid." On update, the list replaces the current roles only when present.

Itemsitems <= 100
labelId?string

Project label id from GET /projects/{projectId}/labels. A task has at most one label. Null clears the label on update.

parentId?string

Makes this task a subtask. The parent must be a top-level task in the same project; subtasks are one level deep, so a task that has subtasks cannot become one. On update, a new id moves the task to that parent and null unlinks it.

expectedVersion?integer

The task version you last read. When the task has changed since, the update is rejected with 409 Task was modified by someone else. Refresh and retry. Omit it and the last write wins.

Range1 <= value