Skip to main content

Version: 22.10

Form Start

The Form Start command performs a form start operation. This operation ignores the formData parameter value if you provide it.


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


All options are optional unless otherwise indicated.

milestonestring (Maximum length 100 characters)

A transaction milestone event to record with the transaction. For example, "Customer Started".

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.


"type": "formStart",
"requestKey": "96b45311175fc320d875483950b2847c"



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 server returns the existing JSON specifying the form status.

"formStatus": "Opened"

400 Bad Request

On an invalid response, the server sends a JSON error message.