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
/connect/referral-management/assignment-rules/ruleApiName
Available Version
67.0
HTTP Methods
PATCH
URI Parameters
| Parameter Name | Type | Description | Required |
|---|---|---|---|
| ruleApiName | String | The server-generated API name of the referral assignment rule. | Required |
Request Body for PATCH
JSON Example
{
"name": "Assign big home loans to User B (rev 2)",
"description": "Now routed to Loan Officer Team B (updated 2026-05-12).",
"ruleLogicalExpression": "1 AND 2",
"conditions": [
{
"fieldApiName": "Referral_Product__c",
"operator": "Equals",
"values": ["homeloan"]
},
{
"fieldApiName": "Referral_Value__c",
"operator": "GreaterThan",
"values": ["750000"]
}
],
"assignee": {
"type": "USER",
"id": "005xx0000002BBBBB2"
}
}
Properties
| Property Name | Type | Description | Required |
|---|---|---|---|
| name | String | Display name for the referral assignment rule. The maximum supported length is up to 80 characters. | Required |
| description | String | Description of the business purpose of the rule. The maximum supported length is up to 255 characters. | Optional |
| ruleLogicalExpression | String | Logical 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 |
| conditions | Referral Assignment Condition Input[] | Criteria that a referral must satisfy for this assignment rule to match. See Referral Assignment Condition Input. | Required |
| assignee | Referral Assignment Assignee Input | User or queue that receives referrals matching this rule. See Referral Assignment Assignee Input. | Required |