Skip to main content
PUT
/
workflows
/
{workflow_id}
JavaScript
import Morphik from 'morphik';

const client = new Morphik({
  apiKey: 'My API Key',
});

const workflow = await client.workflows.update('workflow_id', { body: { foo: 'bar' } });

console.log(workflow.owner_id);
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "owner_id": "<string>",
  "user_id": "<string>",
  "app_id": "<string>",
  "steps": [
    {
      "action_id": "<string>",
      "parameters": {}
    }
  ],
  "system_metadata": {}
}

Headers

​
authorization
string

Path Parameters

​
workflow_id
string
required

Body

application/json · Workflow Updates · object

Response

Successful Response

High-level definition of a multi-step document processing workflow.

​
name
string
required
​
owner_id
string
required

Organization / developer ID owning this workflow

​
steps
ConfiguredAction · object[]
required

Ordered list of actions to execute

Minimum length: 1
​
id
string
​
description
string | null
​
user_id
string | null

End-user ID when created in a narrowed scope

​
app_id
string | null

App ID when created inside an application context

​
system_metadata
object
⌘I