---
schema_version: "1"
id: cace27c9323c7602e0ebc98d04910df37e6dfe81c6791f76b3de3e68166e1b51
title: Referral Form Configurations (GET, PUT)
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/financial_services_cloud_object_reference/connect_resources_referral_form_configuration.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/connect_resources_referral_form_configuration.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 722ef461f26f9b01ec5a7a581430adfb9b1e9feede7bfe713bbe8132738f3908
description: 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.
---
# 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](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/connect_responses_referral_form_configuration_list.htm "Output representation of a paginated list of referral form configuration records that match the request filters, along with metadata and the overall API response status.")

## 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](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/connect_requests_referral_form_configuration_management_input.htm "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.") | 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](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/connect_requests_referral_form_configuration_step_input_rep.htm "Input representation of a single step within a referral form configuration record, including its layout order, optional visibility criteria, and list of sections.")\[\] | 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](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/connect_requests_intake_success_screen_management_input.htm "Input representation of the success-screen configuration for a referral intake form, including the default message and any conditional message rules.") | Configuration details for the success screen that's shown after a referral is submitted. | Optional | 67.0 |
| welcome | [Intake Welcome Management Input](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/connect_requests_intake_welcome_management_input.htm "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.") | 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](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/connect_responses_referral_form_configuration_output.htm "Output representation of the details after a referral form configuration record is created or updated. The response includes the ID of the saved record, the HTTP status, and a human-readable status message.")