Update approval flow

steps, when sent, replaces the whole list; a step without customNotification gets the default notification. A fetched flow can be sent back as is.

Approvers: a user id from GET /users; a user group { type: 'userGroup', value, label }, manual or IdP, with its id as value, as an existing flow's approvers show it; or an item from GET /appCatalog/approvalFlows/config's approverOptions.

A special approver can resolve to nobody for a request (an app with no owner, an empty manager field); the step then waits as 'Needs attention' until an admin assigns it. Add a user or a group next to special approvers as a fallback.

  • Rate limit: 100 requests per minute

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

The approval flow id, from GET /appCatalog/approvalFlows.

Body Params
string
length ≤ 255

Display name.

steps
array of objects
length between 1 and 15

The approval steps, in order: each step starts once the one before it is approved. When sent, replaces the whole list: a step left out is removed. A fetched flow's steps can be sent back as is.

steps
string
^[1-9]\d{0,14}$

Optional. The server assigns one when omitted; a sent id is kept.

approvers
array
required
length between 1 and 30

Who approves this step. Each item is a user id from GET /users; a user group { type: 'userGroup', value, label }, manual or IdP, with its id as value; or an item copied as is from GET /appCatalog/approvalFlows/config's approverOptions. A special approver can resolve to nobody for a given request (an app with no owner, an empty manager field); the step then becomes a "Needs attention" task until an admin assigns it. Add a user or a group next to special approvers as a fallback.

approvers*
customNotification
object | null

Optional. Leave it out, or send null, for the default notification; send { title, message } for a custom one. title ≤ 255 and message ≤ 1,000 characters; both can use the tokens in GET /appCatalog/approvalFlows/config's notificationTokens.

Responses

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