Update environment

PATCH/environments/{environment_id}

Path parameters

environment_idstring

Environment ID

Headers

Authorizationstring

Bearer <token>.

Returns

200OKEnvironment

created_atoptional string

created_by_user_idoptional string

deleted_atoptional string

descriptionoptional string

idoptional string

is_activeoptional boolean

is_defaultoptional boolean

is_protectedoptional boolean

nameoptional string

User-defined: "qa-team", "customer-prod"

settingsoptional string

slugoptional string

typeoptional string

DEVELOPMENT, STAGING, PRODUCTION, SANDBOX

updated_atoptional string

workspace_idoptional string

const res = await fetch("https://api.hexelstudio.com/v1/environments/{environment_id}", { method: "PATCH", headers: { Authorization: `Bearer ${process.env.ACCESS_TOKEN}`, }, }) const data = await res.json()

import os import requests res = requests.patch( "https://api.hexelstudio.com/v1/environments/{environment_id}", headers={"Authorization": f"Bearer {os.environ['ACCESS_TOKEN']}"}, ) data = res.json()

{ "created_at": "2026-01-01T00:00:00Z", "created_by_user_id": "string", "deleted_at": "2026-01-01T00:00:00Z", "description": "string", "id": "string", "is_active": true, "is_default": true, "is_protected": true, "name": "string", "settings": "string", "slug": "string", "type": "string", "updated_at": "2026-01-01T00:00:00Z", "workspace_id": "string" }