Skip to main content
POST
Set Up Module

Authorizations

Authorization
string
header
required

API key authentication. Get your API key from the Duvo dashboard.

Path Parameters

slug
enum<string>
required

Module template to set up, for example ap-invoice-intake-routing for AP Invoice Intake & Routing or freight-audit for Freight Audit.

Available options:
chargebacks,
freight-audit,
inbound-to-store,
mode-mix,
ap-invoice-intake-routing,
payables-audit,
demand-supply-balancing,
po-management
teamId
string
required

Body

application/json
convert_existing_demo
boolean
default:false

Set true only after the user agreed to it: when the team already has a demo of this Module open, that demo becomes the Automation and its sample cases and Runs are deleted, with no undo. Left false, such a call is refused with 409 and nothing changes.

Response

Default Response

automation_id
string<uuid>
required

The team's new Automation, built from the Module template.

name
string | null
required

The new Automation's name, or null when it could not be read back after setup; the Automation exists either way.

is_setting_up
enum<boolean>
required

Always true: the Automation starts in setup, with its Policy, current process and automation proposal still to do.

Available options:
true

Root-relative web-app path to the Automation's setup screen, or null when this viewer has no such tab.

url
string | null
required

The full web-app URL of link.