---
title: "Update a simulation suite"
method: PUT
path: "/simulation_suites/{suite_id}"
tags: [""]
---

# Update a simulation suite

`PUT /simulation_suites/{suite_id}`

Update an existing simulation suite.

## Path parameters

- `suite_id` string, required

## Headers

- `Authorization` string, required

## Request body

- SimulationSuiteUpdateIn
  - `name` string, nullable — New name for the simulation suite
  - `model_id` string, nullable — New agent model ID for the suite

## Response `200`

200

- UpdateSimulationSuiteResponse200
  - `status` string — Whether the request was successful.
  - `response` SimulationSuiteReadOut
    - `id` string, uuid — Unique identifier for the simulation suite
    - `name` string — Name of the simulation suite
    - `model_id` string — Agent model ID this suite is for
    - `workspace_id` string — Workspace ID this suite belongs to
    - `language` string — Language locale for the persona agent and test cases (e.g., 'en-US', 'es-ES', 'fr-FR')
    - `cases` SimulationCaseReadOut[] — Test cases included in this suite
      - `simulation_case_id` string, uuid
      - `workspace_id` string
      - `suite_id` string, uuid, nullable — ID of the simulation suite this case belongs to.
      - `name` string
      - `prompt` string
      - `type` 'custom' | 'agent_based'
      - `success_criteria` string[]
      - `call_success_type` 'all' | 'any'
      - `base_agent` SimulationCaseReadOutBaseAgent
        - `model_id` string
        - `agent_name` string
        - `agent_type` string
        - `voice_engine_type` string
        - `phone_number` string, nullable
        - `updated_at` string, date-time
        - `image_url` string, nullable
      - `created_at` string, date-time
      - `updated_at` string, date-time
    - `agent` AgentListItem
      - `id` string, uuid
      - `name` string
      - `avatar` string, nullable
    - `created_at` string, date-time — When the suite was created
    - `updated_at` string, date-time — When the suite was last updated

## Other responses

- `400` — 400
- `404` — 404

---

[API](https://skmtc.net/synthflow/apis/platform-api.md) · [All operations](https://skmtc.net/synthflow/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synthflow/platform-api/versions/decb652b52e0/schema)