AccountRelationshipShareRule

Represents the rule that determines which object records are shared, how they are shared, the account relationship type that shares the records, and the level of access granted to the records. This object is available in API version 45.0 and later.

Supported Calls

create(), delete(), describeLayout(). describeSObjects(), query(), retrieve(), update(). upsert()

Fields

Field Details
AccessLevel
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Type of access granted by the share rule. Valid values are:
  • Read (Read Only)
  • Edit (Read/Write)
AccountToCriteriaField
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Criteria that must be met for the data to be shared.
Possible values are:
  • Account.OwnerId
  • Account.ParentId
  • Campaign.OwnerId
  • Case.AccountId
  • Case.OwnerId
  • Contact.AccountId
  • Contact.OwnerId
  • Lead.ConvertedAccountId
  • Lead.OwnerId
  • Lead.PartnerAccountId
  • Opportunity.PartnerAccountId
  • Order.AccountId
  • Order.ActivatedById
  • Order.CompanyAuthorizedById
  • Order.OwnerId
  • PartnerFundAllocation.CreatedById
  • PartnerFundAllocation.ChannelPartnerId
  • PartnerFundAllocation.OwnerId
  • PartnerFundClaim.CreatedById
  • PartnerFundClaim.OwnerId
  • PartnerFundRequest.ChannelPartnerId
  • PartnerFundRequest.CreatedById
  • PartnerFundRequest.OwnerId
  • PartnerMarketingBudget.CreatedById
  • PartnerMarketingBudget.ChannelPartnerId
  • PartnerMarketingBudget.OwnerId
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
A meaningful explanation of the sharing rule.
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated but you can supply your own value if you create the record using the API.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

Note

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

Note

EntityType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of data shared by this rule. Values are:
  • Account
  • Campaign
  • Case
  • Contact
  • Lead
  • Order
  • PartnerFundAllocation
  • PartnerFundClaim
  • PartnerFundRequest
  • PartnerMarketingBudget
Language
Type
picklist
Properties
Create, Defaulted on create. Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the account relationship share rule.
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The label assigned to the sharing rule to identify it.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values.

  • In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
  • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
StaticFormulaCriteria
Type
string
Properties
Create, Filter, Nillable, Sort, Update
Description
A way to further filter what data gets shared. This must be a deterministic formula and spanning is not allowed.
Type
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Must match the type of an account relationship for data to be shared according to the AccountToCriteriaField and the StaticForumulaCriteria.