Referrals (PUT)

Create a referral record or update an existing referral record. This API submits the referral through the context service, saves the changes, and returns the IDs of the created or updated records in the response.

Resource 

1/connect/referral-management/referrals

Resource Example 

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

Available Version 

67.0

HTTP Methods 

PUT

Request Body for PUT 

JSON Example 

1{
2  "contextDefinitionId": "0jY5g000000001EAA",
3  "contextMappingName": "ReferralMap",
4  "objects": {
5    "Referral": {
6      "FirstName": "Jordan",
7      "LastName": "Avery",
8      "Email": "jordan.avery@example.com",
9      "Description": "Referred for wealth management services."
10    },
11    "PartyProfile": {
12      "PartyType": "Individual"
13    },
14    "Account": {
15      "Name": "Avery Family Trust"
16    },
17    "Contact": {
18      "Phone": "(415) 555-0142"
19    }
20  }
21}

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
contextDefinitionIdStringID of the context definition to use for this referral intake. If specified, this value overrides the default packaged context definition.Optional67.0
contextMappingNameStringAPI name of the context mapping to use when processing the referral request. If not specified, the API uses the default mapping, ReferralMap.Optional67.0
objectsMap<String, Map<String, Object>>Map of object API names to field values, where each object value is a map of field API names to their corresponding values. Supported object keys are Referral, PartyProfile, Account, and Contact. The Referral key is required. Field API names must match the tag attribute names defined in the context definition.Required67.0

Response Body for PUT 

Referral Response