---
schema_version: "1"
id: 2a15314fb51b37cdcd021e16e11c6d60497ceb5a50f5f9c9eb14ef7954715017
title: Referral Assignment Rule Status (PATCH)
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/financial_services_cloud_object_reference/connect_resources_referral_assignment_rule_status.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/connect_resources_referral_assignment_rule_status.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 58159f9fceb353e94f452d2e637bc32ce9f6245220d18da32e3d90869e7f41e4
description: 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 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

<table class="featureTable sort_table" summary="">




            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader vertical-align-top " id="d176763e173">Property Name</th>

                <th class="featureTableHeader vertical-align-top " id="d176763e176">Type</th>

                <th class="featureTableHeader vertical-align-top " id="d176763e179">Description</th>

                <th class="featureTableHeader vertical-align-top " id="d176763e182">Required</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d176763e173" data-title="Property Name"><samp class="codeph nolang">status</samp></td>

                <td class="entry" headers="d176763e176" data-title="Type">String</td>

                <td class="entry" headers="d176763e179" data-title="Description">Status of the assignment rule to update. Valid values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph nolang">Active</samp></li>

                    <li class="li"><samp class="codeph nolang">Inactive</samp></li>

                  </ul>
                  You can activate a draft or inactive rule, and you can deactivate a draft
                  or active rule.</td>

                <td class="entry" headers="d176763e182" data-title="Required">Required</td>

              </tr>

            </tbody>

          </table>

## Response Body for PATCH

[Referral Assignment Rule Status Update](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/connect_responses_referral_assignment_rule_status_output.htm "The response representation returned after activating or deactivating a referral assignment rule.")