> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://www.comet.com/docs/opik/_mcp/server.

# Update environment by id

PATCH http://localhost:5173/api/v1/private/environments/{id}
Content-Type: application/json

Update environment by id

Reference: https://www.comet.com/docs/opik/reference/rest-api/environments/update-environment

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Path parameters

- `id` (string, required)

### Body (application/json)

This endpoint expects an object.

- `name` (string, optional)
- `description` (string, optional)
- `color` (string, optional)
- `position` (integer, optional)

## Response

### 204

No Content

## Errors

### 404 Not Found Error

Not found

- `code` (integer, optional)
- `message` (string, optional)
- `details` (string, optional)

### 409 Conflict Error

Conflict

- `code` (integer, optional)
- `message` (string, optional)
- `details` (string, optional)

## Examples

**Request**

```json
{
  "name": "Dev_Environment_01",
  "description": "Development environment for testing new features",
  "color": "blue",
  "position": 3
}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/environments/id"

payload = {
    "name": "Dev_Environment_01",
    "description": "Development environment for testing new features",
    "color": "blue",
    "position": 3
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/environments/id';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"Dev_Environment_01","description":"Development environment for testing new features","color":"blue","position":3}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5173/api/v1/private/environments/id"

	payload := strings.NewReader("{\n  \"name\": \"Dev_Environment_01\",\n  \"description\": \"Development environment for testing new features\",\n  \"color\": \"blue\",\n  \"position\": 3\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/v1/private/environments/id")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Dev_Environment_01\",\n  \"description\": \"Development environment for testing new features\",\n  \"color\": \"blue\",\n  \"position\": 3\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("http://localhost:5173/api/v1/private/environments/id")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Dev_Environment_01\",\n  \"description\": \"Development environment for testing new features\",\n  \"color\": \"blue\",\n  \"position\": 3\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'http://localhost:5173/api/v1/private/environments/id', [
  'body' => '{
  "name": "Dev_Environment_01",
  "description": "Development environment for testing new features",
  "color": "blue",
  "position": 3
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/environments/id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Dev_Environment_01\",\n  \"description\": \"Development environment for testing new features\",\n  \"color\": \"blue\",\n  \"position\": 3\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "name": "Dev_Environment_01",
  "description": "Development environment for testing new features",
  "color": "blue",
  "position": 3
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/environments/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```