MatchingRule

Represents a matching rule that is used to identify duplicate records. This object is available in API version 33.0 and later.

A matching rule compares field values to determine whether a record is similar enough to existing records to be considered a duplicate. For example, a matching rule can specify that if the Email and Phone values of two records match exactly, the records are possible duplicates. Your organization uses matching rules with duplicate rules to define what happens when duplicates are identified.

If the rule is for a Person Account, SobjectSubType is automatically set to PersonAccount.

Supported Calls

describeSObjects()query()retrieve()

Fields

Field Name Details
BooleanFilter
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Specifies filter logic conditions.
Description
Type
textarea
Properties
Filter, Group, Nillable, Sort
Description
The description of the matching rule.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The developer name for the matching rule.
Language
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The language selected for your organization.
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
The name of the matching rule.
MatchEngine
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The match engine used by the matching rule.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix for matching rules for your organization.
RuleStatus
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Required. The activation status of the matching rule. Values are:
  • Inactive
  • Deactivating
  • DeactivationFailed
  • Active
  • Activating
  • ActivationFailed
Important

Important

The only valid values you can declare when deploying a package are Active and Inactive.

SobjectSubType
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable Restricted picklist, Sort
Description
Read-only. Indicates if the matching rule is defined for the Person subtype of Account. Valid values are:
  • PersonAccount
  • None

If the rule is for a Person Account, SobjectSubType is automatically set to PersonAccount.

SobjectType
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The object for the matching rule.

Usage

Use the Salesforce API to retrieve and view details about MatchingRule and MatchingRuleItem. Use the Salesforce Metadata API to create, update, or delete these objects.

See Also