Skip to main content

Create an approval action

POST 
/workflow_actions/approval_actions

Create an approval action. The following supporting objects will need to be created after this action is created (which are tied together via workflow_action_id) - workflow_action_performers, workflow_action_roles, workflow_action_performer_notification_email, workflow_action_approval_email, workflow_action_rejection_email. These supporting objects must be created for this action to be complete (APIs for these supporting objects not yet implemented, use UI).

Request​

Body

required
    workflow_action object
    workflow_id uuid

    The workflow the workflow action belongs to.

    description string

    The description of the workflow action.

    page_id uuid

    The page the workflow action should render.

    archived boolean

    Default value: false

    If the workflow action is archived or not.

    skippable boolean

    Default value: false

    If the workflow action is skippable or not.

    requires_comment boolean

    Default value: false

    If the workflow action requires a comment or not.

Responses​

Expected response to a valid request

Schema
    workflow_action object
    workflow_id uuid

    The workflow the workflow action belongs to.

    description string

    The description of the workflow action.

    page_id uuid

    The page the workflow action should render.

    add_requester_as_owner boolean

    Default value: true

    If the requester should be added as the owner of the profile to be created.

    email_attribute_id uuid

    The attribute storing the email address for the workflow action.

    email_addresses text[]

    The email addresses for the workflow action.

    new_status text

    The new status for the Status Change workflow action.

    archived boolean

    Default value: false

    If the workflow action is archived or not.

    skippable boolean

    Default value: false

    If the workflow action is skippable or not.

    requires_comment boolean

    Default value: false

    If the workflow action requires a comment or not.

Loading...