Skip to main content
PUT
/
v1
/
simulation
/
scenario
/
{scenarioId}
JavaScript
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 simulationScenario = await client.simulationScenario.update('scenarioId', {
  stepChanges: [
    {
      action: 'create',
      content: 'content',
      type: 'AGENT_TURN',
    },
  ],
});

console.log(simulationScenario.data);
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "steps": [
      {
        "nodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "START",
        "content": "<string>",
        "dtmfDigits": "<string>"
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
scenarioId
string
required

The ID of the scenario to update

Body

application/json

Input for updating an existing scenario

​
stepChanges
(CreateStepChange · object | UpdateStepChange · object | DeleteStepChange · object)[]
required

List of step changes to apply to the scenario

Create a new step in the scenario

​
name
string

New name for the scenario (updates the START node content)

Minimum string length: 1

Response

The updated scenario

​
data
object
required