## Update

**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`

  Unique identifier of the task to update.

### Body Parameters

- `fields: optional object { "$description", "$dueAt", "$status", "$title" }`

  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.

  - `"$description": optional string`

    Description of the task in markdown format.

  - `"$dueAt": optional string`

    Due date as an ISO 8601 datetime string.

  - `"$status": optional string`

    Task status. One of: `TODO`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`.

  - `"$title": optional string`

    Title of the task.

- `relationships: optional map[object { add, remove, replace } ]`

  Relationship operations to apply. System relationships use a `$` prefix (e.g. `$account`, `$assignedTo`). Each value is an operation object with `add`, `remove`, or `replace`.

  - `add: optional string or array of string`

    Entity ID(s) to add to the relationship.

    - `UnionMember0 = string`

    - `UnionMember1 = array of string`

  - `remove: optional string or array of string`

    Entity ID(s) to remove from the relationship.

    - `UnionMember0 = string`

    - `UnionMember1 = array of string`

  - `replace: optional string or array of string`

    Entity ID(s) to set as the entire relationship, replacing all existing associations.

    - `UnionMember0 = string`

    - `UnionMember1 = array of string`

### Returns

- `TaskUpdateResponse = object { id, createdAt, fields, 4 more }`

  - `id: string`

    Unique identifier for the entity.

  - `createdAt: string`

    ISO 8601 timestamp of when the entity was created.

  - `fields: map[object { value, valueType } ]`

    Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.

    - `value: string or number or boolean or 3 more`

      The field value, or null if unset.

      - `UnionMember0 = string`

      - `UnionMember1 = number`

      - `UnionMember2 = boolean`

      - `UnionMember3 = array of string`

      - `Address = object { city, country, latitude, 5 more }`

        - `city: optional string`

          City name.

        - `country: optional string`

          2-letter ISO 3166-1 alpha-2 country code.

        - `latitude: optional number`

          Latitude coordinate.

        - `longitude: optional number`

          Longitude coordinate.

        - `postalCode: optional string`

          Postal or ZIP code.

        - `state: optional string`

          State or province.

        - `street: optional string`

          Street address line 1.

        - `street2: optional string`

          Street address line 2.

      - `FullName = object { firstName, lastName }`

        - `firstName: optional string`

          The contact's first name.

        - `lastName: optional string`

          The contact's last name.

    - `valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more`

      The data type of the field.

      - `"ADDRESS"`

      - `"CHECKBOX"`

      - `"CURRENCY"`

      - `"DATETIME"`

      - `"EMAIL"`

      - `"FULL_NAME"`

      - `"MARKDOWN"`

      - `"MULTI_SELECT"`

      - `"NUMBER"`

      - `"SINGLE_SELECT"`

      - `"SOCIAL_HANDLE"`

      - `"TELEPHONE"`

      - `"TEXT"`

      - `"URL"`

  - `httpLink: string`

    URL to view the entity in the Lightfield web app, or null.

  - `relationships: map[object { cardinality, objectType, values } ]`

    Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).

    - `cardinality: string`

      Whether the relationship is `has_one` or `has_many`.

    - `objectType: string`

      The type of the related object (e.g. `account`, `contact`).

    - `values: array of string`

      IDs of the related entities.

  - `updatedAt: string`

    ISO 8601 timestamp of when the entity was last updated, or null.

  - `externalId: optional string`

    External identifier for the entity, or null if unset.

### Example

```http
curl https://api.lightfield.app/v1/tasks/$ID \
    -H 'Content-Type: application/json' \
    -H 'Lightfield-Version: 2026-03-01' \
    -H "Authorization: Bearer $API_KEY" \
    -d '{}'
```