Newer Version Available

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

SharedTo

SharedTo defines the sharing access for a list view or a folder. It can be used to specify the target and source for owner-based sharing rules.

See Sharing Considerations and Public and Personal Groups in Salesforce Help.

SharedTo is included in the metadata for shared and private list views. SharedTo isn’t in the metadata for public list views.

Note

Declarative Metadata File Suffix and Directory Location

SharedTo is used with ListView, Folder, and SharingRules.

Version

SharedTo is available in API version 17.0 and later.

Fields

Field Field Type Description
allCustomerPortalUsers string A group containing all customer portal users.

This field is available in API version 24.0 and later.

allInternalUsers string A group containing all internal and nonportal users.

This field is available in API version 24.0 and later.

allPartnerUsers string A group containing all partner users.

This field is available in API version 24.0 and later.

channelProgramGroup string A system-managed group with sharing access containing all partner members of the corresponding channel program or level.

This field is available in API version 41.0 and later.

channelProgramGroups string[] A list of system-managed groups with sharing access containing all partner members of the corresponding channel programs or levels.

This field is available in API version 41.0 and later.

group string[] A list of groups with sharing access. Use this field instead of the groups field.

This field is available in API version 22.0 and later.

guestUser string[] A list of guest user nicknames with sharing access. This field can be used only with SharingGuestRule.

This field is available in API version 47.0 and later.

groups string[] A list of groups with sharing access.

Use the group field instead for API version 22.0 and later.

managerSubordinates string[] A list of users whose direct and indirect subordinates receive sharing access. This field is available in API version 24.0 and later.
managers string[] A list of users whose direct and indirect managers receive sharing access. This field is available in API version 24.0 and later.
portalRole string[] A list of groups with sharing access containing all users in a portal role.

This field is available in API version 24.0 and later.

portalRoleandSubordinates string[] A list of groups with sharing access containing all users in a portal role or any users under that role.

This field is available in API version 24.0 and later.

role string[] A list of roles with sharing access. Use this field instead of the roles field.

This field is available in API version 22.0 and later.

roleAndSubordinates string[] A list of roles with sharing access. All roles below each of these roles in the role hierarchy also have sharing access. If portal accounts are enabled, then all roles and portal accounts below each of these roles in the role hierarchy also have sharing access. Use this field instead of the rolesAndSubordinates field.

This field is available in API version 22.0 and later. In Salesforce orgs created before February 8, 2024, this field is available by default. In orgs created on February 8, 2024 or later, this field is only available after digital experiences is enabled.

roleAndSubordinatesInternal string[] A list of roles with sharing access. All roles below each of these roles in the role hierarchy also have sharing access.

This field is available in API version 22.0 and later. In Salesforce orgs created before February 8, 2024, this value is only available after digital experiences is enabled. In orgs created on February 8, 2024 or later, this value is available by default.

roles string[] A list of roles with sharing access.

Use the role field instead for API version 22.0 and later.

rolesAndSubordinates string[] A list of roles with sharing access. All roles below each of these roles in the role hierarchy also have sharing access. If portal accounts are enabled, then all roles and portal accounts below each of these roles in the role hierarchy also have sharing access.

Use the roleAndSubordinates field instead for API version 22.0 and later.

territories string[] A list of territories with sharing access.

Use the territory field instead for API version 22.0 and later.

territoriesAndSubordinates string[] A list of territories with sharing access. All territories below each of these territories in the territory hierarchy also have sharing access.

Use the territoryAndSubordinates field instead for API version 22.0 and later.

territory string[] A list of territories with sharing access. Use this field instead of the territories field.

If you’re using Enterprise Territory Management, use modelName.territoryName for the shared-to and shared-from territory values, where:

  • modelName equals the name of the active territory model in the API.
  • territoryName equals the territory’s name in the API.

This field is available in API version 22.0 and later.

territoryAndSubordinates string[] A list of territories with sharing access. All territories below each of these territories in the territory hierarchy also have sharing access. Use this field instead of the territoriesAndSubordinates field.

If you’re using Enterprise Territory Management, use modelName.territoryName for the shared-to and shared-from territoryAndSubordinates values, where:

  • modelName equals the name of the active territory model in the API.
  • territoryName equals the territory’s name in the API.

This field is available in API version 22.0 and later.

queue string[] A list of queues with sharing access. Applies only to lead, case, and CustomObject sharing rules.

This field is available in API version 24.0 and later.