ORorshot
Other

Update an Approval Flow

Changed on

Changes an approval flow's name, description, colour, whether it blocks API renders, or its settings (how templates enter).

Available only to Enterprise-plan workspaces and first-party clients.

patch/approval-flows/{flow}

Request

  • Base URL
    https://api.orshot.com/v1
  • URL
    https://api.orshot.com/v1/approval-flows/{flow}
  • Auth
    HTTP bearer

Path parameters

flowstring required

The approval flow's id or slug. A number is an id, anything else a slug.

Request body

namestring

Display name. Up to 80 characters.

descriptionstring

Optional description. Up to 500 characters.

colorstring

Chip colour. One of subtle, blue, green, amber, rose, orange, purple. Can be null.

blocksRendersboolean
settingsobject

Flow settings to change (partial).

makeDefaultboolean

Make this the workspace's default approval flow: first in the list, the one the Approvals page opens. Must be true.

Response

Successful response

object required

Changes