Skip to main content
PATCH
/
api
/
v1
/
tasks
/
{id}
Update task
curl --request PATCH \
  --url http://localhost:3001/api/v1/tasks/{id} \
  --header 'Content-Type: application/json' \
  --cookie nut-session= \
  --data '
{
  "title": "<string>",
  "intent": "<string>",
  "content": "<string>",
  "status": "draft",
  "priority": "low",
  "readiness": 50,
  "tags": [
    "<string>"
  ]
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "title": "<string>",
    "status": "draft",
    "intent": "<string>",
    "content": "<string>",
    "priority": "low",
    "readiness": 50,
    "tags": [
      "<string>"
    ],
    "author": {
      "type": "user",
      "id": "<string>",
      "name": "<string>"
    },
    "reviewers": [
      "<string>"
    ],
    "planSteps": [
      {
        "id": "<string>",
        "description": "<string>",
        "status": "pending",
        "command": "<string>",
        "expectedOutcome": "<string>",
        "output": "<string>",
        "error": "<string>",
        "executedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "comments": [
      {
        "id": "<string>",
        "author": "<string>",
        "content": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "changes": [
      {
        "path": "<string>",
        "type": "create",
        "content": "<string>",
        "oldPath": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

nut-session
string
cookie
required

Session cookie authentication

Path Parameters

id
string
required

Task ID

Body

application/json
title
string

Task title/summary

intent
string
deprecated

Task title (deprecated, use 'title' instead)

content
string

Task content/body (markdown)

status
enum<string>

Task status

Available options:
draft,
backlog,
ready,
queued,
active,
blocked,
review,
revision,
done,
canceled,
duplicate
priority
enum<string>
Available options:
low,
medium,
high,
critical
readiness
integer

Readiness score (0-100)

Required range: 0 <= x <= 100
tags
string[]

Response

Task updated

success
boolean
required
data
object