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

/connect/referral-management/form-configurations

Resource Example

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

Available Version

67.0

HTTP Methods

GET, PUT

Query Parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`activeOnly`	Boolean	Indicates 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.	Optional	67.0
`offset`	Integer	Zero-based index of the first record to return. Use with `pageSize` to page through the results.	Optional	67.0
`pageSize`	Integer	Maximum number of records to return in a page. Use with `offset` to page through the results.	Optional	67.0
`search`	String	Text to search forms that contain the specified text.	Optional	67.0

Response Body for GET

Referral Form Configuration List

Request Body for PUT

JSON Example

{
  "definition": {
    "id": null,
    "name": "New Client Onboarding Referral",
    "developerName": "New_Client_Onboarding_Referral",
    "description": "Referral intake form for onboarding new clients.",
    "baseEntity": "Referral",
    "contextDefinitionId": "0jY0x0000000001EAA",
    "isActive": true,
    "shouldShowNavigationSteps": true,
    "shouldShowSummaryStep": true
  },
  "welcome": {
    "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": [{
        "id": "a1D5g000000ABcn",
        "sequence": 1,
        "isRequired": true,
        "consentText": "I agree to the terms of service.",
        "consentLinkUrl": "https://www.example.com/terms",
        "consentLinkLabel": "View terms",
        "consentVersion": "1.0",
        "capturedFieldApiName": "HasConsented__c",
        "capturedTimestampFieldApiName": "ConsentTimestamp__c",
        "bodyFormat": "html",
        "body": "<p>Full terms and conditions...</p>"
      }],
    "fields": [{
        "id": "a1A5g000000ABwx",
        "sequence": 1,
        "apiName": "Email",
        "label": "Email Address",
        "type": "Email",
        "isRequired": true,
        "helpText": "We'll use this to contact you about your referral.",
        "description": "Applicant's primary email address.",
        "displayAs": "singleLine",
        "placeholder": "name@example.com",
        "defaultValue": null,
        "hidden": false,
        "readOnly": false,
        "targetObjectApiName": null
      }]
  },
  "steps": [
    {
      "label": "Applicant Information",
      "sequence": 1,
      "isVisibilityConditional": false,
      "sections": [
        {
          "label": "Applicant Details",
          "sequence": 1,
          "isVisibilityConditional": false,
          "fields": [
            {
              "apiName": "FirstName",
              "objectApiName": "Referral",
              "label": "First Name",
              "dataType": "String",
              "sequence": 1,
              "isRequired": true
            },
            {
              "apiName": "LastName",
              "objectApiName": "Referral",
              "label": "Last Name",
              "dataType": "String",
              "sequence": 2,
              "isRequired": true
            }
          ]
        }
      ]
    }
  ],
  "successScreen": {
    "defaultMessage": {
      "heading": "Thanks for your referral",
      "subtitle": "A specialist will contact you within one business day.",
      "subtitleFormat": "plainText"
    },
    "messageRules": []
  }
}

Properties

Name	Type	Description	Required or Optional	Available Version
`definition`	Referral Form Configuration Management Input	Details of the referral form configuration record to create or update, such as its display name, developer name, base entity, and activation status.	Required	67.0
`steps`	Referral 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.	Optional	67.0
`successScreen`	Intake Success Screen Management Input	Configuration details for the success screen that's shown after a referral is submitted.	Optional	67.0
`welcome`	Intake Welcome Management Input	Configuration details for the welcome screen that appears before the first step in the form.	Optional	67.0

Response Body for PUT

Referral Form Configuration Response