patchUpdate an environment

Partially updates an environment in the active workspace. Supply at least one of name, description, or color; omitted fields remain unchanged. Clear the description with null or an empty string. Unknown fields are rejected.

Required service-token scope: environment:update. End-user access is checked against workspace policies. Send a Bearer token and the X-Workspace-Id header.

curl --request PATCH \
  --url https://api.test.neobits.ai/logic/v1/environments/019991b1-0000-7000-8000-000000000002 \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'X-Workspace-Id: 019991b1-0000-7000-8000-000000000001' \
  --header 'Content-Type: application/json' \
  --data '{"description":"Shared integration environment"}'

Request

Headers

  • Authorization•string

    Bearer token authentication using OAuth 2.0 client credentials flow.

  • X-Workspace-Id•string<uuid>

    Active workspace UUID. The authenticated principal must have access to this workspace.

Params (path)

  • id•string<uuid>

    Environment identifier.

Body

  • name•string

    Nonempty name without leading or trailing whitespace.

  • description•string

    Description. Use null or an empty string to clear it.

  • color•string

    A six-digit hex color or one of the supported theme colors. If omitted on creation, a random theme color is persisted.

Response

Headers

  • Content-Type•string

    The content type of the response.

Body

  • id•string<uuid>

    Environment identifier.

  • workspaceId•string<uuid>

    Workspace containing this resource.

  • name•string

    Nonempty name without leading or trailing whitespace.

  • description•string

    Description. Use null or an empty string to clear it.

  • color•string

    A six-digit hex color or one of the supported theme colors. If omitted on creation, a random theme color is persisted.

  • createdAt•string<date-time>

    Creation time.

  • updatedAt•string<date-time>

    Last update time.