For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
AcademyContact SalesHelp CenterDashboard
DocumentationAPI ReferenceIntegrationsAdministrationChangelog
DocumentationAPI ReferenceIntegrationsAdministrationChangelog
  • Get Started
    • Introduction
    • Authentication
  • Resources
    • Custom Variables
    • Dynamic Prompt Injection
    • Outbound Number Pooling
    • Timezones
  • Platform API
      • POSTCreate a simulation case
      • GETList simulation cases
      • GETGet a simulation case
      • PUTUpdate a simulation case
      • DELDelete a simulation case
      • POSTGenerate test cases
      • GETList simulation cases by agent
      • POSTCreate a simulation suite
      • GETList simulation suites
      • GETGet a simulation suite
      • PUTUpdate a simulation suite
      • DELDelete a simulation suite
      • POSTExecute a simulation suite
      • POSTCreate a simulation scenario
      • GETList simulation scenarios
      • GETGet a simulation scenario
      • PUTUpdate a simulation scenario
      • DELDelete a simulation scenario
      • POSTStart a simulation
      • GETList simulation sessions
      • GETGet a simulation session
      • GETList simulations
      • GETGet a simulation
LogoLogo
AcademyContact SalesHelp CenterDashboard
Platform APISimulations

Update a simulation case

||View as Markdown|
PUT
/simulation_cases/:simulation_case_id
PUT
/v2/simulation_cases/:simulation_case_id
$curl -X PUT https://api.synthflow.ai/v2/simulation_cases/9ad09ad3-9c22-441e-ae35-c05016a09786 \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{
> "name": "Updated Customer Support Test",
> "success_criteria": [
> "Agent resolves issue within 5 minutes"
> ],
> "suite_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
>}'
1{
2 "status": "ok",
3 "response": {
4 "simulation_case_id": "9ad09ad3-9c22-441e-ae35-c05016a09786",
5 "name": "Updated Customer Support Test"
6 }
7}
Update an existing simulation case.
Was this page helpful?
Previous

Delete a simulation case

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

simulation_case_idstringRequired
Simulation case ID.

Request

This endpoint expects an object.
namestring or nullOptional
promptstring or nullOptional
success_criterialist of strings or nullOptional
call_success_typeenum or nullOptional
Allowed values:
suite_idstring or nullOptionalformat: "uuid"
ID of the simulation suite to assign this case to.

Response

200
statusstring
Whether the request was successful.
responseobject
Simulation case details.

Errors

400
Bad Request Error
404
Not Found Error
422
Unprocessable Entity Error