# Update a task

> Changes only the fields you send. Move a task along the board with workflow_status; complete it with "done".

Source: https://docs.xplantpro.com/docs/api/tasks/update-task

`PATCH https://app.xplantpro.com/api/v1/tasks/{id}`

- Required scope: `write:tasks`
- Credentials: workspace API key (`xpk_`)
- Idempotency-Key: ignored on this endpoint

A task someone placed by hand keeps its position through automated writes. Send `release: true` to hand it back to automatic ordering. Send `clear_entity_link: true` to unlink it from its plant or explant.

See also: [Sync tasks](https://docs.xplantpro.com/docs/guides/sync-tasks.md).

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string (uuid) | Yes | The record's id. |

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `title` | string | No | 1–300 characters. |
| `due_date` | string (date-time) | No | — |
| `is_all_day` | boolean | No | — |
| `category` | `"media_prep"` \| `"transfer"` \| `"contamination"` \| `"subculture"` \| `"sop_review"` \| `"acclimation"` \| `"cleaning"` \| `"monitoring"` \| `"other"` | No | — |
| `notes` | string | No | Up to 5000 characters. |
| `priority` | `"low"` \| `"medium"` \| `"high"` \| `"urgent"` | No | — |
| `priority_rank` | number \| null | No | — |
| `release` | boolean | No | — |
| `workflow_status` | `"backlog"` \| `"todo"` \| `"in_progress"` \| `"waiting_blocked"` \| `"review"` \| `"done"` | No | — |
| `assigned_to` | string (uuid) | No | — |
| `genus` | string \| null | No | 1–100 characters. |
| `entity_type` | `"plant"` \| `"explant"` | No | — |
| `entity_id` | string (uuid) | No | — |
| `clear_entity_link` | boolean | No | — |

## Example

**curl**

```bash
curl -X PATCH https://app.xplantpro.com/api/v1/tasks/4e9a1c7b-2d3f-4b5a-9c8d-6e7f8a9b0c1d \
  -H "Authorization: Bearer $XPLANT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_status": "done"
  }'
```

**JavaScript**

```js
import { XPlantClient } from "@shmaplex/xplant-sdk";

const client = new XPlantClient({ apiKey: process.env.XPLANT_API_KEY });

const { task, skipped } = await client.tasks.update(
  "4e9a1c7b-2d3f-4b5a-9c8d-6e7f8a9b0c1d",
  { workflow_status: "done" },
);
if (skipped) {
  // Someone ordered this task by hand; the ordering change was left out.
}
```

**Python**

```python
import os
import requests

resp = requests.patch(
    "https://app.xplantpro.com/api/v1/tasks/4e9a1c7b-2d3f-4b5a-9c8d-6e7f8a9b0c1d",
    headers={"Authorization": f"Bearer {os.environ['XPLANT_API_KEY']}"},
    json={"workflow_status": "done"},
    timeout=10,
)
body = resp.json()
if not body["ok"]:
    raise RuntimeError(f"{resp.status_code} {body['code']}: {body['error']}")
result = body["data"]
```

## Response

`200` with `{ "ok": true, "data": … }`. `data` holds the result.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string (uuid) | Yes | — |
| `title` | string | Yes | — |
| `status` | string | Yes | Board column: `backlog`, `todo`, `in_progress`, `waiting_blocked`, `review`, `done`. |
| `due_date` | string \| null | Yes | ISO 8601 timestamp. |
| `assigned_to` | string \| null | Yes | User id of the workspace member the task is assigned to. |
| `priority` | string \| null | Yes | — |
| `priority_rank` | number \| null | Yes | Queue position. Lower sorts first; null means the priority label decides. |
| `priority_source` | string | Yes | Where the current order came from: `default`, `auto`, `manual`. `manual` means a person placed the task, and automated writes leave it where it is unless they send `release: true`. |
| `category` | string \| null | Yes | — |
| `created_at` | string \| null | Yes | — |
| `entity_link` | object \| null | No | The plant or explant the task is about. Returned when you create, fetch or update one task; lists leave it out. |
| `entity_link.entity_type` | `"plant"` \| `"explant"` | Yes | — |
| `entity_link.entity_id` | string (uuid) | Yes | — |

```json title="Response"
{
  "ok": true,
  "data": {
    "id": "5b0f6f3e-2c1a-4d8e-9f47-0a6c3e1b7d22",
    "title": "Transfer the Alocasia line onto fresh medium",
    "status": "done",
    "due_date": "2026-10-02T09:00:00.000Z",
    "assigned_to": "0d7e4b9a-6f21-4c3e-8a5b-2e9f1c7d4a60",
    "priority": "high",
    "priority_rank": 1.5,
    "priority_source": "auto",
    "category": "transfer",
    "created_at": "2026-09-25T14:12:03.000Z",
    "entity_link": null
  }
}
```

The envelope can also carry `meta`:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `priority_write` | object | Yes | Sent when the update asked to change the task's order: whether it was applied, and why not if it was declined. Left out otherwise. |
| `priority_write.applied` | boolean | Yes | Whether the requested ordering change was written. |
| `priority_write.reason` | `"manual_override"` | No | Present only when the change was declined. |
| `priority_write.priority_source` | `"default"` \| `"auto"` \| `"manual"` | Yes | Where the order stands now. |
| `priority_write.message` | string | Yes | A plain-language explanation, safe to show in a sync log. |

| Response header | Meaning |
| --- | --- |
| `X-Request-Id` | Identifies this request. Include it when you contact support. |

## Errors

| Status | Code | When |
| --- | --- | --- |
| `400` | `VALIDATION_ERROR` | The request body is not valid JSON. |
| `401` | `UNAUTHORIZED` | The key is missing, malformed or revoked, or its owner is no longer a member of the workspace. |
| `402` | `PAID_PLAN_REQUIRED` | The workspace's plan does not include the API. The full API is included with xPlant+ Teams and Enterprise; on Hobby and Pro Lab, keys can connect devices only. |
| `403` | `FORBIDDEN` | The key lacks a scope this operation requires, or its owner's current role in the workspace cannot use it — a key never does more than its owner can in xPlant. `error` names the scope, and for a role, the role it needs. |
| `403` | `DEVICE_TOKEN_NOT_ACCEPTED` | A device token was sent; this operation needs a workspace API key. |
| `404` | `NOT_FOUND` | No task with this id exists in the key's workspace, or `id` is not a well-formed id. |
| `422` | `VALIDATION_ERROR` | A field failed validation. `error` names the first one, for example `title: title is required`. |
| `422` | `VALIDATION_ERROR` | `assigned_to` is not an active member of the workspace, or the linked plant or explant is not in it. |
| `429` | `RATE_LIMIT_EXCEEDED` | Too many requests for this key, device token or workspace. Wait `Retry-After` seconds. |
| `500` | `TASK_UPDATE_FAILED` | The change could not be saved. Retry later. |

Branch on `code`, never on the `error` text. See [Errors](https://docs.xplantpro.com/docs/errors.md).