Newer Version Available

This content describes an older version of this product. View Latest

AccountTerritorySharingRule

Represents the rules for sharing an Account within a Territory.

The original territory management feature is scheduled for retirement for all customers as of Summer ’21. After the feature is retired, users can’t access the original territory management feature and its underlying data. We encourage you to migrate to Enterprise Territory Management. We also strongly recommend that you keep a comprehensive backup of your territory data while you’re still using the original territory management feature. For more information, see The Original Territory Management Module Will Be Retired in the Summer ’21 Release. The information in this topic applies to the original territory management feature only, and not to Enterprise Territory Management.

Note

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Special Access Rules

Customer Portal users can't access this object.

Fields

Field Details
AccountAccessLevel
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
A value that represents the type of sharing being allowed. The possible values are:
  • Read
  • Edit
  • All
CaseAccessLevel
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
A value that represents the type of access granted to the target group for all child cases of the account. The possible values are:
  • None
  • Read
  • Edit
ContactAccessLevel
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
A value that represents the type of access granted to the target group for all related contacts on the account. The possible values are:
  • None
  • Read
  • Edit

This field is read only.

Note

Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
A description of the sharing rule. Maximum size is 1000 characters. This field is available in API version 29.0 and later.
DeveloperName
Type
string
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The unique name of the object 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. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Corresponds to Rule Name in the user interface.

This field is available in API version 24.0 and later.

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

GroupId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the source group. Accounts owned by users in the source territory trigger the rule to give access.
Name
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Label of the sharing rule as it appears in the user interface. Limited to 80 characters. Corresponds to Label on the user interface.
OpportunityAccessLevel
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
A value that represents the type of access granted to the target group for all opportunities associated with the account. The possible values are:
  • None
  • Read
  • Edit
UserOrGroupId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID representing the user or group being given access, or, if a territory ID, the users assigned to that territory.

Usage

Use this object to manage the sharing rules for a particular object. General sharing and Territory-related sharing use this object.