Newer Version Available

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

CampaignShare

Represents a sharing entry on a Campaign.

Supported Calls

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

Special Access Rules

As of Summer ’20 and later, only users with access to the Campaign object can access this object.

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
CampaignId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the Campaign associated with this sharing entry. This field can't be updated.
CampaignAccessLevel
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Level of access that the User or Group has to the Campaign. The possible values are:
  • Read
  • Edit
  • All (This value is not valid for creating or updating records.)
This field must be set to an access level that is higher than the organization’s default access level for Campaign.
RowCause
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Reason that this sharing entry exists. You can only write to 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.
Valid values:
  • Rule—The User or Group has access via a Campaign sharing rule.
  • GuestRule—The User or Group has access via a Campaign guest user sharing rule.
  • Manual—The User or Group has access because a User with “All” access manually shared the Campaign with them.
  • Owner—The User is the owner of the Campaign.
  • LpuImplicit—The User has access to records owned by high-volume community and portal users via a share group.
  • ARImplicit—The User, who belongs to a partner or customer account, has access to the Campaign via an account relationship data sharing rule.
UserOrGroupId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the User or Group that has been given access to the Campaign. This field can't be updated.

Usage

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