Updates an approval workflow

Replaces an approval workflow's definition. The whole definition is required — a partial body is
rejected, not merged, and fields this contract does not define are ignored. Send type and
active back as read; changing either here is rejected, and combinations the Rillet app cannot
configure are rejected too (see the individual fields).

Entries already awaiting approval are unaffected, because an entry copies the layers it needs when
approval starts; only entries registered after this call use the new definition. Deadlines and layer
escalation rules are not part of this contract and are cleared, exactly as saving a workflow in
Rillet clears them.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

UUID of the approval workflow to be used in this operation.

Body Params

An approval workflow's definition, as sent when creating or replacing one. A workflow's type never
changes, and active changes only through activation in Rillet, so an update must send both back
unchanged.

string
required
string
enum
required

Required, and must equal the workflow's current type — a workflow cannot be moved between types,
because priority orders workflows within one type. Only JOURNAL_ENTRY is accepted today; the
other types are rejected until an approval flow evaluates them.

Allowed:
boolean
required

Required, and must equal the workflow's current value — activation is a dedicated operation in
Rillet, so a definition update never changes it. Read the workflow first if you are unsure.

condition_group
object
required

A set of conditions combined by one logical operator, together with any nested groups. A group must
carry at least one condition or one nested group; a workflow may carry at most five conditions across
the whole tree, and nesting at most three levels deep. groups must be empty for now: nested
combinations are not evaluated yet and are rejected, so a workflow currently has exactly one group.

approval_layers
array of objects
required
length between 1 and 5
approval_layers*
methods
array of objects
required
length ≥ 1

Only ["IN_APP"] is accepted today: EMAIL and SLACK deliver nothing, so they are rejected
rather than stored.

methods*
Allowed:
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json