Referral Form Configuration Management Input

Input representation of the top-level details for the referral form configuration record that you want to create or update, such as its display name, developer name, base entity, and activation status.

JSON Example

1{
2  "id": null,
3  "name": "New Client Onboarding Referral",
4  "developerName": "New_Client_Onboarding_Referral",
5  "description": "Referral intake form for onboarding new clients.",
6  "baseEntity": "Referral",
7  "contextDefinitionId": "0jY0x0000000001EAA",
8  "isActive": true,
9  "shouldShowNavigationSteps": true,
10  "shouldShowSummaryStep": true
11}

Properties

Name	Type	Description	Required or Optional	Available Version
`baseEntity`	String	API name of the object that the referral form configuration record is associated with, such as `Referral`.	Optional	67.0
`contextDefinitionId`	String	ID of the Context Definition that drives runtime data collection and routing for referrals created from this form.	Optional	67.0
`description`	String	Description that explains the purpose or scope of the referral form. The maximum supported length is 255 characters.	Optional	67.0
`developerName`	String	API name of the referral form configuration record.	Optional	67.0
`id`	String	ID of the referral form configuration record.	Required to update the referral form configuration record	67.0
`isActive`	Boolean	Indicates whether the referral form configuration record is active and available for use (`true`) or not (`false`).	Optional	67.0
`name`	String	Display name of the referral form configuration record.	Optional	67.0
`shouldShowNavigationSteps`	Boolean	Indicates whether to show the step navigation at runtime (`true`) or hide it (`false`).	Optional	67.0
`shouldShowSummaryStep`	Boolean	Indicates whether to show the summary step at the end of the referral intake step (`true`) or hide it (`false`).	Optional	67.0