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
/connect/referral-management/referrals
Resource Example
https://yourInstance.salesforce.com/services/data/v68.0/connect/referral-management/referrals
Available Version
67.0
HTTP Methods
PUT
Request Body for PUT
JSON Example
{
"contextDefinitionId": "0jY5g000000001EAA",
"contextMappingName": "ReferralMap",
"objects": {
"Referral": {
"FirstName": "Jordan",
"LastName": "Avery",
"Email": "jordan.avery@example.com",
"Description": "Referred for wealth management services."
},
"PartyProfile": {
"PartyType": "Individual"
},
"Account": {
"Name": "Avery Family Trust"
},
"Contact": {
"Phone": "(415) 555-0142"
}
}
}
Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| contextDefinitionId | String | ID of the context definition to use for this referral intake. If specified, this value overrides the default packaged context definition. | Optional | 67.0 |
| contextMappingName | String | API name of the context mapping to use when processing the referral request. If not specified, the API uses the default mapping, ReferralMap. | Optional | 67.0 |
| objects | Map<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. | Required | 67.0 |