---
title: "Patch Environment"
method: PUT
path: "/v1/accounts/{account_id}/environments/{environment_id}"
tags: ["Environments"]
---

# Patch Environment

`PUT /v1/accounts/{account_id}/environments/{environment_id}`

**Authorization scope:** `environment:edit` 
 
 **Updates an existing environment entity**

## Path parameters

- `account_id` string, required
- `environment_id` string, required

## Request body

- PatchEnvironmentInput — Patch Environment Model
  - `environment_name` string, nullable — The environment name
  - `color` 'gray.400' | 'tagGreen' | 'cBlues' | 'tagCyan' | 'tagGeekBlue' | 'cPurples' | 'tagPurple' | 'tagMagenta' | 'cOranges' | 'tagOrange' | 'yellow.200' — The EnvironmentsColor enum provides all color options for environments
  - `description` string, nullable — The environment description
  - `is_default` boolean, nullable — A flag that indicates whether the environment is the account's default environment

## Response `200`

Successful Response

- EnvironmentsFields — Environments properties to return.
  - `_id` string, required — The environment id
  - `account` string, required — The account id of the user
  - `user_created` string, nullable — The user id of the user who first created the environment
  - `created_at` union — The environment creation date time in UTC timezone. Time format YYYY-MM-DDThh:mm:ss.ms
    - string, date-time
    - string
  - `cross_id` string, required — The cross id of the environment
  - `updated_at` union — The time in which the environment was last updated (UTC time zone)
    - string, date-time
    - string
  - `environment_name` string, required — The environment name
  - `color` 'gray.400' | 'tagGreen' | 'cBlues' | 'tagCyan' | 'tagGeekBlue' | 'cPurples' | 'tagPurple' | 'tagMagenta' | 'cOranges' | 'tagOrange' | 'yellow.200' — The EnvironmentsColor enum provides all color options for environments
  - `description` string, nullable — The environment description
  - `variables` object, required — Environment's variables
  - `is_deleted` boolean, nullable — A flag that indicates whether the environment is deleted
  - `deleted_by` string, nullable — The user id of the user who deleted the environment (if the environment is deleted)
  - `deleted_at` union — The time in which the environment was deleted (if the environment is deleted). Time format YYYY-MM-DDThh:mm:ss.ms
    - string, date-time
    - string
  - `is_default` boolean — A flag that indicates whether the environment is the account's default environment
  - `updated_by` string, nullable — The user id of the user who last updated the environment
  - `is_delete_lock` boolean, nullable — A flag that indicates the environment deletion progress

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/rivery/apis/boomi-data-integration-api.md) · [All operations](https://skmtc.net/rivery/apis/boomi-data-integration-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rivery/boomi-data-integration-api/revisions/cc19ddc41c6e/schema)