Skip to main content
PATCH
/
workflows
/
v1
/
simulations
/
{simulation_id}
Update Simulation
curl --request PATCH \
  --url https://api-qa.interactly.ai/workflows/v1/simulations/{simulation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "simulation": {
    "team_id": "<string>",
    "created_by": "<string>",
    "updated_by": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "_id": "5eb7cf5a86d9755df3a6c593",
    "simulation_config": {
      "logical_id": "<string>",
      "description": "<string>",
      "selected_workflow": {
        "workflow_id": "<string>",
        "dynamic_variables": {},
        "name": "<string>",
        "total_events": 0,
        "total_nodes": 0,
        "total_duration_seconds": 0,
        "run_id": "<string>"
      },
      "counter_workflow": {
        "workflow_id": "<string>",
        "dynamic_variables": {},
        "name": "<string>",
        "total_events": 0,
        "total_nodes": 0,
        "total_duration_seconds": 0,
        "run_id": "<string>"
      },
      "timeout_seconds": 123,
      "max_events": 500,
      "number_of_simulations": 1,
      "stop_on_failure": false,
      "status": "pending"
    }
  }
}

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

simulation_id
string
required
Required string length: 24
Example:

"5eb7cf5a86d9755df3a6c593"

Body

application/json

The body is of type Body · object.

Response

Successful Response

Response model for a single simulation. Contains a SimulationsModel object.

simulation
SimulationsModel · object
required

Single simulation object