> ## 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 resolve its discussion

> Supply body to edit your own message, or status to resolve/reopen the whole discussion. Do not supply both. Read-only events cannot be edited. Discussion status is independent of item status and does not signify regulator acceptance. Requires edit access to the managed filing and item. Does not notify the filing agent or send anything to SERFF.



## OpenAPI

````yaml /openapi.json patch /objections/{id}/items/{itemId}/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:
  /objections/{id}/items/{itemId}/comments/{commentId}:
    patch:
      tags:
        - Objections
      summary: Edit a comment or resolve its discussion
      description: >-
        Supply body to edit your own message, or status to resolve/reopen the
        whole discussion. Do not supply both. Read-only events cannot be edited.
        Discussion status is independent of item status and does not signify
        regulator acceptance. Requires edit access to the managed filing and
        item. Does not notify the filing agent or send anything to SERFF.
      operationId: updateObjectionItemComment
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: itemId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: commentId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ObjectionItemCommentUpdate'
      responses:
        '200':
          description: Updated comment or discussion.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ObjectionItemComment'
        '400':
          description: Invalid request, fields, or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Insufficient permission for this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: >-
            Filing, objection, item, comment, or reference missing or
            inaccessible.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: Read-only filing, duplicate sequence number, or dependent record.
          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:
    V2ObjectionItemCommentUpdate:
      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
    V2ObjectionItemComment:
      type: object
      properties:
        id:
          type: string
        threadId:
          type: string
        parentCommentId:
          type: string
          nullable: true
        commentType:
          type: string
          enum:
            - message
            - system
            - status_change
        actor:
          type: string
        body:
          type: string
          nullable: true
        data:
          type: object
          additionalProperties:
            nullable: true
        customerVisible:
          type: boolean
          description: >-
            Shared with the customer as an update on their Feature Request
            (Effective’s Feature Requests only)
        deleted:
          type: boolean
        editedAt:
          type: string
          nullable: true
        createdAt:
          type: string
        status:
          type: string
          enum:
            - open
            - resolved
          description: >-
            Current discussion resolution; independent of the objection item
            status.
        anchor:
          $ref: '#/components/schemas/ResourceAnchor'
      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.
            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
    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.