Skip to main content
PUT
/
v1
/
workflows
curl --request PUT \
  --url https://api.getmaxim.ai/v1/workflows \
  --header 'Content-Type: application/json' \
  --header 'x-maxim-api-key: <api-key>' \
  --data '
{
  "id": "wf_abc123",
  "workspaceId": "ws_xyz",
  "name": "renamed-workflow"
}
'
{
  "data": {
    "id": "<string>",
    "workspaceId": "<string>",
    "accountId": "<string>",
    "name": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>",
    "folderId": "<string>",
    "config": null
  }
}

Authorizations

​
x-maxim-api-key
string
header
required

API key for authentication

Body

application/json
​
id
string
required

Unique identifier of the workflow to update

Minimum string length: 1
​
workspaceId
string
required

Workspace that currently owns the workflow

Minimum string length: 1
​
name
string

New name for the workflow

Minimum string length: 1
​
description
string

New description for the workflow

​
folderId
string | null

Move the workflow to this folder. Pass null to remove from any folder; omit to leave unchanged.

​
newWorkspaceId
string

Move the workflow to this workspace. Omit to keep it in the current workspace.

​
config
object

Partial workflow config. Shape depends on the workflow's stored type (HTTP or VOICE) — supply the matching schema. Top-level keys are shallow-merged with the existing config; nested objects/arrays are replaced, not merged.

​
evalConfig
object

Evaluation configuration (full replacement when provided)

Response

Workflow updated successfully

​
data
object
required