Skip to main content

Create an invitation action

POST 
/workflow_actions/invitation_actions

Create an invitation 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_pause_action. 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.

    archived boolean

    Default value: false

    If the workflow action is archived or not.

    configuration_attributes object
    id uuid

    the id.

    wait_for_completion boolean

    If the invitation action should pause the parent workflow to wait for completion.

    return_profile boolean

    If the invitation action should return a profile.

    portal_id uuid

    the id of the portal.

    registration_workflow_id uuid

    the id of the registration workflow.

    email_attribute_id uuid

    the id of the email attribute.

    validate_completed_registration boolean

    If the action should validate against completed registrations by email address.

    validate_open_registration boolean

    If the action should validate against open registrations by email address.

    workflow_action_email_attributes object
    id uuid

    the id.

    workflow_action_id uuid

    the id of the workflow action.

    email_id uuid

    the id of the email.

    type string

    Possible values: [StandardEmail, PerformerNotificationEmail, ApprovalEmail, RejectionEmail]

    the type of email.

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...