Input representation of the welcome-screen configuration that's shown before the
first step of a referral intake form, including consent items, welcome content, and prefilled
fields.
JSON Example
{
"title": "Welcome to our referral intake",
"description": "Tell us a little about you to get started.",
"content": {
"body": "Welcome! Complete this form to submit your referral.",
"format": "plainText"
},
"consents": [
{
"sequence": 1,
"consentText": "I agree to the terms of service.",
"consentLinkUrl": "https://www.example.com/terms",
"isRequired": true
}
],
"fields": []
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| consents | Referral Form Configuration Welcome Consent Management Input[] | List of consent items shown on the welcome screen. | Optional | 67.0 |
| content | Referral Form Configuration Welcome Content Management Input | Body content of the welcome screen. | Optional | 67.0 |
| description | String | Short introduction shown above the welcome content. | Optional | 67.0 |
| fields | Referral Form Configuration Step Section Field Management Input[] | Fields to show on the welcome screen. Use this list to collect basic information before the intake steps. | Optional | 67.0 |
| title | String | Title shown on the welcome screen. | Optional | 67.0 |