Update an environment
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).
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
Input for updating an environment. Only the fields sent are changed. Roark-curated environments cannot be edited.
Display name, shown wherever a flow variant references the environment
1"Busy call centre"
Optional note on when to use this environment
"Open-plan office at peak hours"
The noise bed played underneath the simulated caller. NONE plays nothing.
NONE, AIRPORT, CHILDREN_PLAYING, CITY, COFFEE_SHOP, DRIVING, OFFICE, THUNDERSTORM "OFFICE"
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.
0 <= x <= 10.3
Response
The updated environment
A simulation environment: the ambient conditions a customer flow variant runs under. The list includes both your own and the ones Roark curates for every project.