Workflows
Overview
The Workflow resources represents the stages of an automation that -in its simplest form- will transform source data to output documents.
Fields
Example
Endpoints
List all Workflows
Retrieve the list of Workflow objects that are owned by- or shared with the team of the user of the API.
Responses
Create a Workflow
Create a new workflow.
Request
A partial Workflow object as JSON.
The only field required to created the simplest form of workflow is the name
field.
Alternatively, an entire complete workflow can be created via a single POST request by providing the optional subcomponents with their respective required fields as outlined below.
Fields suffixed with ?
are not required.
Responses
Retrieve a Workflow
Retrieve a specific workflow via its id.
Responses
Update a Workflow
Update a specific workflow via its id.
Request
A partial Workflow object as JSON. Fields suffixed with ?
are not required.
Response
Delete a Workflow
Delete a specific workflow via its id. This method does not actually delete the workflow but sets its status to "ARCHIVED"
. Deleted workflows can be restored by contacting our custom success team.
Response
Last updated