PATCH /environments/{environment_id}

Update an Environment by ID

Servers

Path parameters

Name Type Required Description
environment_id Integer Yes

The unique identifier for the Environment

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
priority Integer No

Integer representing the priority of the Environment. This is used for ordering in the UI.

name String No

Name of the Environment.

archived Boolean No

Boolean representing whether the Environment is archived.

description String No

Text description of the Environment.

key String No

Unique string identifier for this Environment within the Project.

has_restricted_permissions Boolean No

Boolean representing whether starting experiments should be restricted to publishers and above in this Environment.

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.