Update workflow version

Update a deployment version's name or release note with workspace write access. Omitted fields remain unchanged; description: null clears the note. The graph and live version are unchanged. Use Activate workflow version to serve it.

OAuth scope: api:write.

PATCH/api/v2/workflows/{workflowId}/versions/{version}

Authorization

X-API-Key<token>

Send a personal or workspace API key in X-API-Key. See key types and access; operations that reject workspace keys say so in their description.

In: header

Request examples use an API key. For OAuth, replace the X-API-Key header with Authorization: Bearer YOUR_ACCESS_TOKEN.

curl -X PATCH "https://www.sim.ai/api/v2/workflows/string/versions/3" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "Escalation routing",    "description": "Adds the priority escalation branch."  }'
const body = JSON.stringify({  "name": "Escalation routing",  "description": "Adds the priority escalation branch."})fetch("https://www.sim.ai/api/v2/workflows/string/versions/3", {  method: "PATCH",  headers: {    "Content-Type": "application/json",    "X-API-Key": "YOUR_API_KEY"  },  body})
package mainimport (  "fmt"  "net/http"  "io/ioutil"  "strings")func main() {  url := "https://www.sim.ai/api/v2/workflows/string/versions/3"  body := strings.NewReader(`{    "name": "Escalation routing",    "description": "Adds the priority escalation branch."  }`)  req, _ := http.NewRequest("PATCH", url, body)  req.Header.Add("X-API-Key", "YOUR_API_KEY")  req.Header.Add("Content-Type", "application/json")  res, _ := http.DefaultClient.Do(req)  defer res.Body.Close()  body, _ := ioutil.ReadAll(res.Body)  fmt.Println(res)  fmt.Println(string(body))}
import requestsurl = "https://www.sim.ai/api/v2/workflows/string/versions/3"body = """{  "name": "Escalation routing",  "description": "Adds the priority escalation branch."}"""response = requests.request("PATCH", url, data = body, headers = {  "Content-Type": "application/json",   "X-API-Key": "YOUR_API_KEY"})print(response.text)
import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{  "name": "Escalation routing",  "description": "Adds the priority escalation branch."}""");HttpClient client = HttpClient.newBuilder()  .connectTimeout(Duration.ofSeconds(10))  .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()  .uri(URI.create("https://www.sim.ai/api/v2/workflows/string/versions/3"))  .header("X-API-Key", "YOUR_API_KEY")  .header("Content-Type", "application/json")  .PATCH(body)  .build();try {  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());  System.out.println("Status code: " + response.statusCode());  System.out.println("Response body: " + response.body());} catch (Exception e) {  e.printStackTrace();}
using System;using System.Net.Http;using System.Text;var body = new StringContent("""{  "name": "Escalation routing",  "description": "Adds the priority escalation branch."}""", Encoding.UTF8, "application/json");var client = new HttpClient();client.DefaultRequestHeaders.Add("X-API-Key", "YOUR_API_KEY");var response = await client.PatchAsync("https://www.sim.ai/api/v2/workflows/string/versions/3", body);var responseBody = await response.Content.ReadAsStringAsync();
{
  "data": {
    "version": 3,
    "name": "Escalation routing",
    "description": "Adds the priority escalation branch."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Request body must be sent as application/json"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}

Path parameters

version*integer

Numeric deployment version.

Range0 < value <= 2147483647
workflowId*string

Unique workflow identifier.

Length1 <= length

Request body

application/json

Merge-patch body for the mutable metadata of a deployment version.

TypeScript definitions

Use the request body type in TypeScript.

Response body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

GETCompare versionsPOSTActivate version