Skip to main content

Version: 24.10

User Submit

The User Submit command performs a user-initiated submit operation to finalize an application. Once an application has been submitted, no more Open UX commands can be made against that transaction.

Support​

User Submit was introduced in Transact Manager 17.10, and continues to be available in later Transact Manager and Journey Manager releases.

Options​

All options are optional unless otherwise indicated.

OptionDescription
sendEmailFormReceiptboolean

Whether to send a "Form Receipt" email message to the user specified by the emailAddress parameter.

emailAddressstring

The email address of the email recipient.

milestonestring (Maximum length 100 characters)

A transaction milestone event to record with the transaction. For example, "Application Completed".

Milestones are used to store transaction analytics information only. Do not store sensitive or PII data in milestones.

These milestones are recorded in the transaction history table for business reporting, and are also published to the Journey Manager licensing service to support custom licensing agreements.

Example​

{
   "type": "userSubmit",
   "requestKey": "96b45311175fc320d875483950b2847c",
   "options": {
      "sendEmailFormReceipt": true,
      "emailAddress": "[email protected]",
      "milestone": "Application Completed"
   }
}

Response​

info

The response to this command is based on the standard Open UX API HTTP response. For more information, see HTTP Response.

200 OK​

On a successful response, the form should display the Submit Success modal page. Generally, the form will not be required to perform any further operations; however, the server may instruct the form to redirect the user to another location.

{
   "formStatus": "Completed",
   "redirectUrl": "https://www.mycorp.com/forms/thank-you.html?submitKey=bb9c87a62c83f2b642240d97edda50a9"
}

200 Validation Errors​

If the form submit was rejected by the server with validation errors, the formStatus will remain "Saved" and a validationErrors array will be present. The form should display these error messages to the user so they can fix these before attempting to submit the form again.

{
   "formStatus": "Saved",
   "validationErrors": [
        {
            "path": "//SmartForm/GettingStarted/Eligible/ContactDetails/EmailAddress",
            "errorKey": "emailFormat"
        },
        {
            "path": "//SmartForm/GettingStarted/Eligible/ContactDetails/ContactNumber",
            "errorKey": "mandatory"
        }
   ]
}