Create an invitation action

POST {{baseUrl}}/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 workflowactionid) - workflowactionpause_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

{"workflow_action"=>{"workflow_id"=>"33f072dd-13b4-41e1-8ea0-16f2a59b57c8", "description"=>"Creates a registration session associated with an email address", "archived"=>false, "configuration_attributes"=>{"id"=>"33f072dd-13b4-41e1-8ea0-16f2a59b57c8", "wait_for_completion"=>false, "return_profile"=>false, "portal_id"=>"33f072dd-13b4-41e1-8ea0-16f2a59b57c8", "registration_workflow_id"=>"33f072dd-13b4-41e1-8ea0-16f2a59b57c8", "email_attribute_id"=>"33f072dd-13b4-41e1-8ea0-16f2a59b57c8", "validate_completed_registration"=>false, "validate_open_registration"=>false}, "workflow_action_email_attributes"=>{"id"=>"33f072dd-13b4-41e1-8ea0-16f2a59b57c8", "workflow_action_id"=>"33f072dd-13b4-41e1-8ea0-16f2a59b57c8", "email_id"=>"33f072dd-13b4-41e1-8ea0-16f2a59b57c8", "type"=>"StandardEmail"}}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{"workflow_action":{"workflow_id":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8","description":"Require approval from another user or a group of users with a specific role.","page_id":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8","add_requester_as_owner":true,"email_attribute_id":"33f072dd-13b4-41e1-8ea0-16f2a59b57c8","email_addresses":["johndoe@gmail.com","janedoe@gmail.com"],"new_status":"Active, Inactive, On Leave, Terminated","archived":false,"skippable":false,"requires_comment":false}}