Referral Form Configuration Definitions (DELETE, GET, PATCH)

Retrieve, activate, deactivate, or delete a referral form configuration definition and its related configurations by the definition ID. This API updates only the definition’s activation status and doesn’t modify its steps, sections, fields, or other configuration settings.

Resource 

1/connect/referral-management/form-configuration-definitions/DEFINITION_ID

Resource Example 

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

Available Version 

67.0

HTTP Methods 

DELETE, GET, PATCH

Path Parameter for DELETE, GET, and PATCH 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
definitionIdStringID of the referral form configuration definition.Required67.0

Response Body for DELETE 

Referral Form Configuration Definition Delete

Response Body for GET 

Referral Form Configuration Definition Detail

Request Body for PATCH 

JSON Example 

1{
2  "isActive": true
3}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
isActiveBooleanIndicates whether to activate the referral form configuration definition (true) or deactivate it (false).Required67.0

Response Body for PATCH 

Referral Form Definition Status Update