API Docs / Schemas / UpdateEngagementSettingsDataFormRequest

UpdateEngagementSettingsDataFormRequest

Request to configure a form as a step in the proposal acceptance flow.

Properties

Name Type Description
dataFormCode*string

Code of the form to present. Must be a published form.

Code of the form to present. Must be a published form.

stepTitle*string

The label shown for this step in the progress bar at the top of the acceptance flow

The label shown for this step in the progress bar at the top of the acceptance flow

stepDescriptionstring

Short text shown under the step label in the progress bar

Short text shown under the step label in the progress bar

sortOrderinteger

Position of this form among the form steps. Lower sorts first.

Position of this form among the form steps. Lower sorts first.

isSkippableboolean

Whether the client can move past this step without completing the form

Whether the client can move past this step without completing the form

JSON Example

{
  "dataFormCode": "string",
  "stepTitle": "string",
  "stepDescription": "string",
  "sortOrder": 0,
  "isSkippable": false
}

Contained in Schemas