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

# Edit a comment or update its discussion

> Edit a comment's `body`, set its thread's `status` to `resolved` or `open`, or set `priority` to `high`, `medium`, `low`, or null to clear it. Send exactly one. Only the author can edit the body; any filing editor can change status or priority. Priority applies to the whole discussion and does not change its status. Priority changes also support existing discussions on legacy filings with an unset mode; reference filings remain read-only. Body and status writes require managed mode. System event bodies can't be edited. Setting the current status again does nothing.



## OpenAPI

````yaml /openapi.json patch /insurance/managed-filings/{filingId}/comments/{commentId}
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/managed-filings/{filingId}/comments/{commentId}:
    patch:
      tags:
        - Managed Filings
      summary: Edit a comment or update its discussion
      description: >-
        Edit a comment's `body`, set its thread's `status` to `resolved` or
        `open`, or set `priority` to `high`, `medium`, `low`, or null to clear
        it. Send exactly one. Only the author can edit the body; any filing
        editor can change status or priority. Priority applies to the whole
        discussion and does not change its status. Priority changes also support
        existing discussions on legacy filings with an unset mode; reference
        filings remain read-only. Body and status writes require managed mode.
        System event bodies can't be edited. Setting the current status again
        does nothing.
      operationId: updateManagedFilingComment
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: filingId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: commentId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ManagedFilingCommentUpdate'
      responses:
        '200':
          description: Updated comment and current thread state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ManagedFilingComment'
        '400':
          description: Invalid fields or request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: A write-capable user credential and edit access are required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: >-
            Filing, item, reference, or registered record type is missing or
            inaccessible.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            Read-only filing, occupied schedule position, dependency, or
            concurrent change.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '415':
          description: Content-Type must be application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency temporarily unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2ManagedFilingCommentUpdate:
      oneOf:
        - type: object
          properties:
            body:
              type: string
              minLength: 1
              maxLength: 20000
              pattern: \S
          required:
            - body
          additionalProperties: false
        - type: object
          properties:
            status:
              type: string
              enum:
                - open
                - resolved
          required:
            - status
          additionalProperties: false
        - type: object
          properties:
            priority:
              type: string
              nullable: true
              enum:
                - high
                - medium
                - low
                - null
              description: Discussion priority. Null clears it.
          required:
            - priority
          additionalProperties: false
    V2ManagedFilingComment:
      type: object
      properties:
        id:
          type: string
          description: >-
            Comment or event ID. Use a top-level message ID as parentCommentId
            when replying.
        threadId:
          type: string
          description: Discussion ID shared by its root message, replies, and events.
        parentCommentId:
          type: string
          nullable: true
          description: >-
            Root message ID for a reply; null for root messages and thread-level
            events.
        commentType:
          type: string
          enum:
            - message
            - system
            - status_change
          description: >-
            message is discussion text; system and status_change are read-only
            events.
        actor:
          type: string
          description: Identity of the user or agent that authored this entry.
        body:
          type: string
          nullable: true
          description: Comment text; null for deleted messages and events without text.
        data:
          type: object
          additionalProperties:
            nullable: true
          description: >-
            Additional event metadata. Status-change events include status;
            deleted comments return an empty object.
        customerVisible:
          type: boolean
          description: >-
            Shared with the customer as an update on their Feature Request
            (Effective’s Feature Requests only)
        deleted:
          type: boolean
          description: >-
            True for a deleted message retained as a timeline tombstone; its
            body is null.
        editedAt:
          type: string
          nullable: true
          description: Last edit timestamp, or null if never edited or deleted.
        createdAt:
          type: string
          description: Timestamp when the message or event was created.
        status:
          type: string
          enum:
            - open
            - resolved
          description: >-
            Current resolution state of the whole discussion, including on older
            timeline entries.
        priority:
          type: string
          enum:
            - high
            - medium
            - low
          description: Current discussion priority; omitted when unset.
        anchor:
          $ref: '#/components/schemas/ResourceAnchor'
        target:
          $ref: '#/components/schemas/V2ManagedFilingCommentTarget'
      required:
        - id
        - threadId
        - parentCommentId
        - commentType
        - actor
        - body
        - data
        - customerVisible
        - deleted
        - editedAt
        - createdAt
        - status
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            executionId:
              type: string
              description: >-
                The recorded execution of a failed rating, for rater rating
                failures.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          required:
            - code
    ResourceAnchor:
      oneOf:
        - type: object
          properties:
            type:
              type: string
              enum:
                - whole_resource
          required:
            - type
        - type: object
          properties:
            type:
              type: string
              enum:
                - field
            path:
              type: string
              minLength: 1
          required:
            - type
            - path
      description: Structural location within a resource
    V2ManagedFilingCommentTarget:
      oneOf:
        - type: object
          properties:
            type:
              type: string
              enum:
                - record
            recordType:
              type: string
              enum:
                - filings
                - filing_items
                - submissions
                - submission_items
                - objections
                - objection_items
            recordId:
              type: string
              format: uuid
            field:
              type: string
              pattern: ^[A-Za-z0-9_-]{1,128}$
          required:
            - type
            - recordType
            - recordId
          additionalProperties: false
        - type: object
          properties:
            type:
              type: string
              enum:
                - artifact
            recordType:
              type: string
              enum:
                - filing_items
                - submission_items
            recordId:
              type: string
              format: uuid
            artifactId:
              type: string
              format: uuid
            artifactVersionId:
              type: string
              format: uuid
              description: >-
                Document version UUID. Use the selected item or attachment
                artifactVersionId when pinned; otherwise use versionId from GET
                /api/v2/files/{artifactId}. This pins the comment to that
                version; it is not a storage generation or the file ID.
          required:
            - type
            - recordType
            - recordId
            - artifactId
            - artifactVersionId
          additionalProperties: false
      description: >-
        Present on API-created discussions, inherited by replies. Older native
        discussions use anchor instead.
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

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