Sign in

v1

latestOpenAPI 3.1.02026-07-1245137133.6 KB
workflows

Update Workflow

Update an existing workflow's name, connectors, schedule, or workflow type.

put/api/v1/workflows/{workflow_id}

Path parameters

string uuid required
OR
string required

Headers

unstructured-api-keystring nullable

Request body

namestring nullable
workflow_type'basic' | 'advanced' | 'platinum' | 'custom'
template_idstring nullable
schedule'every 15 minutes' | 'every hour' | 'every 2 hours' | 'every 4 hours' | 'every 6 hours' | 'every 8 hours' | 'every 10 hours' | 'every 12 hours' | 'daily' | 'weekly' | 'monthly' nullable
reprocess_allboolean nullable
state'active' | 'inactive'

Response

Successful Response

idstring uuid required
namestring required
keystring nullable
sourcesstring[] required
destinationsstring[] required
workflow_type'basic' | 'advanced' | 'platinum' | 'custom'
status'active' | 'inactive' required
created_atstring date-time required
updated_atstring date-time nullable
reprocess_allboolean

Example response

{
  "schedule": {
    "crontab_entries": [
      {
        "cron_expression": "0 0 * * *"
      }
    ]
  }
}