> For clean Markdown of any page, append `.md` to the page URL. > For a complete documentation index, see https://docs.sarvam.ai/llms.txt. > For full documentation content in one file, see https://docs.sarvam.ai/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.sarvam.ai/_mcp/server. # Update board PATCH https://apps.sarvam.ai/api/analytics/v1/{org_id}/{workspace_id}/boards/{board_id} Content-Type: application/json Partial update. Omit a field to leave it unchanged. Sending `tag: null` untags the board; omitting it leaves the current tag alone. Reference: https://docs.sarvam.ai/conversations/api/boards/update ## Request ### Path parameters - `org_id` (string, required) — Organization ID - `workspace_id` (string, required) — Workspace ID - `board_id` (string, required) ### Headers - `X-API-Key` (string, required) — Your workspace API key. ### Body (application/json) This endpoint expects an object. - `name` (string, optional, nullable) — New display name. Omit to leave unchanged; null is rejected. - `tag` (string, optional, nullable) — Replacement tag, replacing any existing one. Omit to leave unchanged; send null to untag the board. ## Response ### 200 Successful Response - `id` (string, required) — Board identifier, used as `{board_id}` in every nested route - `name` (string, required) — Board display name - `created_by` (object, required) — Actor that created the board - `type` (enum, required) — Whether a user or an API key performed the action. - Allowed values: `user`, `api_key` - `id` (string, required) — User identifier for `user`; the key prefix for `api_key`. - `created_at` (datetime, required) — Creation time, UTC, RFC 3339 - `updated_by` (object, required) — Actor that last changed the board or anything on it - `type` (enum, required) — Whether a user or an API key performed the action. - Allowed values: `user`, `api_key` - `id` (string, required) — User identifier for `user`; the key prefix for `api_key`. - `updated_at` (datetime, required) — Last change time, UTC, RFC 3339 - `tag` (string, optional, nullable) — The board's grouping tag, or null when untagged ## Errors ### 400 Bad Request Error Request failed validation - `error` (object, required) — Details of the error that occurred. - `code` (string, required) — A service-specific error code. - `message` (string, required) — A human-readable description of the error. ### 401 Unauthorized Error Missing or invalid credentials - `error` (object, required) — Details of the error that occurred. - `code` (string, required) — A service-specific error code. - `message` (string, required) — A human-readable description of the error. ### 403 Forbidden Error Credentials are not scoped to this org and workspace - `error` (object, required) — Details of the error that occurred. - `code` (string, required) — A service-specific error code. - `message` (string, required) — A human-readable description of the error. ### 404 Not Found Error No such resource in this workspace - `error` (object, required) — Details of the error that occurred. - `code` (string, required) — A service-specific error code. - `message` (string, required) — A human-readable description of the error. ### 422 Unprocessable Entity Error Validation Error - `detail` (list of object, optional) - `loc` (list of string or integer, required) - `msg` (string, required) - `type` (string, required) ### 429 Too Many Requests Error Rate limit exceeded. Honour the `Retry-After` response header before retrying. - `error` (object, required) — Details of the error that occurred. - `code` (string, required) — A service-specific error code. - `message` (string, required) — A human-readable description of the error. ### 500 Internal Server Error Unexpected server error - `error` (object, required) — Details of the error that occurred. - `code` (string, required) — A service-specific error code. - `message` (string, required) — A human-readable description of the error. ## Examples **Request** ```json { "name": "Campaign Overview 2026" } ``` **Response** ```json { "id": "0b7f2c9a-5e41-4d2a-9f3b-8c1d6e7a0b52", "name": "Campaign Overview", "created_by": { "type": "api_key", "id": "sk_live_a1b2c3" }, "created_at": "2026-09-01T09:15:00Z", "updated_by": { "type": "user", "id": "usr_8f21c4d0" }, "updated_at": "2026-09-12T11:42:08Z", "tag": "Weekly reporting" } ``` **SDK Code** ```python import requests url = "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id" payload = { "name": "Campaign Overview 2026" } headers = { "X-API-Key": "", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id'; const options = { method: 'PATCH', headers: {'X-API-Key': '', 'Content-Type': 'application/json'}, body: '{"name":"Campaign Overview 2026"}' }; 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 := "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id" payload := strings.NewReader("{\n \"name\": \"Campaign Overview 2026\"\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("X-API-Key", "") 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("https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["X-API-Key"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"Campaign Overview 2026\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id") .header("X-API-Key", "") .header("Content-Type", "application/json") .body("{\n \"name\": \"Campaign Overview 2026\"\n}") .asString(); ``` ```php request('PATCH', 'https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id', [ 'body' => '{ "name": "Campaign Overview 2026" }', 'headers' => [ 'Content-Type' => 'application/json', 'X-API-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_id"); var request = new RestRequest(Method.PATCH); request.AddHeader("X-API-Key", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"Campaign Overview 2026\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-API-Key": "", "Content-Type": "application/json" ] let parameters = ["name": "Campaign Overview 2026"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://apps.sarvam.ai/api/analytics/v1/org_id/workspace_id/boards/board_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() ```