---
title: "Update Order Task"
method: PATCH
path: "/orders/{order_handle}/tasks/{task_id}"
tags: ["Orders"]
---

# Update Order Task

`PATCH /orders/{order_handle}/tasks/{task_id}`

## Request

- Base URL: `https://v3.api.hypertrack.com`
- URL: `https://v3.api.hypertrack.com/orders/{order_handle}/tasks/{task_id}`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/orders/:order_handle/tasks/:task_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Updates the details of a specific task associated with an order. This endpoint is used to modify the status and details of a task by its ID.

## Path parameters

- `order_handle` string, required
- `task_id` string, required

## Query parameters

- `fulfillment_attempt` integer, nullable

## Request body

- UpdateOrderTaskRequest
  - `label` string, nullable: Label of task to be updated.
  - `status` 'ongoing' | 'completed' | 'cancelled' | 'null', nullable: Status of task to be updated. Valid values are ongoing, completed, cancelled.
  - `description` string, nullable: Description of task to be updated. This will not update existing description.
  - `priority` 'none' | 'low' | 'medium' | 'high' | 'null', nullable: Priority of task to be updated. Valid values are none, low, medium, high.
  - `metadata` object, nullable: Metadata to be updated for the task.
  - `attachments` union[], nullable: List of attachments in event, this will not delete existing attachments, only add new attachments to tasks
    - union
      - ImageAttachmentUpload
        - `type` 'image', required: Type of attachment
        - `caption` string, required: Caption for the image
        - `data` string, required: Image as base64 text
        - `attachment_id` string, uuid, nullable: String representing the ID of the attachment
      - NoteAttachmentUpload
        - `type` 'note', required: Type of attachment
        - `data` string, required: Text for the note
        - `attachment_id` string, uuid, nullable: String representing the ID of the attachment
      - SignatureAttachmentUpload
        - `type` 'signature', required: Type of attachment
        - `data` string, required: Signature as base64 text
        - `attachment_id` string, uuid, nullable: String representing the ID of the attachment

## Response `200`

Successful response

- OrderTaskResponse
  - `label` string, required: Type of task to be created for the order.
  - `task_definition_id` string, nullable: Id of the tasks definition from which this task is picked
  - `description` string, nullable: Description of the task type.
  - `metadata` object, nullable: Additional metadata for the task.
  - `priority` 'none' | 'low' | 'medium' | 'high' | 'null', nullable: Priority of the task. Valid values are none, low, medium, high.
  - `task_id` string, required: Unique identifier for the created task.
  - `status` string, nullable: Status of the task. Valid values are pending, ongoing, completed, cancelled.
  - `created_at` string, required: Timestamp when the task was created.
  - `updated_at` string, nullable: Timestamp when the task was last updated.
  - `attachments` union[], nullable: Attachments associated with the event
    - union
      - ImageAttachmentResponse
        - `type` 'image', required: Type of attachment
        - `url` string, required: Image link
        - `caption` string, nullable: Caption for the image
        - `attachment_id` string, nullable
      - NoteAttachmentResponse
        - `type` 'note', required: Type of attachment
        - `data` string, required: Text for the note
        - `attachment_id` string, nullable
      - SignatureAttachmentResponse
        - `type` 'signature', required: Type of attachment
        - `url` string, required: Signature image link
        - `attachment_id` string, nullable

## Other responses

- `400`: Validation error
- `401`: Authentication error
- `404`: Not Found

---

[API](https://skmtc.dev/hypertrack/apis/hypertrack-api.md) - [All operations](https://skmtc.dev/hypertrack/apis/hypertrack-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hypertrack/apis/hypertrack-api/revisions/389326c4c9c8?raw)