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}
JWTenvironment:write

Path parameters

idstringrequired

Unique identifier for the environment.

Format: uuid

Request body

namestring

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

Length: [1,256]Pattern: ^[a-zA-Z0-9_.-]+( +[a-zA-Z0-9_.-]+)*$

descriptionstring

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.

Length: [0,256]Pattern: ^(?!\s)(?![\s\S]*\s$)(?:[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]|[\t\n\r])+$

Response

200 OK

idstringrequired
namestringrequired
typestringrequired

Allowed values: production, sandbox

createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

descriptionstring