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

# Replace your Plan comment text

> Only the original author may replace a comment. Supply the complete text; existing serialized mention tokens in that text are retained, and removed tokens remove mentions. Uses the current plan version and sha256. Does not change the thread status or plan approval.

> [tab] CLI Tool
>
> ```bash
> coderabbit api request -X PUT "/code/tasks/$TASK_ID/plan/comments/$COMMENT_ID" --input request.json
> ```
>
> To install and sign in to the CLI, see [Call from the CLI](https://docs.coderabbit.ai/api/cli.md).

> [tab] MCP Server
>
> An agent connected to the [CodeRabbit MCP server](https://docs.coderabbit.ai/api/mcp.md) runs this operation as the `replace_code_task_plan_comment` tool. The connection selects the organization, so the arguments have no `org_id` or `org_name`.
>
> ```json
> {
>   "method": "tools/call",
>   "params": {
>     "name": "replace_code_task_plan_comment",
>     "arguments": {
>       "task_id": "<task_id>",
>       "comment_id": "<comment_id>",
>       "version": 1,
>       "sha256": "<sha256>",
>       "text": "<text>"
>     }
>   }
> }
> ```


## OpenAPI

````yaml /openapi.json put /v1/code/tasks/{task_id}/plan/comments/{comment_id}
openapi: 3.0.0
info:
  title: CodeRabbit API
  version: 1.0.0
  description: >-
    Read and manage CodeRabbit reviews, coding tasks, Verify, Triage, security
    findings, Knowledge Base, configuration, and users for your organization.
servers:
  - url: https://api.coderabbit.ai
    description: US region
  - url: https://api.eu.coderabbit.ai
    description: EU region
security:
  - ApiKeyAuth: []
tags:
  - name: Organizations and repositories
  - name: Pull requests and reviews
  - name: Coding Agent
  - name: Coding environments
  - name: Verify
  - name: Triage
  - name: Security
  - name: Knowledge Base
  - name: Automations
  - name: Reports
  - name: Configuration
  - name: Connections
  - name: Users and roles
  - name: Usage and metrics
paths:
  /v1/code/tasks/{task_id}/plan/comments/{comment_id}:
    put:
      tags:
        - Coding Agent
      summary: Replace your Plan comment text
      description: >-
        Only the original author may replace a comment. Supply the complete
        text; existing serialized mention tokens in that text are retained, and
        removed tokens remove mentions. Uses the current plan version and
        sha256. Does not change the thread status or plan approval.
      operationId: replace_code_task_plan_comment
      parameters:
        - name: task_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 200
        - name: comment_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 200
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                org_id:
                  type: string
                  minLength: 1
                  description: >-
                    Organization for a workspace key: the Git-provider
                    organization ID (scope.provider_organization_id) or the
                    CodeRabbit organization ID (scope.id, or id from list
                    organizations). Supply either org_id or org_name, never
                    both. Omit for organization keys and MCP connections.
                org_name:
                  type: string
                  pattern: ^[A-Za-z0-9][A-Za-z0-9-]{0,38}$
                  description: >-
                    GitHub organization login, such as coderabbitai, not its
                    display name. Matched case-insensitively within the
                    authenticated workspace. Supply either org_name or org_id,
                    never both; omit for organization keys and MCP connections.
                version:
                  type: integer
                  minimum: 0
                  exclusiveMinimum: true
                sha256:
                  type: string
                  pattern: ^[0-9a-f]{64}$
                text:
                  type: string
                  minLength: 1
                  maxLength: 65536
              required:
                - version
                - sha256
                - text
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  task_id:
                    type: string
                  version:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                  sha256:
                    type: string
                  revision:
                    type: integer
                    minimum: 0
                    description: Revision of the native Plan comment document.
                  threads:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        status:
                          enum:
                            - open
                            - resolved
                          type: string
                        location:
                          type: object
                          properties:
                            start_offset:
                              type: integer
                              minimum: 0
                              description: >-
                                Inclusive UTF-16 offset in the rendered Markdown
                                text.
                            end_offset:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                              description: >-
                                Exclusive UTF-16 offset in the rendered Markdown
                                text.
                            quote:
                              type: string
                          required:
                            - start_offset
                            - end_offset
                            - quote
                        comments:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              text:
                                type: string
                              author:
                                type: object
                                properties:
                                  user_id:
                                    type: string
                                  display_name:
                                    type: string
                                  handle:
                                    anyOf:
                                      - type: string
                                      - type: string
                                        nullable: true
                                        enum:
                                          - null
                                  avatar_url:
                                    anyOf:
                                      - type: string
                                      - type: string
                                        nullable: true
                                        enum:
                                          - null
                                required:
                                  - user_id
                                  - display_name
                                  - handle
                                  - avatar_url
                              created_at:
                                type: string
                              updated_at:
                                type: string
                            required:
                              - id
                              - text
                              - author
                              - created_at
                              - updated_at
                      required:
                        - id
                        - status
                        - location
                        - comments
                required:
                  - task_id
                  - version
                  - sha256
                  - revision
                  - threads
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - invalid_request
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - unauthenticated
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - forbidden
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - not_found
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - head_changed
                          - conflict
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '412':
          description: Precondition failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - precondition_failed
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '413':
          description: Content too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - payload_too_large
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - rate_limit_exceeded
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - internal_error
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - unavailable
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-coderabbitai-api-key
      description: >-
        See [Authentication](/api/authentication) for the key types and where to
        create a key.

````

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