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

# Update Task

> Partially updates a task. Send only the fields you want to change — omitted
fields are left unchanged.

`assignees`, when provided, replaces the existing assignee list and must
reference users in the same company — a non-member user ID is rejected with
a `400` error.

**Required permission:** `company.task:update`




## OpenAPI

````yaml /openapi/generated-external-api.yaml patch /api/v1/companies/{companyId}/tasks/{taskId}
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://go.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/companies/{companyId}/tasks/{taskId}:
    patch:
      tags:
        - Tasks
      summary: Update Task
      description: >
        Partially updates a task. Send only the fields you want to change —
        omitted

        fields are left unchanged.


        `assignees`, when provided, replaces the existing assignee list and must

        reference users in the same company — a non-member user ID is rejected
        with

        a `400` error.


        **Required permission:** `company.task:update`
      operationId: updateTask
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/taskId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Any subset of the task's mutable fields
              properties:
                name:
                  type: string
                  description: Task name
                description:
                  type: string
                  description: Task description
                status:
                  type: string
                  enum:
                    - Not Complete
                    - Complete
                  description: Task completion status
                deadline:
                  type: string
                  format: date-time
                  description: Task deadline as an ISO 8601 date-time string
                entity:
                  type: object
                  nullable: true
                  description: |
                    Entity to link the task to, or `null` to unlink it.
                  required:
                    - type
                    - id
                    - name
                  properties:
                    type:
                      type: string
                      description: Type of the related entity
                    id:
                      type: string
                      format: uuid
                      description: Identifier of the related entity
                    name:
                      type: string
                      description: Display name of the related entity
                assignees:
                  type: array
                  description: >-
                    Company user IDs to assign the task to (replaces the
                    existing list)
                  items:
                    type: string
            examples:
              markComplete:
                summary: Mark a task complete
                value:
                  status: Complete
              reassign:
                summary: Rename and reassign
                value:
                  name: Review updated claim documents
                  assignees:
                    - 550e8400-e29b-41d4-a716-446655440999
              unlinkEntity:
                summary: Unlink the related entity
                value:
                  entity: null
      responses:
        '200':
          description: Task updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
              examples:
                success:
                  summary: Updated task
                  value:
                    id: 550e8400-e29b-41d4-a716-446655440300
                    name: Review updated claim documents
                    description: Confirm all loss-run reports are attached
                    status: Complete
                    deadline: '2026-07-01T17:00:00.000Z'
                    entity:
                      type: Claim
                      id: 550e8400-e29b-41d4-a716-446655440100
                      name: 'Claim #1042'
                    assignees:
                      - 550e8400-e29b-41d4-a716-446655440999
                    createdBy: 550e8400-e29b-41d4-a716-446655440999
                    createdAt: '2026-06-01T10:30:00.000Z'
                    updatedAt: '2026-06-02T14:00:00.000Z'
        '400':
          description: Bad Request - Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidStatus:
                  summary: Invalid status value
                  value:
                    error:
                      code: InvalidProperties
                      message: 'status: Value is not among the list of allowed values'
                      userMessages:
                        - Value is not among the list of allowed values
                      details:
                        - field: status
                          message: Value is not among the list of allowed values
                invalidAssignee:
                  summary: Assignee is not a company member
                  value:
                    error:
                      code: task-invalid-assignees
                      message: >-
                        An error occurred - please contact support, the
                        technical details are: Assignee user id(s) not in
                        company ea03efb6-9360-4149-a8ca-cf93b69fd0f8:
                        11111111-2222-4333-8444-555555555555
                      userMessages:
                        - >-
                          An error occurred - please contact support, the
                          technical details are: Assignee user id(s) not in
                          company ea03efb6-9360-4149-a8ca-cf93b69fd0f8:
                          11111111-2222-4333-8444-555555555555
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Task not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                taskNotFound:
                  summary: Task not found
                  value:
                    error:
                      code: NotFoundError
                      message: Task not found
                      userMessages:
                        - Task not found
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
    taskId:
      name: taskId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Task identifier
  schemas:
    Task:
      type: object
      description: A task entity.
      required:
        - id
        - name
        - description
        - status
        - deadline
        - entity
        - assignees
        - createdBy
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          format: uuid
          description: Task identifier
        name:
          type: string
          description: Task name
        description:
          type: string
          description: Task description (empty string if none)
        status:
          type: string
          enum:
            - Not Complete
            - Complete
          description: Task completion status
        deadline:
          type: string
          format: date-time
          description: Task deadline as an ISO 8601 date-time string
        entity:
          type: object
          nullable: true
          description: >
            Snapshot of the entity this task is linked to (e.g. a claim or
            policy),

            or `null` when the task is not linked to any entity.
          required:
            - type
            - id
            - name
          properties:
            type:
              type: string
              description: Type of the related entity
            id:
              type: string
              format: uuid
              description: Identifier of the related entity
            name:
              type: string
              description: Display name of the related entity at the time of linking
        assignees:
          type: array
          description: Company user IDs the task is assigned to
          items:
            type: string
        createdBy:
          type: string
          nullable: true
          description: User ID who created the task
        createdAt:
          type: string
          format: date-time
          description: When the task was created
        updatedAt:
          type: string
          format: date-time
          description: When the task was last updated
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            userMessages:
              type: array
              description: >-
                Clean, verbatim-displayable messages — one entry per failure,
                free of error-code tags, field paths, and internal noise.
                Suitable for showing to end users as-is.
              items:
                type: string
              example:
                - Exposures of type 'company' require an address
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: AuthenticationError
                  message: API key authentication required
                  userMessages:
                    - API key authentication required
            invalidApiKey:
              summary: >-
                Invalid API key (e.g. unknown key, or a Bearer token used
                instead of an API key)
              value:
                error:
                  code: AuthenticationError
                  message: Invalid API key
                  userMessages:
                    - Invalid API key
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: AuthorizationError
                  message: User is not authorized to perform the requested action
                  userMessages:
                    - User is not authorized to perform the requested action
            companyMismatch:
              summary: A valid API key naming another company in the URL
              value:
                error:
                  code: AuthorizationError
                  message: API key is not scoped to the requested company
                  userMessages:
                    - API key is not scoped to the requested company
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: UncaughtActionError
                  message: Uncaught error occurred in <actionName>
                  userMessages:
                    - An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Send your raw API key as the `Authorization`
        header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do
        NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key`
        header; those are not accepted.

````