Referral Assignment Rule Input

The request payload used to create a draft referral assignment rule.

JSON Example

{
  "name": "Assign big home loans to User B",
  "description": "High-value home-loan referrals routed to the senior loan officer.",
  "sortOrder": 10,
  "ruleLogicalExpression": "1 AND 2",
  "conditions": [
    {
      "fieldApiName": "Referral_Product__c",
      "operator": "Equals",
      "values": ["homeloan"]
    },
    {
      "fieldApiName": "Referral_Value__c",
      "operator": "GreaterThan",
      "values": ["500000"]
    }
  ],
  "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
`sortOrder`	Integer	Order in which this rule is evaluated. Lower values are evaluated first.	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