--- schema_version: "1" id: 7ba673b7c06ea981c0b844ca5dfb5512cdc5104a2dd9213e889519a75545695f title: CriteriaBasedSharingRule collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_cbsrule.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_cbsrule.htm source_site: developer.salesforce.com content_type: documentation content_hash: 1a805b6e30acf0cef3c05341ed35a4730576abadbda8d47ddb2f821512695fc5 description: This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingRules instead. Represents a criteria-based sharing rule. CriteriaBasedSharingRule enables you to share records based on specific criteria. --- # CriteriaBasedSharingRule This component is removed as of API version 33.0 and is available in earlier versions only. Use [SharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm "Represents the base container for sharing rules, which can be criteria-based, ownership-based, territory-based, or for guest user access. SharingRules enables you to share records with a set of users, using rules that specify the access level for the target user group.") instead. Represents a criteria-based sharing rule. CriteriaBasedSharingRule enables you to share records based on specific criteria. It extends the [BaseSharingRule](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_basesharingrule.htm "This component is removed as of API version 33.0 and is available in earlier versions only. Use SharingBaseRule instead. Represents the base container for criteria-based and owner-based sharing rules.") metadata type and inherits its sharedTo field. For more information, see “Criteria-Based Sharing Rules Overview” in Salesforce Help. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png) #### Note You can’t create a CrteriaBasedSharingRule component directly. Use the child components instead. ## Declarative Metadata File Suffix and Directory Location CriteriaBasedSharingRule components are stored within the SharingRules component in the criteriaBasedRules field. ## Version CriteriaBasedSharingRule components are available in API version 24.0 and later. ## Special Access Rules As of Spring ’20 and later, only users with the View Setup and Configuration permission can access this object, and only users with the Manage Sharing permission can edit this object. ## Fields The following information assumes that you’re familiar with implementing sharing rules for standard objects and custom objects. For more information on these fields, see Sharing Settings in Salesforce Help.
Field Field Type Description
criteriaItems FilterItem[] List that represents the criteria for the sharing rule. The possible values are:
  • field
  • operation
  • value
## AccountCriteriaBasedSharingRule Represents a criteria-based sharing rule for accounts. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field. AccountCriteriaBasedSharingRule is used by the criteriaBasedRules field in [AccountSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#AccountSharingRules).
Field Field Type Description
accountAccessLevel ShareAccessLevelNoNone (enumeration of type string) Required. A value that represents the level of access that the user or group has to the account. The possible values are:
  • Read
  • Edit
  • All
booleanFilter string Represents the filter logic of the sharing rule.
caseAccessLevel ShareAccessLevelNoAll (enumeration of type string) Required. A value that represents the level of access that the user or group has to cases associated with the account. The possible values are:
  • None
  • Read
  • Edit
contactAccessLevel ShareAccessLevelNoAll (enumeration of type string) Required. A value that represents the level of access that the user or group has to contacts associated with the account. The possible values are:
  • None
  • Read
  • Edit
description string Represents the description of the sharing rule. Maximum of 1000 characters.

This field is available in API version 29.0 and later.
name string Required. Name for the sharing rule. Corresponds to Label in the user interface.
opportunityAccessLevel ShareAccessLevelNoAll (enumeration of type string) Required. A value that represents the level of access that a target group is granted for any associated opportunity. The possible values are:
  • None
  • Read
  • Edit
## CampaignCriteriaBasedSharingRule Represents a criteria-based sharing rule for campaigns. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field. CampaignCriteriaBasedSharingRule is used by the criteriaBasedRules field in [CampaignSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#CampaignSharingRules).
Field Field Type Description
booleanFilter string Represents the filter logic of the sharing rule.
description string Represents the description of the sharing rule. Maximum of 1000 characters. This field is available in API version 29.0 and later.
campaignAccessLevel ShareAccessLevelNoNone (enumeration of type string) Required. A value that represents the level of access that a target group is granted for a campaign. The possible values are:
  • Read
  • Edit
  • All
name string Required. Name for the sharing rule. Corresponds to Label in the user interface.
## CaseCriteriaBasedSharingRule Represents a criteria-based sharing rule for cases. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field. CaseCriteriaBasedSharingRule is used by the criteriaBasedRules field in [CaseSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#CaseSharingRules).
Field Field Type Description
booleanFilter string Represents the filter logic of the sharing rule.
description string Represents the description of the sharing rule. Maximum of 1000 characters.

This field is available in API version 29.0 and later.
caseAccessLevel ShareAccessLevelReadEdit (enumeration of type string) Required. A value that represents the level of access being granted for a case. The possible values are:
  • Read
  • Edit
name string Required. Name for the sharing rule. Corresponds to Label in the user interface.
## ContactCriteriaBasedSharingRule Represents a criteria-based sharing rule for contacts. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field. ContactCriteriaBasedSharingRule is used by the criteriaBasedRules field in [ContactSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#ContactSharingRules).
Field Field Type Description
booleanFilter string Represents the filter logic of the sharing rule.
description string Represents the description of the sharing rule. Maximum of 1000 characters.

This field is available in API version 29.0 and later.
contactAccessLevel ShareAccessLevelReadEdit (enumeration of type string) Required. A value that represents the level of access being granted to the target group, role, or user for a contact. The possible values are:
  • Read
  • Edit
name string Required. Name for the sharing rule. Corresponds to Label in the user interface.
## LeadCriteriaBasedSharingRule Represents a criteria-based sharing rule for leads. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field. LeadCriteriaBasedSharingRule is used by the criteriaBasedRules field in [LeadSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#LeadSharingRules).
Field Field Type Description
booleanFilter string Represents the filter logic of the sharing rule.
description string Represents the description of the sharing rule. Maximum of 1000 characters. This field is available in API version 29.0 and later.
leadAccessLevel ShareAccessLevelReadEdit (enumeration of type string) Required. A value that represents the level of allowed access. The possible values are:
  • Read
  • Edit
name string Required. Name for the sharing rule. Corresponds to Label in the user interface.
## OpportunityCriteriaBasedSharingRule Represents a criteria-based sharing rule for opportunities. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field. OpportunityCriteriaBasedSharingRule is used by the criteriaBasedRules field in [OpportunitySharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#OpportunitySharingRules).
Field Field Type Description
booleanFilter string Represents the filter logic of the sharing rule.
description string Represents the description of the sharing rule. Maximum of 1000 characters.

This field is available in API version 29.0 and later.
opportunityAccessLevel ShareAccessLevelReadEdit (enumeration of type string) Required. A value that represents the level of allowed access. The possible values are:
  • Read
  • Edit
name string Required. Name for the sharing rule. Corresponds to Label in the user interface.
## CustomObjectCriteriaBasedSharingRule Represents a criteria-based sharing rule for custom objects. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field. CustomObjectCriteriaBasedSharingRule is used by the criteriaBasedRules field in [CustomObjectSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#CustomObjectSharingRules).
Field Field Type Description
accessLevel string Required. A value that represents the type of allowed sharing. The possible values are:
  • Read
  • Edit
  • All
booleanFilter string Represents the filter logic of the sharing rule.
description string Represents the description of the sharing rule. Maximum of 1000 characters.

This field is available in API version 29.0 and later.
name string Required. Name for the sharing rule. Corresponds to Label in the user interface.
## UserCriteriaBasedSharingRule Represents a criteria-based sharing rule for users. It extends the CriteriaBasedSharingRule metadata type and inherits its criteriaItems field. UserCriteriaBasedSharingRule is used by the criteriaBasedRules field in [UserSharingRules](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_sharingrules.htm#UserSharingRules).
Field Field Type Description
booleanFilter string Represents the filter logic of the sharing rule.
description string Represents the description of the sharing rule. Maximum of 1000 characters.

This field is available in API version 29.0 and later.
name string Required. Name for the sharing rule. Corresponds to Label in the user interface.
userAccessLevel ShareAccessLevelReadEdit (enumeration of type string) Required. A value that represents the type of allowed sharing. The possible values are:
  • Read
  • Edit
## Declarative Metadata Sample Definition The following is the definition of two owner-based sharing rules and one criteria-based sharing rule containing two criteria items. The file name corresponds to the Account.sharingRules file under the accountSharingRules directory. G1Dev\_G2New G2New G1Dev Read None Read G2New\_R1New R1New G2New Edit Read Edit G2New\_R1New None AccountCriteria G1 BillingCity equals San Francisco MyChkBox\_\_c notEqual False Read 1 OR 2 None Read AccountCriteria None ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders."). - [← Previous](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_basesharingrule.htm "BaseSharingRule") - [Next →](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ownersharingrule.htm "OwnerSharingRule")