Skip to main content

Create a profile check action

POST 
/workflow_actions/profile_check_actions

Create a profile check action

Request​

Body

required

    workflow_action

    object

    workflow_id uuid

    The workflow the workflow action belongs to.

    description string

    The description of the workflow action.

    archived boolean

    If the workflow action is archived or not.

    ne_attribute_ids array

    An array of ne_attribute_ids.

    handle_type string

    Possible values: [session, attribute]

    The handle type for what should happen if an existing profile is found.

    handle_id string

    The handle id. When handle type is session, this is the session id.

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

    If the workflow action is archived or not.

    skippable boolean

    If the workflow action is skippable or not.

    requires_comment boolean

    If the workflow action requires a comment or not.

Loading...