---
title: "Update an environment"
method: PUT
path: "/v1/simulation/environment/{environmentId}"
tags: ["Simulation Environment"]
---

# Update an environment

`PUT /v1/simulation/environment/{environmentId}`

## Request

- Base URL: `https://api.roark.ai`
- URL: `https://api.roark.ai/v1/simulation/environment/{environmentId}`
- Auth: HTTP bearer

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).

## Path parameters

- `environmentId` string, uuid, required

## Request body

- UpdateEnvironmentInput: Input for updating an environment. Only the fields sent are changed. Roark-curated environments cannot be edited.
  - `name` string: Display name, shown wherever a flow variant references the environment
  - `description` string, nullable: Optional note on when to use this environment
  - `backgroundNoise` 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'CONSTRUCTION' | 'CRYING_BABY' | 'DRIVING' | 'LIBRARY' | 'OFFICE' | 'THUNDERSTORM' | 'TRAIN': The noise bed played underneath the simulated caller. NONE plays nothing.
  - `backgroundNoiseVolume` 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.

## Response `200`

The updated environment

- object
  - `data` EnvironmentResponse, required: 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.
    - `id` string, uuid, required
    - `name` string, required
    - `description` string, nullable
    - `backgroundNoise` 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'CONSTRUCTION' | 'CRYING_BABY' | 'DRIVING' | 'LIBRARY' | 'OFFICE' | 'THUNDERSTORM' | 'TRAIN', required
    - `backgroundNoiseVolume` number, required
    - `createdAt` string, required: Creation timestamp in ISO 8601 format
    - `updatedAt` string, required: Last update timestamp in ISO 8601 format

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

> 188 revisions in range; 1 not diffed.

- **2026-09-15** `abda85e78d9d`: 4 warning, 4 info
  - added the new `CONSTRUCTION` enum value to the `data/backgroundNoise` response property for the response status `200`
  - added the new `CRYING_BABY` enum value to the `data/backgroundNoise` response property for the response status `200`
  - added the new `LIBRARY` enum value to the `data/backgroundNoise` response property for the response status `200`
  - added the new `TRAIN` enum value to the `data/backgroundNoise` response property for the response status `200`
  - …4 more
- **2026-09-09** `7ea77678cced`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/roarkhq/apis/roark-analytics-api/changes/v1/simulation/environment/:environmentId/put.md)

---

[API](https://skmtc.dev/roarkhq/apis/roark-analytics-api.md) - [All operations](https://skmtc.dev/roarkhq/apis/roark-analytics-api/llms.txt) - [OpenAPI document](https://skmtc.dev/roarkhq/apis/roark-analytics-api/revisions/efc3377249d1?raw)