Simulation Run Plan

Update a run plan

Updates an existing simulation run plan by its ID.

put/v1/simulation/plan/{planId}

Path parameters

planIdstring uuid required

The ID of the run plan to update

Request body

isHiddenboolean

Whether this plan is hidden from GET /v1/simulation/plan.

A run started without saveAsPlan creates a hidden plan to carry it. Send { "name": "...", "isHidden": false } to keep that configuration as a reusable plan, which is what the app does when you save a one-off run.

namestring

Name of the run plan

descriptionstring

Description of the run plan

direction'INBOUND' | 'OUTBOUND'

Direction of the simulation (INBOUND or OUTBOUND)

iterationCountinteger

Number of iterations to run for each test case (1-10000)

maxConcurrentJobsinteger

Maximum number of concurrent simulation jobs

maxSimulationDurationSecondsinteger

Maximum duration in seconds for each simulation

silenceTimeoutSecondsinteger

Timeout in seconds for silence detection

endCallPhrasesstring[]

Phrases that trigger end of call. Empty array disables the feature.

endCallReasonsstring[]

Semantic conditions that trigger end of call. The LLM evaluates the conversation against these conditions. Empty array disables the feature.

executionMode'PARALLEL' | 'SEQUENTIAL_SAME_RUN_PLAN' | 'SEQUENTIAL_PROJECT'

Execution mode (PARALLEL or SEQUENTIAL)

Example request

{
  "scenarios": [
    {
      "variables": {
        "customerName": "John Doe",
        "appointmentDate": "2024-02-15"
      }
    }
  ],
  "flows": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "happyPath": true,
      "edgeCases": [
        {
          "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "variables": {
            "tier": "premium"
          }
        }
      ]
    }
  ]
}

Response

The updated run plan

Example response

{
  "data": {
    "scenarios": [
      {
        "variables": {
          "customerName": "John Doe",
          "appointmentDate": "2024-02-15"
        }
      }
    ],
    "flows": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "happyPath": true,
        "edgeCases": [
          {
            "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "variables": {
              "tier": "premium"
            }
          }
        ]
      }
    ]
  }
}

Changes

Changed in 2 of the 105 revisions of this API.119

Aug 17, 2026887b091b3d81118See the full diff
- ●
  the iterationCount request property's max was set to 10000.00
  request-property-max-set
- ●
  added the new conflict enum value to the type response property for the response status 400
  response-property-enum-value-added
- ●
  added the new conflict enum value to the type response property for the response status 401
  response-property-enum-value-added
- ●
  added the new conflict enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new conflict enum value to the type response property for the response status 429
  response-property-enum-value-added
- ●
  added the new conflict enum value to the type response property for the response status 500
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 400
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 401
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 429
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 500
  response-property-enum-value-added
- ○
  added the new optional request property flows
  new-optional-request-property
- ○
  added the new optional request property isHidden
  new-optional-request-property
- ○
  added the new optional request property metrics/items/metricId
  new-optional-request-property
- ○
  added the new optional request property metrics/items/slug
  new-optional-request-property
- ○
  the request property metrics/items/id became optional
  request-property-became-optional
- ○
  request property scenarios deprecated
  request-property-deprecated
- ○
  response property data/scenarios deprecated
  response-property-deprecated
- ○
  added the required property data/flows to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 20, 2026a1a7faf3a53b1See the full diff
- ○
  added the optional property data/scenarios/items/variables to the response with the 200 status
  response-optional-property-added

Full history