Update Workflow

Overview#

Update any part of a workflow: rename it, replace its steps, or change its status (this is also how you activate, pause and archive). Only the fields you send are changed. PUT works identically to PATCH.

Scheduling is server-managed: when steps or status change, the next run time is recomputed for you.

https://api.orshot.com/v1/workflows/:id

Path Parameters#

Request Body#

All fields are optional.

Request#

await fetch("https://api.orshot.com/v1/workflows/44", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    status: "active",
  }),
});

Error Responses#

Invalid Workflow (400)#

{
  "error": "Invalid workflow",
  "details": ["Step 2 (render): templateId is required"]
}

Missing Connection (400)#

Returned when activating a workflow whose provider connections are not connected yet.

{
  "error": "Connect your Google Drive account before activating this workflow",
  "code": "missing_connection"
}

Active Workflow Limit (403)#

{
  "error": "Active workflow limit reached: your plan allows 5 active workflows across your workspaces. Pause another workflow or upgrade to activate this one."
}

Workflow Not Found (404)#

{
  "error": "Not found"
}

Notes#

• Edits to an already-active workflow (a rename, a step tweak) are never blocked by activation rules; only the flip from another status to active is gated.
• Sharing cannot be changed here; use the Update Workflow Sharing endpoint.

Rate Limits#

• 60 requests per minute per workspace