Skip to main content
PUT
/
workflow
/
{id}
Update Workflow
curl --request PUT \
  --url https://{api-address}.org.machina.gg/workflow/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '{
  "title": "<string>",
  "description": "<string>",
  "status": "active",
  "context": {},
  "inputs": {},
  "outputs": {}
}'
{
  "data": {
    "_id": "<string>",
    "name": "<string>",
    "title": "<string>",
    "description": "<string>",
    "status": "active",
    "updated": "<string>"
  },
  "status": true
}

Authorizations

x-api-token
string
header
required

API key authentication

Path Parameters

id
string
required

Unique ID of the workflow to update

Body

application/json
title
string

Updated display title of the workflow

description
string

Updated description of the workflow's purpose

status
enum<string>

Updated status of the workflow

Available options:
active,
inactive
context
object

Updated configuration settings for the workflow

inputs
object

Updated input parameters for the workflow

outputs
object

Updated output mappings for the workflow

Response

Workflow updated successfully

data
object
status
boolean

Operation status