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

# Update an issue

> Changes an issue's status, assignee, labels, or external link. Send `label_ids` as the issue's full set of labels. A status change can carry a short note, which appears on the timeline.



## OpenAPI

````yaml /api-reference/openapi.json patch /v1/issues/{id}
openapi: 3.1.0
info:
  title: ility API
  version: 1.0.0
  description: Read accessibility results and start scans in your ility workspace.
servers:
  - url: https://app.ilitylabs.com
security:
  - apiKey: []
tags:
  - name: Workspaces
  - name: Surfaces
  - name: Domains
  - name: Scans
  - name: Issues
paths:
  /v1/issues/{id}:
    patch:
      tags:
        - Issues
      summary: Update an issue
      description: >-
        Changes an issue's status, assignee, labels, or external link. Send
        `label_ids` as the issue's full set of labels. A status change can carry
        a short note, which appears on the timeline.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchIssueBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueDetail'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden (viewer role)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Issue not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    PatchIssueBody:
      type: object
      properties:
        status:
          type: string
          enum:
            - open
            - resolved
            - wont_fix
            - false_positive
        note:
          type:
            - string
            - 'null'
          maxLength: 1000
        assignee_user_id:
          type:
            - string
            - 'null'
          format: uuid
        external_url:
          type:
            - string
            - 'null'
          maxLength: 2048
          format: uri
        label_ids:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 20
    IssueDetail:
      type: object
      properties:
        id:
          type: string
          format: uuid
        number:
          type:
            - integer
            - 'null'
        fingerprint:
          type: string
        severity:
          type: string
          enum:
            - critical
            - serious
            - moderate
            - minor
        status:
          type: string
          enum:
            - open
            - resolved
            - wont_fix
            - false_positive
        latest_help_text:
          type:
            - string
            - 'null'
        app_url:
          type: string
          format: uri
        external_url:
          type:
            - string
            - 'null'
        external_provider:
          anyOf:
            - type: string
              enum:
                - github
                - asana
                - fake
            - type: 'null'
        external_ref:
          type:
            - string
            - 'null'
        external_key:
          type:
            - string
            - 'null'
        external_linked_at:
          type:
            - string
            - 'null'
          format: date-time
        engine:
          type:
            - string
            - 'null'
        engine_version:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        first_seen_at:
          type: string
          format: date-time
        last_seen_at:
          type: string
          format: date-time
        assignee:
          anyOf:
            - $ref: '#/components/schemas/IssueAssignee'
            - type: 'null'
        comment_count:
          type: integer
        instance_count:
          type: integer
        page_count:
          type: integer
        embed_origin:
          type:
            - string
            - 'null'
        rule:
          $ref: '#/components/schemas/IssueRule'
        representative_instance:
          anyOf:
            - $ref: '#/components/schemas/IssueInstance'
            - type: 'null'
        labels:
          type: array
          items:
            $ref: '#/components/schemas/IssueLabel'
        active_recheck:
          anyOf:
            - $ref: '#/components/schemas/ActiveRecheck'
            - type: 'null'
      required:
        - id
        - number
        - fingerprint
        - severity
        - status
        - latest_help_text
        - app_url
        - external_url
        - external_provider
        - external_ref
        - external_key
        - external_linked_at
        - engine
        - engine_version
        - created_at
        - first_seen_at
        - last_seen_at
        - assignee
        - comment_count
        - instance_count
        - page_count
        - embed_origin
        - rule
        - representative_instance
        - labels
        - active_recheck
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
        reason:
          type: string
      required:
        - detail
    IssueAssignee:
      type: object
      properties:
        user_id:
          type: string
          format: uuid
        display_name:
          type:
            - string
            - 'null'
        avatar_url:
          type:
            - string
            - 'null'
      required:
        - user_id
        - display_name
        - avatar_url
    IssueRule:
      type: object
      properties:
        id:
          type:
            - string
            - 'null'
        name:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        help_text:
          type:
            - string
            - 'null'
        why_it_matters:
          type:
            - string
            - 'null'
        affected_groups:
          type: array
          items:
            type: string
        wcag_criteria:
          type: array
          items:
            $ref: '#/components/schemas/IssueWcagCriterion'
        frameworks:
          type: array
          items:
            type: string
      required:
        - id
        - name
        - description
        - help_text
        - why_it_matters
        - affected_groups
        - wcag_criteria
        - frameworks
    IssueInstance:
      type: object
      properties:
        id:
          type: string
          format: uuid
        canonical_fingerprint:
          type: string
        status:
          type: string
          enum:
            - open
            - resolved
        severity:
          type: string
          enum:
            - critical
            - serious
            - moderate
            - minor
        page_id:
          type: string
          format: uuid
        page_url:
          type: string
        selector:
          type: string
        frame_origin:
          type:
            - string
            - 'null'
        dom_context:
          type:
            - object
            - 'null'
          additionalProperties: {}
        latest_help_text:
          type:
            - string
            - 'null'
        first_seen_at:
          type: string
          format: date-time
        last_seen_at:
          type: string
          format: date-time
        findings:
          type: array
          items:
            $ref: '#/components/schemas/IssueFinding'
        has_screenshot:
          type: boolean
        has_source:
          type: boolean
        evidence_kind:
          anyOf:
            - type: string
              enum:
                - screenshot
                - image
            - type: 'null'
        evidence_is_current:
          type: boolean
        scan_page_id:
          type:
            - string
            - 'null'
          format: uuid
        element_marker:
          type:
            - integer
            - 'null'
      required:
        - id
        - canonical_fingerprint
        - status
        - severity
        - page_id
        - page_url
        - selector
        - frame_origin
        - dom_context
        - latest_help_text
        - first_seen_at
        - last_seen_at
        - findings
        - has_screenshot
        - has_source
        - evidence_kind
        - evidence_is_current
        - scan_page_id
        - element_marker
    IssueLabel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        color:
          type: string
      required:
        - id
        - name
        - color
    ActiveRecheck:
      type: object
      properties:
        scan_request_id:
          type: string
          format: uuid
        pages_queued:
          type: integer
          minimum: 0
        requested_at:
          type: string
          format: date-time
        runs:
          type: array
          items:
            $ref: '#/components/schemas/ActiveRecheckRun'
      required:
        - scan_request_id
        - pages_queued
        - requested_at
        - runs
    IssueWcagCriterion:
      type: object
      properties:
        criterion_id:
          type: string
        level:
          type: string
        name:
          type: string
        understanding_url:
          type:
            - string
            - 'null'
      required:
        - criterion_id
        - level
        - name
        - understanding_url
    IssueFinding:
      type: object
      properties:
        element_snippet:
          type:
            - string
            - 'null'
        found_at:
          type: string
          format: date-time
      required:
        - element_snippet
        - found_at
    ActiveRecheckRun:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
        pages_done:
          type: integer
          minimum: 0
        pages_failed:
          type: integer
          minimum: 0
        done_through:
          type:
            - string
            - 'null'
      required:
        - id
        - status
        - pages_done
        - pages_failed
        - done_through
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An ility API key, such as `ilk_1a2b3c4d_…`. Workspace owners create keys
        under Settings → API keys.

````

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