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

# Update a test group

> Update name, runMode, maxConcurrentRuns, or prepTestId on a test group.



## OpenAPI

````yaml /openapi.json patch /v1/groups/{groupId}
openapi: 3.1.0
info:
  title: TestArmy API
  version: 1.0.0
  description: >-
    AI-powered browser automation API for QA testing. Automate web testing
    workflows using natural language prompts.
servers:
  - url: https://tester.army/api
    description: Production API server
security: []
paths:
  /v1/groups/{groupId}:
    patch:
      tags:
        - Groups
      summary: Update a test group
      description: Update name, runMode, maxConcurrentRuns, or prepTestId on a test group.
      parameters:
        - schema:
            type: string
            format: uuid
            description: Test group ID
          required: true
          description: Test group ID
          name: groupId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                runMode:
                  type: string
                  enum:
                    - concurrent
                    - sequential
                maxConcurrentRuns:
                  type:
                    - integer
                    - 'null'
                  minimum: 1
                  description: Pass null to follow the plan limit again.
                prepTestId:
                  type:
                    - string
                    - 'null'
                  format: uuid
                  description: >-
                    Web test that runs first and saves its browser session. Any
                    web test in the project qualifies; it does not have to be a
                    member of this group. Pass null to clear.
      responses:
        '200':
          description: Group updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  group:
                    $ref: '#/components/schemas/GroupDetail'
                required:
                  - group
        '400':
          description: Bad Request - Invalid input parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error code or type
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - message
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error code or type
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - message
        '429':
          description: Too Many Requests - Usage limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error code or type
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - message
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error code or type
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - message
        '504':
          description: Gateway Timeout - Test execution exceeded time limit
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error code or type
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - message
      security:
        - bearerAuth: []
components:
  schemas:
    GroupDetail:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        isDefault:
          type: boolean
        runMode:
          type: string
          enum:
            - concurrent
            - sequential
        maxConcurrentRuns:
          type:
            - integer
            - 'null'
          minimum: 1
          description: >-
            Concurrent groups only: max tests executing at once per group run.
            Capped at your team's concurrent-run limit; null follows the plan
            limit.
        prepTestId:
          type:
            - string
            - 'null'
          format: uuid
        projectId:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - name
        - isDefault
        - runMode
        - maxConcurrentRuns
        - prepTestId
        - projectId
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API key authentication using Bearer token format. The CLI's `ta auth`
        access tokens are also accepted; because they name a user rather than a
        workspace, a user in several workspaces selects one with the
        `x-testerarmy-team` header (workspace id or slug).

````

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