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

# Update a plan group

> Edits a saved simulation group. Omitted fields keep their current value; `notifications`,
when sent, replaces the settings as a whole. Run groups it already started keep theirs.

A group managed by config as code (`configManaged: true`) returns 409: change it in the config file.



## OpenAPI

````yaml /api-reference/openapi.documented.json put /v1/simulation/group/{groupId}
openapi: 3.1.0
info:
  title: Roark Analytics API
  description: >-
    The Roark Analytics API gives you access to the same API that powers the
    award winning Roark Analytics platform.
  version: 1.0.0
servers:
  - description: Production
    url: https://api.roark.ai
security:
  - Bearer: []
tags:
  - name: Health
    x-displayName: Health
  - name: Authentication
    x-displayName: Current credential
  - name: Project API Key
    x-displayName: Project API keys
  - name: Personal API Key
    x-displayName: Personal API keys
  - name: Agent
    x-displayName: Agents
  - name: Agent Endpoint
    x-displayName: Endpoints
  - name: Tool
    x-displayName: Tools
  - name: Agent Setup
    x-displayName: Automatic test setup
  - name: Autoimprove
    x-displayName: Autoimprove
  - name: Customer Flow
    x-displayName: Customer flows
  - name: Customer Flow Folder
    x-displayName: Customer flow folders
  - name: Simulation Persona
    x-displayName: Personas
  - name: Simulation Environment
    x-displayName: Environments
  - name: Simulation Template
    x-displayName: Templates
  - name: Simulation Run Plan
    x-displayName: Plans
  - name: Simulation Run
    x-displayName: Runs
  - name: Simulation Tool Mock
    x-displayName: Tool mocks and fixtures
  - name: Metric
    x-displayName: Definitions
  - name: Metric Variant
    x-displayName: Variants
  - name: Metric Policy
    x-displayName: Policies
  - name: Metric Collection Job
    x-displayName: Collection jobs
  - name: Call
    x-displayName: Calls
  - name: Chat
    x-displayName: Chats
  - name: Customer
    x-displayName: Customers
  - name: Issue
    x-displayName: Issues
  - name: Analytics
    x-displayName: Analytics
  - name: Dashboard
    x-displayName: Dashboards
  - name: Live Report
    x-displayName: Reports
  - name: Agent Connection
    x-displayName: Agent platforms
  - name: Calendar Connection
    x-displayName: Calendars
  - name: MCP Server Connection
    x-displayName: MCP servers
  - name: Knowledge Base
    x-displayName: Knowledge bases
  - name: HTTP Request Definition
    x-displayName: HTTP request definitions
  - name: Webhook
    x-displayName: Webhooks
  - name: Config
    x-displayName: Config as code
  - name: Organization Project
    x-displayName: Projects
  - name: Organization Project Member
    x-displayName: Project members
  - name: Usage
    x-displayName: Usage
  - name: Benchmark
    x-displayName: Benchmarks
paths:
  /v1/simulation/group/{groupId}:
    put:
      tags:
        - Simulation Run Plan
      summary: Update a plan group
      description: >-
        Edits a saved simulation group. Omitted fields keep their current value;
        `notifications`,

        when sent, replaces the settings as a whole. Run groups it already
        started keep theirs.


        A group managed by config as code (`configManaged: true`) returns 409:
        change it in the config file.
      operationId: putV1SimulationGroupByGroupId
      parameters:
        - name: groupId
          in: path
          required: true
          description: The simulation group ID
          schema:
            type: string
            format: uuid
          example: 2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSimulationGroupInput'
      responses:
        '200':
          description: The updated group
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SimulationGroup'
                required:
                  - data
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Validation error
              example:
                type: validation
                code: invalid_parameter
                message: The request was invalid
                param: email
          description: Invalid input, or Slack channels without Slack connected
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Simulation group or a plan not found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Conflict error
              example:
                type: conflict
                code: resource_in_use
                message: The resource is in use and cannot be deleted
          description: The group is managed by config as code
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Rate limit error
              example:
                type: rate_limit
                code: too_many_requests
                message: Rate limit exceeded
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Roark from '@roarkanalytics/sdk';


            const client = new Roark({
              bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
            });


            const simulationGroup = await
            client.simulationGroup.update('2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d');


            console.log(simulationGroup.data);
        - lang: Python
          source: |-
            import os
            from roark_analytics import Roark

            client = Roark(
                bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
            )
            simulation_group = client.simulation_group.update(
                group_id="2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d",
            )
            print(simulation_group.data)
components:
  schemas:
    UpdateSimulationGroupInput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 200
        description:
          type:
            - string
            - 'null'
          maxLength: 2000
          description: Send null to clear it.
        simulationRunPlanIds:
          type: array
          items:
            type: string
            format: uuid
          minItems: 2
          maxItems: 20
          description: Replaces the plans, in run order.
        notifications:
          $ref: '#/components/schemas/SimulationGroupNotificationsInput'
          description: Replaces the notification settings as a whole.
      additionalProperties: false
      description: >-
        Omitted fields keep their current value. Run groups the group already
        started keep theirs.
      example:
        simulationRunPlanIds:
          - 3c1d2e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f
          - 6d7e8f9a-0b1c-4d2e-9f3a-4b5c6d7e8f9a
    SimulationGroup:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        configManaged:
          type: boolean
          description: >-
            Whether this group is managed by config as code. A managed group can
            be run here, but PUT and DELETE on it return 409: change it in the
            config file.
        plans:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                description: The plan, readable at GET /v1/simulation/plan/{planId}
              name:
                type: string
            required:
              - id
              - name
          description: >-
            The plans in run order. A plan deleted since it was added is left
            out.
        notifications:
          type: object
          properties:
            email:
              type: object
              properties:
                enabled:
                  type: boolean
                recipients:
                  type: array
                  items:
                    type: string
              required:
                - enabled
                - recipients
            slack:
              type: array
              items:
                type: object
                properties:
                  channelId:
                    type: string
                  channelName:
                    type: string
                required:
                  - channelId
                  - channelName
          required:
            - email
            - slack
          description: Where each run's group report announces itself once it is ready.
        lastRunAt:
          type:
            - string
            - 'null'
          description: ISO 8601. Null when it has never run.
        latestRunGroupId:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            The most recent run group it started, readable at `GET
            /v1/simulation/run-group/{groupId}`. Null when it has never run.
        createdAt:
          type: string
          description: ISO 8601
        updatedAt:
          type: string
          description: ISO 8601
      required:
        - id
        - name
        - description
        - configManaged
        - plans
        - notifications
        - lastRunAt
        - latestRunGroupId
        - createdAt
        - updatedAt
      description: >-
        A saved, repeatable set of plans that run together. Each run starts one
        run of every plan and groups them into a run group with one combined
        report.
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation
            - authentication
            - forbidden
            - not_found
            - conflict
            - payment_required
            - rate_limit
            - internal
          description: The error type category
          examples:
            - validation
            - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
            - invalid_parameter
            - missing_required_field
            - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
            - The request was invalid
            - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
            - email
            - user_id
        details:
          description: Additional error context information
      required:
        - type
        - code
        - message
    SimulationGroupNotificationsInput:
      type: object
      properties:
        email:
          type: object
          properties:
            enabled:
              type: boolean
              description: Whether each run's group report is emailed when it is ready.
            recipients:
              type: array
              items:
                type: string
                format: email
              maxItems: 50
              default: []
              description: >-
                Addresses to email (at most 50), Roark users or not: the email
                attaches the report PDF. Empty emails every member of the
                project.
              example:
                - qa-lead@example.com
          required:
            - enabled
          additionalProperties: false
          default:
            enabled: true
            recipients: []
        slack:
          type: array
          items:
            type: object
            properties:
              channelId:
                type: string
                minLength: 1
                description: The Slack channel id
                example: C07ABCDEF12
              channelName:
                type: string
                minLength: 1
                description: The channel name, shown in Roark
                example: qa-reports
            required:
              - channelId
              - channelName
            additionalProperties: false
          maxItems: 10
          default: []
          description: >-
            Channels in the project's connected Slack workspace to post the
            report to (at most 10). Slack must be connected to the project
            first.
      additionalProperties: false
      description: Where each run's group report announces itself once it is ready.
      example:
        email:
          enabled: true
          recipients: []
        slack:
          - channelId: C07ABCDEF12
            channelName: qa-reports
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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