Intake Welcome Management Input

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 

1{
2  "title": "Welcome to our referral intake",
3  "description": "Tell us a little about you to get started.",
4  "content": {
5    "body": "Welcome! Complete this form to submit your referral.",
6    "format": "plainText"
7  },
8  "consents": [
9    {
10      "sequence": 1,
11      "consentText": "I agree to the terms of service.",
12      "consentLinkUrl": "https://www.example.com/terms",
13      "isRequired": true
14    }
15  ],
16  "fields": []
17}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
consentsReferral Form Configuration Welcome Consent Management Input[]List of consent items shown on the welcome screen.Optional67.0
contentReferral Form Configuration Welcome Content Management InputBody content of the welcome screen.Optional67.0
descriptionStringShort introduction shown above the welcome content.Optional67.0
fieldsReferral 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.Optional67.0
titleStringTitle shown on the welcome screen.Optional67.0