> ## Documentation Index
> Fetch the complete documentation index at: https://docs.conduit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update task

> Updates a task, including its status. Requires a token with write access.



## OpenAPI

````yaml PATCH /v1/tasks/{id}
openapi: 3.0.0
info:
  title: Conduit API
  version: 1.0.0
  description: Public API for Conduit.
servers:
  - url: https://api.conduit.ai
    description: Production
security: []
tags:
  - name: meta
    description: Discovery and API metadata endpoints.
  - name: agents
    description: >-
      Chat agent configuration, including instructions, skills, triggers, and
      automation behavior.
  - name: contacts
    description: >-
      Contact profile and contact-scoped related resources such as tickets and
      calls.
  - name: workspaces
    description: Workspaces accessible to the current API token.
  - name: escalations
    description: >-
      Chat escalations that require operator review, including message, proposed
      response, and disposition context when available.
  - name: conversations
    description: >-
      Canonical message threads. Use these endpoints to list threads, inspect
      conversation state, read transcripts, and send replies.
  - name: conversation-tags
    description: >-
      Conversation labels, root topics, and subtopics used for classification
      and topic analytics.
  - name: tickets
    description: >-
      Operational queue items tied to conversations, including ticket-scoped
      transcripts and replies.
  - name: calls
    description: Phone call records, transcripts, summaries, and recordings when available.
  - name: reservations
    description: >-
      PMS reservations synced from the workspace's integrations (Hostaway,
      Guesty, Airbnb, etc.), including guest identity, payment status, and stay
      dates.
  - name: appointments
    description: >-
      Scheduled appointments (bookings) backed by the Conduit booking service.
      Exposes allocation context and the upstream booking-service `external_id`.
  - name: helpdesk_tickets
    description: >-
      Helpdesk tickets mirrored from external helpdesk integrations (Zendesk,
      Pylon, Plain), including requester identity and upstream metadata.
  - name: kb
    description: >-
      Knowledge base search and node management. Nodes represent knowledge base
      entries (files or directories), chunks are the indexed retrieval units
      used by search.
  - name: skills
    description: >-
      Workspace agent skills that can be attached to chat agents.
      Sidebar/global-assistant skills are intentionally excluded.
  - name: custom_tools
    description: >-
      Custom code tools: user-authored Python/JavaScript functions executed in a
      sandbox when an agent calls them. Includes a runtimes endpoint describing
      the entrypoint signature, return shape, and available dependencies per
      language.
  - name: inbox_types
    description: >-
      Workspace inbox types. Each id is stable and usable as a message trigger's
      `inbox_type_id` and as the `inbox_type_id` filter on list conversations.
  - name: workflows
    description: >-
      Workspace automation workflows: definitions, executions, and per-execution
      event timelines.
  - name: insights
    description: Aggregated workspace analytics, such as conversation automation rate.
paths:
  /v1/tasks/{id}:
    patch:
      tags:
        - tasks
      summary: Update task
      description: >-
        Updates a task, including its status. Requires a token with write
        access.
      operationId: updateTask
      parameters:
        - schema:
            type: string
            description: Task id.
            example: k17demo8f8x7c9v0n2q4r6t8y1u3i5o
          required: true
          name: id
          in: path
        - schema:
            type: string
            description: Workspace the task belongs to.
            example: j57demo8f8x7c9v0n2q4r6t8y1u3i5o
          required: true
          name: workspace_id
          in: query
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  minLength: 1
                description:
                  type: string
                  nullable: true
                status_id:
                  type: string
                category_id:
                  type: string
                  nullable: true
                priority:
                  type: string
                  nullable: true
                  enum:
                    - low
                    - normal
                    - high
                    - urgent
                due_at:
                  type: string
                  nullable: true
                assignees:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - member
                          - contact
                      id:
                        type: string
                    required:
                      - type
                      - id
                  description: Replaces the whole team. Pass [] to unassign everyone.
                listing_id:
                  type: string
                  nullable: true
                reservation_id:
                  type: string
                  nullable: true
                custom_fields:
                  type: object
                  additionalProperties:
                    nullable: true
                  description: >-
                    Values keyed by custom field id. Other fields stay as they
                    are.
              description: >-
                Fields to change. Omitted fields stay the same; null clears a
                field.
              example:
                status_id: js7demo8f8x7c9v0n2q4r6t8y1u3i5o
      responses:
        '200':
          description: Task updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      title:
                        type: string
                      status:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                          category:
                            type: string
                            description: >-
                              Behavior bucket: upcoming, in_progress, review,
                              completed, canceled, other, needs_approval.
                          color:
                            type: string
                            nullable: true
                        required:
                          - id
                          - name
                          - category
                          - color
                      category:
                        type: object
                        nullable: true
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                        required:
                          - id
                          - name
                      priority:
                        type: string
                        nullable: true
                      assignees:
                        type: array
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - member
                                - contact
                            id:
                              type: string
                              description: >-
                                Workspace member id or contact id, depending on
                                type.
                            name:
                              type: string
                          required:
                            - type
                            - id
                            - name
                      due_at:
                        type: string
                        nullable: true
                      estimated_minutes:
                        type: number
                        nullable: true
                      listing_id:
                        type: string
                        nullable: true
                      created_via:
                        type: string
                        nullable: true
                      created_at:
                        type: string
                      last_updated:
                        type: string
                        description: >-
                          When the task was last updated. Equals created_at for
                          a task that was never edited.
                      description:
                        type: string
                        nullable: true
                      reservation_id:
                        type: string
                        nullable: true
                      contact_id:
                        type: string
                        nullable: true
                      completed_at:
                        type: string
                        nullable: true
                      checklist:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            label:
                              type: string
                            completed:
                              type: boolean
                          required:
                            - id
                            - label
                            - completed
                      attachments:
                        type: array
                        items:
                          type: object
                          properties:
                            file_name:
                              type: string
                              nullable: true
                            content_type:
                              type: string
                              nullable: true
                            url:
                              type: string
                              nullable: true
                          required:
                            - file_name
                            - content_type
                            - url
                      custom_fields:
                        type: array
                        items:
                          type: object
                          properties:
                            field_id:
                              type: string
                            name:
                              type: string
                            type:
                              type: string
                            value:
                              nullable: true
                          required:
                            - field_id
                            - name
                            - type
                    required:
                      - id
                      - title
                      - status
                      - category
                      - priority
                      - assignees
                      - due_at
                      - estimated_minutes
                      - listing_id
                      - created_via
                      - created_at
                      - last_updated
                      - description
                      - reservation_id
                      - contact_id
                      - completed_at
                      - checklist
                      - attachments
                      - custom_fields
                required:
                  - data
                description: A single task.
                example:
                  data:
                    id: k17demo8f8x7c9v0n2q4r6t8y1u3i5o
                    title: Replace AC filter in unit 4B
                    status:
                      id: js7demo8f8x7c9v0n2q4r6t8y1u3i5o
                      name: In progress
                      category: in_progress
                      color: '#3B82F6'
                    category:
                      id: kd2demo8f8x7c9v0n2q4r6t8y1u3i5o
                      name: Maintenance
                    priority: high
                    assignees:
                      - type: member
                        id: wm1demo8f8x7c9v0n2q4r6t8y1u3i5o
                        name: Ana Ruiz
                    due_at: '2026-11-05T15:00:00.000Z'
                    estimated_minutes: 30
                    listing_id: '123'
                    created_via: direct
                    created_at: '2026-11-03T18:00:00.000Z'
                    last_updated: '2026-11-04T09:30:00.000Z'
                    description: Guest reported a rattling noise.
                    reservation_id: null
                    contact_id: null
                    completed_at: null
                    checklist:
                      - id: req_1
                        label: Photo of old filter
                        completed: true
                    attachments: []
                    custom_fields: []
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Token
      description: >-
        Conduit API token. Use `Authorization: Bearer <token>`. Read/write
        endpoints require a token with write access.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.