## Update a task

`task.update(strid, TaskUpdateParams**kwargs)  -> TaskUpdateResponse`

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

### Parameters

- `id: str`

  Unique identifier of the task to update.

- `fields: Optional[Fields]`

  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[str]`

    Description of the task in markdown format.

  - `due_at: Optional[str]`

    Due date as an ISO 8601 datetime string.

  - `status: Optional[str]`

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

  - `title: Optional[str]`

    Title of the task.

- `relationships: Optional[Union[Dict[str, RelationshipsUntypedRelationshipsUntypedItem]]]`

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

  - `Dict[str, RelationshipsUntypedRelationshipsUntypedItem]`

    - `add: Optional[Union[str, Sequence[str]]]`

      Entity ID(s) to add to the relationship.

      - `str`

      - `Sequence[str]`

    - `remove: Optional[Union[str, Sequence[str]]]`

      Entity ID(s) to remove from the relationship.

      - `str`

      - `Sequence[str]`

    - `replace: Optional[Union[str, Sequence[str]]]`

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

      - `str`

      - `Sequence[str]`

### Returns

- `class TaskUpdateResponse: …`

  - `id: str`

    Unique identifier for the entity.

  - `created_at: str`

    ISO 8601 timestamp of when the entity was created.

  - `fields: Dict[str, Fields]`

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

    - `value: Optional[FieldsValue]`

      The field value, or null if unset.

      - `str`

      - `float`

      - `bool`

      - `List[str]`

      - `class FieldsValueAddress: …`

        - `city: Optional[str]`

          City name.

        - `country: Optional[str]`

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

        - `latitude: Optional[float]`

          Latitude coordinate.

        - `longitude: Optional[float]`

          Longitude coordinate.

        - `postal_code: Optional[str]`

          Postal or ZIP code.

        - `state: Optional[str]`

          State or province.

        - `street: Optional[str]`

          Street address line 1.

        - `street2: Optional[str]`

          Street address line 2.

      - `class FieldsValueFullName: …`

        - `first_name: Optional[str]`

          The contact's first name.

        - `last_name: Optional[str]`

          The contact's last name.

    - `value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 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"`

  - `http_link: Optional[str]`

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

  - `relationships: Dict[str, Relationships]`

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

    - `cardinality: str`

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

    - `object_type: str`

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

    - `values: List[str]`

      IDs of the related entities.

  - `updated_at: Optional[str]`

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

  - `external_id: Optional[str]`

    External identifier for the entity, or null if unset.

### Example

```python
from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
task_update_response = client.task.update(
    id="id",
)
print(task_update_response.id)
```

#### Response

```json
{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}
```