Update an environment

PATCH

/environments/:environmentId

PATCH

/environments/:environmentId

$ curl -X PATCH https://api.getpostman.com/environments/5daabc50-8451-43f6-922d-96b403b4f28e \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '[
>   {
>     "op": "add",
>     "path": "/values/1",
>     "value": {
>       "description": "The collection'\''s ID.",
>       "enabled": true,
>       "key": "collectionId",
>       "type": "default",
>       "value": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"
>     }
>   }
> ]'

1 {
2   "environment": {
3     "id": "5daabc50-8451-43f6-922d-96b403b4f28e",
4     "name": "Test API Environment",
5     "owner": "12345678",
6     "createdAt": "2025-03-10T15:37:00.000Z",
7     "updatedAt": "2025-03-10T15:56:19.000Z",
8     "values": [
9       {
10         "enabled": true,
11         "key": "x-api-key",
12         "value": "{{x-api-key}}",
13         "type": "secret"
14       },
15       {
16         "enabled": true,
17         "key": "collectionId",
18         "value": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2",
19         "type": "default",
20         "description": "The collection's ID."
21       }
22     ],
23     "uid": "12345678-5daabc50-8451-43f6-922d-96b403b4f28e"
24   }
25 }

Updates specific environment properties, such as its name and variables.

Note:

You can only perform one type of operation at a time. For example, you cannot perform an add and replace operation in the same call.
The request body size cannot exceed the maximum allowed size of 30MB.
If you receive an HTTP 411 Length Required error response, manually pass the Content-Length header and its value in the request header.
To add a description to an existing variable, use the add operation.

Updates specific environment properties, such as its name and variables. **Note:** - You can only perform one type of operation at a time. For example, you cannot perform an `add` and `replace` operation in the same call. - The request body size cannot exceed the maximum allowed size of 30MB. - If you receive an HTTP `411 Length Required` error response, manually pass the `Content-Length` header and its value in the request header. - To add a description to an existing variable, use the `add` operation.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

environmentIdstringRequired

The environment's ID.

Request

This endpoint expects a list of objects.

Add Variablelist of objectsRequired

Update Environment Namelist of objectsRequired

Update Variablelist of objectsRequired

Remove Variablelist of objectsRequired

Response

Successful Response

environmentobject

Information about the environment.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

411

Length Required Error

413

Content Too Large Error