​
Update Critical Workflow Metric Scenario API

Update the priority of an existing critical workflow metric scenario.

​
API Endpoint

MethodEndpoint
PATCHhttps://new-prod.vocera.ai/test_framework/v1/critical-metric-scenarios-external/:critical-scenario-id/

​
Authentication

Include your API key in the request headers:

HeaderDescription
X-VOCERA-API-KEYYour API key obtained from the dashboard

​
URL Parameters

ParameterTypeRequiredDescription
critical-scenario-idintegerYesThe ID of the critical workflow metric scenario to update

​
Request Parameters

ParameterTypeRequiredDescription
prioritystringYesNew priority level for the scenario. Can be one of: “high”, “medium”, “low” or “not_a_bug”

​
Example Request Body

{

    "priority": "low"

}

​
Response Format

The API returns the updated critical workflow metric scenario details.

​
Response Fields

FieldTypeDescription
idintegerUnique identifier for the critical scenario
scenariostringDescription of the critical workflow scenario
prioritystringUpdated priority level

​
Example Response

{

    "id": 30,

    "scenario": "The AI agent failed to inform the caller about the clinic's closure and did not offer a telemedicine appointment.",

    "priority": "low"

}

​
Code Examples

curl -X PATCH https://new-prod.vocera.ai/test_framework/v1/critical-metric-scenarios-external/{critical_scenario_id}/ \

  -H "X-VOCERA-API-KEY: <your-api-key-here>" \

  -H "Content-Type: application/json" \

  -d '{

    "priority": "low"

  }'