Referral Assignment Rule (PATCH)

Update a draft or inactive assignment rule, including its name, description, conditions, condition requirement, and assignee. Include the complete rule definition in the request body. This API replaces the entire schema of an assignment rule definition. Before updating an active rule, deactivate it.

Resource 

1/connect/referral-management/assignment-rules/RULE_API_NAME

Available Version 

67.0

HTTP Methods 

PATCH

URI Parameters 

Parameter NameTypeDescriptionRequired
ruleApiNameStringThe server-generated API name of the referral assignment rule.Required

Request Body for PATCH 

JSON Example 

1{
2  "name": "Assign big home loans to User B (rev 2)",
3  "description": "Now routed to Loan Officer Team B (updated 2026-05-12).",
4  "ruleLogicalExpression": "1 AND 2",
5  "conditions": [
6    {
7      "fieldApiName": "Referral_Product__c",
8      "operator": "Equals",
9      "values": ["homeloan"]
10    },
11    {
12      "fieldApiName": "Referral_Value__c",
13      "operator": "GreaterThan",
14      "values": ["750000"]
15    }
16  ],
17  "assignee": {
18    "type": "USER",
19    "id": "005xx0000002BBBBB2"
20  }
21}

Properties 

Property NameTypeDescriptionRequired
nameStringDisplay name for the referral assignment rule. The maximum supported length is up to 80 characters.Required
descriptionStringDescription of the business purpose of the rule. The maximum supported length is up to 255 characters.Optional
ruleLogicalExpressionStringLogical expression that determines how conditions are evaluated when a rule has more than one condition. For example, use 1 AND 2 AND 3 when the referral must match every condition, 1 OR 2 OR 3 when it must match at least one, or a custom expression such as 1 AND (2 OR 3) for a specific combination.Optional
conditionsReferral Assignment Condition Input[]Criteria that a referral must satisfy for this assignment rule to match. See Referral Assignment Condition Input.Required
assigneeReferral Assignment Assignee InputUser or queue that receives referrals matching this rule. See Referral Assignment Assignee Input.Required

Response Body for PATCH 

Referral Assignment Rule