PATCH

Update Workflow

Updates one or more fields on an existing Workflow.

PATCHhttps://api.vantaxai.com/v1/workflows/{workflow_id}

Only include the fields you want to change. Supplying `steps` replaces the entire step list, and supplying `trigger` replaces the trigger. Toggle `is_active` to arm or disarm the Workflow without changing its configuration.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…
Content-Typestringrequired
Must be application/json for requests with a body.
example: application/json

Path Parameters

workflow_idstringrequired
The Workflow to update.
example: wf_4c81a0

Body Parameters

namestringoptional
New display name.
descriptionstringoptional
Updated description.
triggerobjectoptional
Replace the trigger. An object with a `type` and a `config`.
stepsarrayoptional
Replace the ordered list of steps.
is_activebooleanoptional
Arm or disarm the Workflow.

Request

curl -X PATCH https://api.vantaxai.com/v1/workflows/wf_4c81a0 \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "trigger": {},
  "steps": []
}'

const res = await fetch(
  "https://api.vantaxai.com/v1/workflows/wf_4c81a0",
  {
  method: "PATCH",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string",
    "trigger": {},
    "steps": []
  }),
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// PATCH /v1/workflows/{workflow_id}
const result = await vantax.request("PATCH", "/v1/workflows/{workflow_id}", {
  "name": "string",
  "description": "string",
  "trigger": {},
  "steps": []
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# PATCH /v1/workflows/{workflow_id}
result = vantax.request("PATCH", "/v1/workflows/{workflow_id}", json={"name": "string", "description": "string", "trigger": {}, "steps": []})

Response

{
  "success": true,
  "message": "Workflow updated successfully",
  "data": {
    "id": "wf_4c81a0",
    "name": "New Lead Follow-up (Paused)",
    "is_active": false,
    "updated_at": "2026-02-02T08:12:00Z"
  }
}

{ "success": false, "message": "Workflow not found" }

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    { "field": "steps[1].next", "message": "next references an unknown step id" }
  ]
}