> ## 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 a recurring report configuration

> Replaces a WEEKLY or MONTHLY report through the native authorized settings operation. ONDEMAND report edits are not supported. Uses the existing destination validation and schedule ownership checks. Send TEAMS with channel "[REDACTED]" to keep the saved Teams webhook.

> [tab] CLI Tool
>
> ```bash
> coderabbit api request -X PUT "/reports/$REPORT_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 `update_report` tool. The connection selects the organization, so the arguments have no `org_id` or `org_name`.
>
> ```json
> {
>   "method": "tools/call",
>   "params": {
>     "name": "update_report",
>     "arguments": {
>       "report_id": 1,
>       "name": "<name>",
>       "time": "<time>",
>       "timezone": "<timezone>",
>       "parameters": [],
>       "emails": [],
>       "promptTemplate": "Daily Standup Report",
>       "type": "<type>",
>       "days": "<days>"
>     }
>   }
> }
> ```


## OpenAPI

````yaml /openapi.json put /v1/reports/{report_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/reports/{report_id}:
    put:
      tags:
        - Reports
      summary: Replace a recurring report configuration
      description: >-
        Replaces a WEEKLY or MONTHLY report through the native authorized
        settings operation. ONDEMAND report edits are not supported. Uses the
        existing destination validation and schedule ownership checks. Send
        TEAMS with channel "[REDACTED]" to keep the saved Teams webhook.
      operationId: update_report
      parameters:
        - name: report_id
          in: path
          required: true
          schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
      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.
                name:
                  type: string
                  maxLength: 255
                time:
                  type: string
                  maxLength: 255
                timezone:
                  type: string
                  maxLength: 255
                parameters:
                  type: array
                  maxItems: 7
                  items:
                    type: object
                    properties:
                      parameter:
                        enum:
                          - REPOSITORY
                          - LABEL
                          - TEAM
                          - USER
                          - SOURCEBRANCH
                          - TARGETBRANCH
                          - STATE
                        type: string
                      operator:
                        enum:
                          - IN
                          - ALL
                          - NOT_IN
                        type: string
                      values:
                        type: array
                        maxItems: 1000
                        items:
                          type: string
                          maxLength: 1024
                    required:
                      - parameter
                      - operator
                      - values
                group:
                  enum:
                    - NONE
                    - REPOSITORY
                    - LABEL
                    - TEAM
                    - USER
                    - SOURCEBRANCH
                    - TARGETBRANCH
                    - STATE
                  type: string
                subgroup:
                  enum:
                    - NONE
                    - REPOSITORY
                    - LABEL
                    - TEAM
                    - USER
                    - SOURCEBRANCH
                    - TARGETBRANCH
                    - STATE
                  type: string
                platform:
                  enum:
                    - SLACK
                    - DISCORD
                    - EMAIL
                    - TEAMS
                  type: string
                channel:
                  type: string
                  maxLength: 2048
                emails:
                  type: array
                  maxItems: 100
                  items:
                    type: string
                    maxLength: 320
                    format: email
                promptTemplate:
                  enum:
                    - Daily Standup Report
                    - Sprint Report
                    - Release Notes
                    - Organization Stats
                    - Custom
                  type: string
                prompt:
                  type: string
                  maxLength: 8192
                type:
                  anyOf:
                    - enum:
                        - WEEKLY
                    - enum:
                        - MONTHLY
                days:
                  anyOf:
                    - type: array
                      maxItems: 7
                      items:
                        type: integer
                        minimum: 0
                        maximum: 6
                    - type: array
                      maxItems: 31
                      items:
                        type: integer
                        minimum: 1
                        maximum: 31
                frequency:
                  enum:
                    - '1'
                    - '2'
                    - '3'
                    - '4'
                  type: string
              required:
                - name
                - time
                - timezone
                - parameters
                - emails
                - promptTemplate
                - type
                - days
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  report_id:
                    type: string
                required:
                  - report_id
        '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.