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

/connect/referral-management/assignment-rules/ruleApiName/status

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

{
  "status": "Active"
}

Properties

Property Name	Type	Description	Required
`status`	String	Status 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