Update a task

Updates one or more fields of an existing task. You can update the status, title, or description. At least one field must be provided. Valid status values are: pending, in_progress, done.

PATCH /tasks/{task_id}

Update a task

cURL

curl --request PATCH \
  --url https://test-writechoice.onrender.com/tasks/{task_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "in_progress",
  "title": "Write introduction and quickstart pages",
  "description": "Updated scope to include quickstart."
}
'

200

{
  "task_id": "f9e8d7c6-b5a4-3210-fedc-ba9876543210",
  "project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "title": "Write introduction page",
  "description": "Draft the overview and getting started sections.",
  "status": "in_progress",
  "created_at": "2025-05-12T10:35:00.000Z",
  "updated_at": "2025-05-12T11:00:00.000Z"
}

Authorizations

Authorization · string · header · required

All requests must include a valid API key in the Authorization header. Example: Authorization: Bearer tf-live-4a8f2c1e9b3d7e6a

Path Parameters

task_id · string<uuid> · required

The ID of the task to update.

Body

application/json

status · enum<string>

The new status for the task.

Available options: pending, in_progress, done

Example:

"in_progress"

title · string

A new title for the task.

Example:

"Write introduction and quickstart pages"

description · string

A new description for the task.

Example:

"Updated scope to include quickstart."

Response

200

application/json

Task updated successfully.

task_id · string<uuid>

Unique identifier for the task. Generated automatically.

Example:

"f9e8d7c6-b5a4-3210-fedc-ba9876543210"

project_id · string<uuid>

The ID of the project this task belongs to.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

title · string

The title of the task.

Example:

"Write introduction page"

description · string | null

An optional description of the task.

Example:

"Draft the overview and getting started sections."

status · enum<string>

The current status of the task. - pending: The task has not been started. - in_progress: The task is actively being worked on. - done: The task has been completed.

Available options: pending, in_progress, done

Example:

"pending"

created_at · string<date-time>

Timestamp of when the task was created.

Example:

"2025-05-12T10:35:00.000Z"

updated_at · string<date-time>

Timestamp of the last update to the task.

Example:

"2025-05-12T11:00:00.000Z"