Sign in
Environments

Update an environment

Updates the specified environment by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

patch/v3/environments/{id}

Path parameters

idstring uuid required

Unique identifier for the environment.

Request body

namestring nullable

Name of the environment.

Letters (a-z, A-Z), numbers, underscores, hyphens, dots and spaces. Cannot start or end with a space.

descriptionstring nullable

Description of the environment.

Any printable characters and line breaks. Cannot contain control characters other than tab, carriage return and line feed, nor invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

Response

OK

idstring required
namestring required
descriptionstring nullable
type'production' | 'sandbox' required
createdAtstring date-time required
updatedAtstring date-time required

Changes