Skip to main content
Updates one of the project’s environments. Only the fields sent are changed. Runs already built keep the snapshot they were built with. Roark-curated environments cannot be edited (403).
Calls PUT /v1/simulation/environment/{environmentId}

​
Arguments

​
string
required
The environment-id.

​
Options

​
string
Display name, shown wherever a flow variant references the environment.
​
string
Optional note on when to use this environment.
​
string
The noise bed played underneath the simulated caller. NONE plays nothing. One of NONE, AIRPORT, CHILDREN_PLAYING, CITY, COFFEE_SHOP, CONSTRUCTION, CRYING_BABY, DRIVING, LIBRARY, OFFICE, THUNDERSTORM, TRAIN
​
number
How loud the bed plays, as a gain from 0 (silent) to 1 (as loud as the caller). Defaults to 0.1, which sits well under the caller. Ignored on Vapi endpoints, which have no level control.

​
Example

Every command also takes the global options and sets one of the exit codes.