LeadShare

Represents a sharing entry on a Lead.

Supported Calls

describeSObjects(), query(), retrieve()

Fields

The properties available for some fields depend on the default organization-wide sharing settings. The properties listed are true for the default settings of such fields.

Field Details
IsDeleted
Type
boolean
Properties
Defaulted on create, Filter
Description
Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
LeadAccessLevel
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Level of access that the User or Group has to the Lead. The possible values are:
  • Read
  • Edit
  • All This value is not valid when creating or updating these records.
This field must be set to an access level that is higher than the organization’s default access level for leads.
LeadId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the Lead associated with this sharing entry. This field can’t be updated.
RowCause
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Reason that this sharing entry exists. You can only write a value in this field when its value is either omitted or set to Manual (default). You can create a value for this field in API versions 32.0 and later with the correct organization-wide sharing settings.
Values include:
  • Manual—The User or Group has access because a user with “All” access manually shared the Lead with them.
  • Owner—The User is the owner of the Lead.
  • Rule—The User or Group has access via a Lead sharing rule.
UserOrGroupId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the User or Group that has been given access to the Lead. This field can’t be updated.

Usage

This object allows you to determine which users and groups can view or edit leads owned by other users.

If you attempt to create a record that matches an existing record, the existing record is returned.

See Also