Skip to main content
POST
Create Workflow

Headers

unstructured-api-key
string | null

Body

application/json
name
string
required
workflow_type
enum<string>
required
Available options:
basic,
advanced,
platinum,
custom
source_id
string<uuid> | null
destination_id
string<uuid> | null
workflow_nodes
WorkflowNode · object[] | null
template_id
string | null
schedule
enum<string> | null
Available options:
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
reprocess_all
boolean | null
default:false

Response

Successful Response

id
string<uuid>
required
name
string
required
sources
string<uuid>[]
required
destinations
string<uuid>[]
required
workflow_nodes
WorkflowNode · object[]
required
status
enum<string>
required
Available options:
active,
inactive
created_at
string<date-time>
required
workflow_type
enum<string> | null
Available options:
basic,
advanced,
platinum,
custom
schedule
WorkflowSchedule · object | null
Example:
updated_at
string<date-time> | null
reprocess_all
boolean
default:false