API Docs / Schemas / EngagementSettingsDataFormDto

EngagementSettingsDataFormDto

A form presented as a step in the proposal acceptance flow.

Properties

Name Type Description
dataFormCodestring

Code of the form to present. Only published forms can be used.

Code of the form to present. Only published forms can be used.

dataFormNamestring

Name of the form

Name of the form

stepTitlestring

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",
  "dataFormName": "string",
  "stepTitle": "string",
  "stepDescription": "string",
  "sortOrder": 0
}

Contained in Schemas