Update a system environment

PATCH

/api-catalog/system-environments/:systemEnvironmentId

PATCH

/api-catalog/system-environments/:systemEnvironmentId

$ curl -X PATCH https://api.postman.com/api-catalog/system-environments/23b554c1-c30c-483d-bf98-dbe9ab7b88a0 \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "US-BETA",
>   "description": "This is a beta environment for testing US data center.",
>   "color": "#FFFFFF",
>   "isProduction": false
> }'

1 {
2   "data": {
3     "id": "23b554c1-c30c-483d-bf98-dbe9ab7b88a0",
4     "name": "US-BETA",
5     "label": "beta-testing",
6     "color": "#FFFFFF",
7     "description": "This is a beta environment for testing US data center.",
8     "isProduction": false,
9     "createdAt": "2026-02-23T06:24:16.000Z",
10     "updatedAt": "2026-03-30T09:02:37.190Z"
11   }
12 }

Updates a system environment’s information. You can update one or more fields in a single call.

Note:

If you update the name, it must be unique within the team.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

systemEnvironmentIdstringRequired

The system environment's ID.

Request

This endpoint expects an object.

namestringOptional1-255 characters

The system environment's name. This value must be unique within the team.

descriptionstringOptional<=500 characters

A description of the system environment. To remove a description, pass this value as an empty string.

colorstringOptionalformat: "^#[0-9A-Fa-f]{6}$"

A six-digit hex color code.

isProductionbooleanOptional

If true, the system environment is a production environment.

Response

Successful Response

dataobject

Information about the system environment.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error