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.

Resource 

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

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  "status": "Active"
3}

Properties 

Property NameTypeDescriptionRequired
statusStringStatus of the assignment rule to update. Valid values are:
  • Active
  • Inactive
You can activate a draft or inactive rule, and you can deactivate a draft or active rule.
Required

Response Body for PATCH 

Referral Assignment Rule Status Update