Skip to main content
POST
Install a workflow template

Authorizations

Authorization
string
header
required

Use your app's API key as the username, and leave the password blank

Path Parameters

key
string
required

The template's key (see GET /workflow-templates)

Pattern: ^[a-z][a-z0-9_]{0,63}$

Body

application/json
as
string

Install the template under this key instead of its own; replace then applies to this key. The child workflows keep their own keys, because the chart names them by those.

Pattern: ^[a-z][a-z0-9_]{0,63}$
notes
string

A note recorded in the history beside each version publish: true creates. Ignored without it.

publish
boolean

true publishes every workflow this call created or replaced, each child before the workflows that call it. A child the app already had as an unpublished draft, and that replace did not replace, makes this fail with 422 unpublished_references. Without it, what is created is a draft, and what is replaced keeps its published version while its working copy changes.

replace
boolean
default:false

true replaces the chart of a workflow the app already has at the key (or at as), and of each child workflow the template calls that the app already has, with the template's current chart, instead of answering 409 key_taken or leaving the child as it is. The same replacement as PUT /workflows/{key}: earlier versions are kept, and the published version stays live until publish: true publishes the new chart.

Response

replace: true replaced the chart of the workflow the app already had at the key

data
object
installed
string[]

The keys of every workflow this call created, the installed template first when it was created.

replaced
string[]

The keys of every workflow replace: true gave the template's chart, the installed template first when it was replaced. Empty without replace.