PATCH
/
test_framework
/
v1
/
scenarios-external
/
{id}
curl --request PATCH \
  --url https://new-prod.vocera.ai/test_framework/v1/scenarios-external/{id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-VOCERA-API-KEY: <api-key>' \
  --data '{
  "agent": 123,
  "assistant_id": "<string>",
  "name": "<string>",
  "personality": 123,
  "instructions": "<string>",
  "expected_outcome_prompt": "<string>",
  "metrics": {}
}'
{
  "id": 123,
  "name": "<string>",
  "agent": 123,
  "personality": 123,
  "personality_name": "<string>",
  "tags": "<any>",
  "runs": "<string>",
  "metric_names": "<string>",
  "phone_number": "<string>",
  "first_message": "<string>",
  "inbound_phone_number": 123,
  "inbound_phone_number_data": {
    "id": 123,
    "number": "<string>",
    "phone_number_id": "<string>"
  },
  "instructions": "<string>",
  "simulation_description": "<string>",
  "information_fields": "<any>",
  "expected_outcome_prompt": "<string>",
  "scenario_language": "ar"
}

Authorizations

​
X-VOCERA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Path Parameters

​
id
string
required

Body

​
agent
integer

ID of the AI agent this scenario belongs to

​
assistant_id
string

Alternative to agent ID - the assistant ID to use for this scenario

​
name
string
Maximum length: 80
​
personality
integer

The personality of the scenario

​
instructions
string
​
expected_outcome_prompt
string
​
metrics
object

List of metric IDs to associate with this scenario

Response

200
application/json
​
id
integer
required
​
personality_name
string
required

Name of the personality used in this scenario

​
runs
string
required

List of IDs for the last run of this scenario

​
metric_names
string
required

List of metric names associated with this scenario

​
phone_number
string
required

Phone number used for outbound calls in this scenario

​
inbound_phone_number_data
object
required

Details of the phone number used for inbound calls

​
name
string
Maximum length: 80
​
agent
integer

ID of the AI agent this scenario belongs to

​
personality
integer | null
​
tags
any
​
first_message
string
Maximum length: 1000
​
inbound_phone_number
integer | null
​
instructions
string
​
simulation_description
string
​
information_fields
any
​
expected_outcome_prompt
string
​
scenario_language
enum<string>

Language of the scenario

  • ar - Arabic
  • bg - Bulgarian
  • zh - Chinese Simplified
  • cs - Czech
  • da - Danish
  • nl - Dutch
  • en - English
  • fi - Finnish
  • fr - French
  • de - German
  • el - Greek
  • hi - Hindi
  • hu - Hungarian
  • id - Indonesian
  • it - Italian
  • ja - Japanese
  • ko - Korean
  • ms - Malay
  • no - Norwegian
  • pl - Polish
  • pt - Portuguese
  • ro - Romanian
  • ru - Russian
  • sk - Slovak
  • es - Spanish
  • sv - Swedish
  • tr - Turkish
  • uk - Ukrainian
  • vi - Vietnamese
Available options:
ar,
bg,
zh,
cs,
da,
nl,
en,
fi,
fr,
de,
el,
hi,
hu,
id,
it,
ja,
ko,
ms,
no,
pl,
pt,
ro,
ru,
sk,
es,
sv,
tr,
uk,
vi