---
title: "Update a task"
method: POST
path: "/v1/tasks/{id}"
---

# Update a task

`POST /v1/tasks/{id}`

Updates an existing task by ID. Only included fields and relationships are modified.

The `$note` relationship is read-only — manage notes via their own relationships.

Supports idempotency via the `Idempotency-Key` header.

**[Required scope](/using-the-api/scopes/):** `tasks:update`

**[Rate limit category](/using-the-api/rate-limits/):** Write

## Path parameters

- `id` string, required — Unique identifier of the task to update.

## Headers

- `Lightfield-Version` '2026-03-01', required

## Request body

- object
  - `fields` object — Field values to update — only provided fields are modified; omitted fields are left unchanged. Tasks only support the documented system fields, all prefixed with `$` (e.g. `$title`, `$status`). Call the <u>[definitions endpoint](/api/resources/task/methods/definitions)</u> for available fields. See <u>[Fields and relationships](/using-the-api/fields-and-relationships/)</u> for value type details.
    - `$title` string, nullable — Title of the task.
    - `$status` string, nullable — Task status. One of: `TODO`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`.
    - `$description` string, nullable — Description of the task in markdown format.
    - `$dueAt` string, nullable — Due date as an ISO 8601 datetime string.
  - `relationships` union — Relationship operations to apply. System relationships use a `$` prefix (e.g. `$account`, `$assignedTo`). Each value is an operation object with `add`, `remove`, or `replace`.
    - object
      - `$account` object — Operation to modify the task account.
        - `add` union — Entity ID(s) to add to the relationship.
          - string
          - string[]
        - `remove` union — Entity ID(s) to remove from the relationship.
          - string
          - string[]
        - `replace` union — Entity ID(s) to set as the relationship replacement, or null to clear supported relationships.
          - string
          - string[]
      - `$assignedTo` object — Operation to modify the assigned member.
        - `add` union — Entity ID(s) to add to the relationship.
          - string
          - string[]
        - `remove` union — Entity ID(s) to remove from the relationship.
          - string
          - string[]
        - `replace` union — Entity ID(s) to set as the relationship replacement, or null to clear supported relationships.
          - string
          - string[]
      - `$opportunity` object — Operation to modify the associated opportunity.
        - `add` union — Entity ID(s) to add to the relationship.
          - string
          - string[]
        - `remove` union — Entity ID(s) to remove from the relationship.
          - string
          - string[]
        - `replace` union — Entity ID(s) to set as the relationship replacement, or null to clear supported relationships.
          - string
          - string[]
    - object

## Response `200`

OK

- TaskUpdateResponse
  - `id` string, required — Unique identifier for the entity.
  - `createdAt` string, required — ISO 8601 timestamp of when the entity was created.
  - `updatedAt` string, nullable, required — ISO 8601 timestamp of when the entity was last updated, or null.
  - `httpLink` string, nullable, required — URL to view the entity in the Lightfield web app, or null.
  - `externalId` string, nullable — External identifier for the entity, or null if unset.
  - `fields` object, required — Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
  - `relationships` object, required — Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403
- `404` — 404
- `409` — 409
- `415` — 415
- `422` — 422
- `429` — 429
- `500` — 500
- `501` — 501
- `503` — 503
- `504` — 504

## Changes

- **2026-07-28** `93b6c5de5463` — 1 info
  - added the non-success response with the status `501`
- **2026-05-21** `7b3cf2deef52` — 1 breaking, 1 warning, 2 info
  - the `relationships` request property type/format changed from `object`/`` to ``/``
  - added the new `HTML` enum value to the `fields/additionalProperties/valueType` response property for the response status `200`
  - added `subschema #1: TaskUpdateRelationshipsTyped, subschema #2: TaskUpdateRelationshipsUntyped` to the `relationships` request property `oneOf` list
  - added the non-success response with the status `504`
- **2026-04-17** `b8f139211ae6` — 2 breaking
  - removed `subschema #1: TaskUpdateRelationshipsTyped, subschema #2: TaskUpdateRelationshipsUntyped` from the `relationships` request property `oneOf` list
  - the `relationships` request property type/format changed from ``/`` to `object`/``
- **2026-04-17** `9e026e8daea4` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/lightfld/apis/api-reference/changes/v1/tasks/:id/post.md)

---

[API](https://skmtc.dev/lightfld/apis/api-reference.md) · [All operations](https://skmtc.dev/lightfld/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lightfld/api-reference/revisions/93b6c5de5463/schema)
