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

# Toggle the branch’s ready-for-review signal



## OpenAPI

````yaml /openapi/customer-api.json post /project/{projectId}/branch/{id}/set-ready-for-review
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Flow customer API reference. Start with the [quickstart](/api/quickstart)
    and [authentication guide](/api/authentication).
  title: Customer API
  version: 1.0.0
servers:
  - description: Flow API
    url: https://backend.branch.flowengineering.com
security: []
tags:
  - name: Automations
  - name: Branches
  - name: Comments
  - name: Convert
  - name: Data Model
  - name: Diagrams
  - name: Entities
  - name: Files
  - name: Import
  - name: Notifications
  - name: Projects
  - name: ReqIF
  - name: ReqIF Import
  - name: Shared Access Grants
  - name: User Groups
  - name: Users
paths:
  /project/{projectId}/branch/{id}/set-ready-for-review:
    post:
      tags:
        - Branches
      summary: Toggle the branch’s ready-for-review signal
      operationId: BranchController_setReadyForReview
      parameters:
        - in: path
          name: projectId
          required: true
          schema:
            description: >-
              Project UUID, not a slug. Resolve a slug with GET
              /project/slug/{slug} using the same workspace and credentials,
              then pass the returned id.
            type: string
        - in: path
          name: id
          required: true
          schema:
            type: string
        - description: Workspace identifier
          in: header
          name: customer
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetReadyForReviewDto'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BranchResponseDto'
          description: ''
      security:
        - api-key: []
        - bearer: []
components:
  schemas:
    SetReadyForReviewDto:
      properties: {}
      type: object
    BranchResponseDto:
      properties:
        baseline_id:
          nullable: true
          type: string
        branch_extraction_enabled:
          type: boolean
        change_request_diff_summary:
          $ref: '#/components/schemas/ChangeRequestDiffSummaryDto'
        change_request_title:
          nullable: true
          type: string
        comment_count:
          type: number
        created_at:
          type: string
        created_by_id:
          nullable: true
          type: string
        description:
          type: string
        designated_reviewer_ids:
          items:
            type: string
          type: array
        editor_group_ids:
          items:
            type: string
          type: array
        has_children:
          type: boolean
        id:
          type: string
        is_deleted:
          type: boolean
        is_iteration:
          type: boolean
        is_protected:
          type: boolean
        is_variant:
          type: boolean
        labels:
          items:
            $ref: '#/components/schemas/BranchLabelDto'
          type: array
        last_rebased_at:
          nullable: true
          type: string
        last_touched_at:
          nullable: true
          type: string
        merged_at:
          nullable: true
          type: string
        name:
          type: string
        number:
          type: number
        owner_id:
          nullable: true
          type: string
        parent:
          nullable: true
          type: string
        parent_name:
          nullable: true
          type: string
        ready_for_review:
          type: boolean
        require_review:
          type: boolean
        required_reviewer_ids:
          items:
            type: string
          type: array
        reviews:
          items:
            $ref: '#/components/schemas/BranchReviewResponseDto'
          type: array
        updated_at:
          type: string
        updated_by_id:
          nullable: true
          type: string
        upstream_branch_ids:
          items:
            type: string
          type: array
      required:
        - id
        - name
        - number
        - is_iteration
        - description
        - is_variant
        - parent_name
        - created_at
        - updated_at
        - is_protected
        - require_review
        - ready_for_review
        - owner_id
        - created_by_id
        - updated_by_id
        - last_touched_at
        - last_rebased_at
        - required_reviewer_ids
        - editor_group_ids
        - labels
        - upstream_branch_ids
        - merged_at
        - is_deleted
        - has_children
      type: object
    ChangeRequestDiffSummaryDto:
      properties:
        added:
          type: number
        pending:
          type: number
        removed:
          type: number
        updated:
          type: number
      required:
        - added
        - updated
        - removed
        - pending
      type: object
    BranchLabelDto:
      properties:
        color:
          example: '#dbeafe'
          type: string
        symbol:
          description: >-
            Stored symbol. New tags use a fixed Lucide icon name, but reads can
            include legacy symbols.
          maxLength: 32
          type: string
        text:
          maxLength: 64
          type: string
      required:
        - text
        - color
        - symbol
      type: object
    BranchReviewResponseDto:
      properties:
        branch_id:
          type: string
        comment_id:
          nullable: true
          type: string
        created_at:
          type: string
        dismissed_at:
          nullable: true
          type: string
        id:
          type: string
        status:
          enum:
            - Approved
            - Rejected
          type: string
        updated_at:
          type: string
        user_id:
          type: string
      required:
        - id
        - branch_id
        - user_id
        - status
        - comment_id
        - created_at
        - updated_at
        - dismissed_at
      type: object
  securitySchemes:
    api-key:
      in: header
      name: X-API-Key
      type: apiKey
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````