Referral Assignment Rules

Use these resources to create, retrieve, update, delete, activate, deactivate, and reorder referral assignment rules, and to get metadata for building rule conditions. Referral assignment rules automatically assign referrals to a user or queue when the referral matches the rule conditions.

Referral Assignment Rule (DELETE)
Delete a draft or inactive assignment rule and its related rule configuration. Before deleting an active assignment rule, you must deactivate it.
Referral Assignment Rule (GET)
Get the details of a single referral assignment rule by its API name, including status, sort order, conditions, and assignee.
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.
Referral Assignment Rule Status (PATCH)
Activate or deactivate a referral assignment rule. Active rules are used to automatically assign referrals to the right user or queue. Inactive rules are saved but not used.
Referral Assignment Rules (GET)
Get the details of all referral assignment rules sorted by sequence number.
Referral Assignment Rules (POST)
Create a draft referral assignment rule with conditions and an assignee. The rule isn’t active until you activate it separately.
Referral Assignment Rules Condition Metadata (GET)
Get metadata such as fields and supported operators for building referral assignment rule conditions.
Referral Assignment Rules Reorder (PATCH)
Update the evaluation order of referral assignment rules. Lower sort order values are evaluated first. Rules that aren’t included in the request keep their current order.