PromptActionShare | Object Reference for the Salesforce Platform

Use prompts and walkthroughs to display announcements, training, or news to users within the app. Choose to add an action button or link that links to a URL of your choice. Track views, action button clicks, and walkthrough completions.

You can only create, edit, and delete sharing entries for standard objects whose RowCause field is set to Manual. Sharing entries for standard objects with different RowCause values are created as a result of your Salesforce org’s sharing configuration and are read-only. For some sharing mechanisms, such as sharing sets, sharing entries aren’t stored at all.

While Salesforce currently maintains read-only sharing entries for multiple sharing mechanisms, it’s possible that we’ll stop storing certain share records to improve performance. As a best practice, don’t create customizations that rely on the availability of these sharing entries. Any changes to sharing behavior will be communicated before they occur.

Note

Supported Calls

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

Special Access Rules

To add, edit, and manage prompts and walkthroughs as an admin, the Modify All Data or Customize Application permission is required.
To add, edit, and manage prompts and walkthroughs as a user who isn’t an admin, the Manage Prompts and View All Profiles permission is required.
To have more than three custom walkthroughs active at a time, purchase the Enablement add-on license and assign the Use Custom Walkthroughs permission set, which uses the Walkthroughs permission set license.

Fields

Field	Details
AccessLevel	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the access level of users for in-app guidance. Valid values are `Read`, `Edit`, and `All`.
ParentId	Type reference Properties Create, Filter, Group, Sort Description ID of the parent.
RowCause	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reason that this sharing entry exists. If you’re creating a sharing entry, the only permitted value is `Manual`. If no value is specified, the field defaults to `Manual`. All other RowCause values are read-only. After the sharing entry is created, this field can’t be edited. Valid values include: `Rule`—The User or Group has access via a sharing rule. `GuestRule`—The User or Group has access via a guest user sharing rule. `Manual`—The User or Group has access because a User with “All” access manually shared the prompt action with them. `Owner`—The User is the owner of the prompt action.
UserOrGroupId	Type reference Properties Create, Filter, Group, Sort Description The ID of the User or Group.