> ## 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.

# Create a new branch



## OpenAPI

````yaml /openapi/customer-api.json post /project/{projectId}/branch
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:
    post:
      tags:
        - Branches
      summary: Create a new branch
      operationId: BranchController_create
      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
        - description: Workspace identifier
          in: header
          name: customer
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBranchDto'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BranchCreatedDto'
          description: ''
      security:
        - api-key: []
        - bearer: []
components:
  schemas:
    CreateBranchDto:
      properties:
        branch_number:
          minimum: 1
          type: number
        branch_number_reservation:
          format: uuid
          type: string
        description:
          type: string
        is_variant:
          type: boolean
        labels:
          description: >-
            Branch tags to assign when the branch is created. Existing project
            tag names reuse their fixed casing, colour, and symbol.
          items:
            $ref: '#/components/schemas/BranchTagInputDto'
          maxItems: 20
          type: array
        name:
          type: string
        parent_id:
          type: string
        ready_for_review:
          type: boolean
      type: object
    BranchCreatedDto:
      properties:
        id:
          type: string
        number:
          type: number
      required:
        - id
        - number
      type: object
    BranchTagInputDto:
      properties:
        color:
          description: >-
            Required only when creating a new project tag; omitted when
            assigning an existing tag by text.
          enum:
            - '#f5f5f4'
            - '#fee2e2'
            - '#ffedd5'
            - '#fef3c7'
            - '#fef9c3'
            - '#ecfccb'
            - '#dcfce7'
            - '#d1fae5'
            - '#ccfbf1'
            - '#cffafe'
            - '#e0f2fe'
            - '#dbeafe'
            - '#e0e7ff'
            - '#ede9fe'
            - '#f3e8ff'
            - '#fae8ff'
            - '#fce7f3'
            - '#ffe4e6'
          example: '#dbeafe'
          type: string
        symbol:
          description: >-
            Required only when creating a new project tag. Use an empty string
            for no icon.
          enum:
            - ''
            - CircleSmallIcon
            - CircleIcon
            - CircleDotIcon
            - CircleCheckIcon
            - CircleXIcon
            - CircleAlertIcon
            - CircleQuestionMarkIcon
            - CircleMinusIcon
            - CircleDashedIcon
            - CheckIcon
            - XIcon
            - AlertTriangleIcon
            - InfoIcon
            - BanIcon
            - FlameIcon
            - ZapIcon
            - StarIcon
            - HeartIcon
            - ThumbsUpIcon
            - ThumbsDownIcon
            - ArrowUpIcon
            - ArrowDownIcon
            - FlagIcon
            - FlagTriangleLeftIcon
            - BookmarkIcon
            - BookmarkCheckIcon
            - DiamondIcon
            - HexagonIcon
            - PlayIcon
            - PauseIcon
            - ClockIcon
            - LockIcon
            - EyeIcon
            - ShieldCheckIcon
            - ShieldAlertIcon
            - TagIcon
            - TicketIcon
            - ClipboardCheckIcon
            - FileTextIcon
            - UserIcon
          type: string
        text:
          maxLength: 64
          type: string
      required:
        - text
      type: object
  securitySchemes:
    api-key:
      in: header
      name: X-API-Key
      type: apiKey
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````