Referral Form Configuration Step Input

Input representation of a single step within a referral form configuration record, including its layout order, optional visibility criteria, and list of sections.

JSON Example

1{
2  "id": null,
3  "label": "Applicant Information",
4  "sequence": 1,
5  "isVisibilityConditional": false,
6  "isDeleted": false,
7  "criteria": null,
8  "sections": [
9    {
10      "label": "Applicant Details",
11      "sequence": 1,
12      "isVisibilityConditional": false,
13      "isDeleted": false,
14      "fields": [
15        {
16          "apiName": "FirstName",
17          "objectApiName": "Referral",
18          "label": "First Name",
19          "dataType": "String",
20          "sequence": 1,
21          "isRequired": true
22        }
23      ]
24    }
25  ]
26}

Properties

Name	Type	Description	Required or Optional	Available Version
`criteria`	Step Section Visibility Condition Input	Conditions that control the visibility of this step. The first step is always visible and can’t have criteria; subsequent steps can depend on fields defined in earlier steps or sections.	Optional	67.0
`id`	String	ID of the step. Required when you update or delete an existing step.	Required to update an existing step	67.0
`isDeleted`	Boolean	Indicates whether to delete the step and its configuration details (`true`) or not (`false`).	Optional	67.0
`isVisibilityConditional`	Boolean	Indicates whether the visibility of this step depends on the configured `criteria` (`true`) or is always visible (`false`).	Optional	67.0
`label`	String	UI label or display name of the step.	Optional	67.0
`sections`	Referral Form Configuration Step Section Input[]	List of sections within the step.	Optional	67.0
`sequence`	Integer	Sequence in which the step appears on the screen in runtime, starting from 1. Lower values appear first on the screen.	Optional	67.0