Skip to main content
PATCH
/
workflows
/
{workflowId}
/
steps
/
{stepId}
Update step
curl --request PATCH \
  --url https://script.so/api/v1/workflows/{workflowId}/steps/{stepId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Send summary to"
}
'
{
  "id": "step_1",
  "description": "Fetch all orders from Shopify created in the last 24 hours",
  "status": "pending",
  "position": 1,
  "inputs": [
    "orders"
  ],
  "outputs": [
    "summary"
  ]
}

Authorizations

​
Authorization
string
header
required

API key authentication. Get your key from Settings → API Keys.

Use sk_live_ prefix for production, sk_test_ for development.

Path Parameters

​
workflowId
string
required

Workflow ID

Example:

"wf_xyz789"

​
stepId
string
required

Step ID

Example:

"step_1"

Body

application/json
​
description
string
required

Updated natural language description

Response

Step updated

​
id
string
Example:

"step_1"

​
description
string
Example:

"Fetch all orders from Shopify created in the last 24 hours"

​
status
enum<string>
Available options:
pending,
building,
ready,
error
​
position
integer
Example:

1

​
inputs
string[]
Example:
["orders"]
​
outputs
string[]
Example:
["summary"]