Skip to navigation
Management APIReferenceScenarios

SetScenarioInfo

View as Markdown

Edits the scenario. You can edit the scenario’s name and body. Please use the POST method.

Allowed roles: Owner, Admin, Developer.

Example request: Add a new scenario: var s=‘hello’;

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

scenario_idintegerOptional

Scenario ID. Required unless required_scenario_name is provided.

required_scenario_namestringOptional

Name of the scenario to edit. Required unless scenario_id is provided.

scenario_namestringOptional
New scenario name. The length must be less than 30
scenario_scriptstringOptional

New scenario text. Use the application/x-www-form-urlencoded content type with UTF-8 encoding. The length must be less than 128 KB

Response

Successful response
resultintegerOptional
Returns 1 if the request has been completed successfully