Referral Form Configurations (GET, PUT)

Create or update a referral form configuration record along with its steps, sections, fields, welcome screen, and success screen. Get a paginated list of referral form configuration records.

Resource 

1/connect/referral-management/form-configurations

Resource Example 

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/connect/referral-management/form-configurations

Available Version 

67.0

HTTP Methods 

GET, PUT

Query Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
activeOnlyBooleanIndicates whether to return the referral form configuration records that are currently active (true) or not (false). If not specified, the API returns all the records regardless of status.Optional67.0
offsetIntegerZero-based index of the first record to return. Use with pageSize to page through the results.Optional67.0
pageSizeIntegerMaximum number of records to return in a page. Use with offset to page through the results.Optional67.0
searchStringText to search forms that contain the specified text.Optional67.0

Response Body for GET 

Referral Form Configuration List

Request Body for PUT 

JSON Example 

1{
2  "definition": {
3    "id": null,
4    "name": "New Client Onboarding Referral",
5    "developerName": "New_Client_Onboarding_Referral",
6    "description": "Referral intake form for onboarding new clients.",
7    "baseEntity": "Referral",
8    "contextDefinitionId": "0jY0x0000000001EAA",
9    "isActive": true,
10    "shouldShowNavigationSteps": true,
11    "shouldShowSummaryStep": true
12  },
13  "welcome": {
14    "title": "Welcome to our referral intake",
15    "description": "Tell us a little about you to get started.",
16    "content": {
17      "body": "Welcome! Complete this form to submit your referral.",
18      "format": "plainText"
19    },
20    "consents": [{
21        "id": "a1D5g000000ABcn",
22        "sequence": 1,
23        "isRequired": true,
24        "consentText": "I agree to the terms of service.",
25        "consentLinkUrl": "https://www.example.com/terms",
26        "consentLinkLabel": "View terms",
27        "consentVersion": "1.0",
28        "capturedFieldApiName": "HasConsented__c",
29        "capturedTimestampFieldApiName": "ConsentTimestamp__c",
30        "bodyFormat": "html",
31        "body": "<p>Full terms and conditions...</p>"
32      }],
33    "fields": [{
34        "id": "a1A5g000000ABwx",
35        "sequence": 1,
36        "apiName": "Email",
37        "label": "Email Address",
38        "type": "Email",
39        "isRequired": true,
40        "helpText": "We'll use this to contact you about your referral.",
41        "description": "Applicant's primary email address.",
42        "displayAs": "singleLine",
43        "placeholder": "name@example.com",
44        "defaultValue": null,
45        "hidden": false,
46        "readOnly": false,
47        "targetObjectApiName": null
48      }]
49  },
50  "steps": [
51    {
52      "label": "Applicant Information",
53      "sequence": 1,
54      "isVisibilityConditional": false,
55      "sections": [
56        {
57          "label": "Applicant Details",
58          "sequence": 1,
59          "isVisibilityConditional": false,
60          "fields": [
61            {
62              "apiName": "FirstName",
63              "objectApiName": "Referral",
64              "label": "First Name",
65              "dataType": "String",
66              "sequence": 1,
67              "isRequired": true
68            },
69            {
70              "apiName": "LastName",
71              "objectApiName": "Referral",
72              "label": "Last Name",
73              "dataType": "String",
74              "sequence": 2,
75              "isRequired": true
76            }
77          ]
78        }
79      ]
80    }
81  ],
82  "successScreen": {
83    "defaultMessage": {
84      "heading": "Thanks for your referral",
85      "subtitle": "A specialist will contact you within one business day.",
86      "subtitleFormat": "plainText"
87    },
88    "messageRules": []
89  }
90}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
definitionReferral Form Configuration Management InputDetails of the referral form configuration record to create or update, such as its display name, developer name, base entity, and activation status.Required67.0
stepsReferral Form Configuration Step Input[]Ordered list of steps that make up the referral form. Each step contains one or more sections with the fields that end users complete.Optional67.0
successScreenIntake Success Screen Management InputConfiguration details for the success screen that’s shown after a referral is submitted.Optional67.0
welcomeIntake Welcome Management InputConfiguration details for the welcome screen that appears before the first step in the form.Optional67.0

Response Body for PUT 

Referral Form Configuration Response