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);
import os
from roark_analytics import Roark

client = Roark(
    bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
)
simulation_scenario = client.simulation_scenario.update(
    scenario_id="scenarioId",
    step_changes=[{
        "action": "create",
        "content": "content",
        "type": "AGENT_TURN",
    }],
)
print(simulation_scenario.data)
curl --request PUT \
  --url https://api.roark.ai/v1/simulation/scenario/{scenarioId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "stepChanges": [
    {
      "action": "<string>",
      "content": "<string>",
      "linkedScenarioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dtmfDigits": "<string>",
      "silenceDurationSeconds": 123
    }
  ],
  "name": "<string>"
}
'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roark.ai/v1/simulation/scenario/{scenarioId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'stepChanges' => [
        [
                'action' => '<string>',
                'content' => '<string>',
                'linkedScenarioId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'dtmfDigits' => '<string>',
                'silenceDurationSeconds' => 123
        ]
    ],
    'name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.roark.ai/v1/simulation/scenario/{scenarioId}"

	payload := strings.NewReader("{\n  \"stepChanges\": [\n    {\n      \"action\": \"<string>\",\n      \"content\": \"<string>\",\n      \"linkedScenarioId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"dtmfDigits\": \"<string>\",\n      \"silenceDurationSeconds\": 123\n    }\n  ],\n  \"name\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.roark.ai/v1/simulation/scenario/{scenarioId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"stepChanges\": [\n    {\n      \"action\": \"<string>\",\n      \"content\": \"<string>\",\n      \"linkedScenarioId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"dtmfDigits\": \"<string>\",\n      \"silenceDurationSeconds\": 123\n    }\n  ],\n  \"name\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.roark.ai/v1/simulation/scenario/{scenarioId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"stepChanges\": [\n    {\n      \"action\": \"<string>\",\n      \"content\": \"<string>\",\n      \"linkedScenarioId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"dtmfDigits\": \"<string>\",\n      \"silenceDurationSeconds\": 123\n    }\n  ],\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "steps": [
      {
        "nodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "content": "<string>",
        "linkedScenarioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dtmfDigits": "<string>",
        "silenceDurationSeconds": 123
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}
{
  "type": "validation",
  "code": "invalid_parameter",
  "message": "The request was invalid",
  "param": "email"
}
{
  "type": "authentication",
  "code": "unauthorized",
  "message": "Authentication required"
}
{
  "type": "not_found",
  "code": "resource_not_found",
  "message": "The requested resource could not be found"
}
{
  "type": "internal",
  "code": "internal_error",
  "message": "Internal server error"
}

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