Referral Assignment Rule

The response representation for a single referral assignment rule.

JSON Example

{
  "isSuccess": true,
  "httpStatusCode": 200,
  "ruleApiName": "Assign_big_home_loans_to_UserB_1779624043348",
  "name": "Assign big home loans to User B",
  "description": "High-value home-loan referrals routed to the senior loan officer.",
  "status": "Active",
  "sortOrder": 10,
  "ruleLogicalExpression": "1 AND 2",
  "conditions": [
    {
      "fieldApiName": "Referral_Product__c",
      "operator": "Equals",
      "values": ["homeloan"],
      "sortOrder": 1
    },
    {
      "fieldApiName": "Referral_Value__c",
      "operator": "GreaterThan",
      "values": ["500000"],
      "sortOrder": 2
    }
  ],
  "assignee": {
    "type": "USER",
    "id": "005xx0000002BBBBB2"
  }
}

Properties

Property Name	Type	Description
`isSuccess`	Boolean	Indicates whether the API operation is successful (`true`) or not (`false`).
`httpStatusCode`	Integer	HTTP status code that indicates the result of the API operation.
`ruleApiName`	String	API name of the rule.
`name`	String	Display name of the referral assignment rule.
`description`	String	Description of the referral assignment rule.
`status`	String	Current status of the referral assignment rule, such as Draft, Active, or Inactive.
`sortOrder`	Integer	Execution sort order of the rule.
`ruleLogicalExpression`	String	Logical expression that determines how conditions are evaluated when a rule has more than one condition. For example, `1 AND 2 AND 3`, `1 OR 2 OR 3`, or a custom expression such as `1 AND (2 OR 3)`.
`conditions`	Referral Assignment Rule Condition[]	Criteria that a referral must satisfy for this assignment rule to match. See Referral Assignment Rule Condition.
`assignee`	Referral Assignment Rule Assignee	User or queue that receives referrals matching this rule. See Referral Assignment Rule Assignee.