PromptAction | Object Reference for Salesforce and Lightning 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 completes.

Supported Calls

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

Special Access Rules

Admins have access to add or edit prompts and walkthroughs. For non-admin users, assign the Manage Prompts and Modify Metadata Through Metadata API Functions user permission. Everyone can see the In-App Guidance setup page. To show walkthroughs to users, use the View Walkthroughs user permission, which is part of the Walkthroughs permission set license. The myTrailhead subscription includes this feature. For pricing details, contact your Salesforce account executive. But, you don’t have to start the trial or purchase a license to create, preview, or package walkthroughs. Note the restrictions on user visibility of the walkthroughs you create in the Packaging and Prompts and Walkthroughs section.

Fields

Field	Details
LastDisplayDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date the in-app guidance was last displayed to the user.
LastResult	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the last user interaction. Valid values are: `CustomAction` `Dismiss` `Error` `Finish`—(walkthroughs only) `NoAction` `NotSeen` `Snooze`
LastResultDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date the in-app guidance was last interacted with.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the in-app guidance.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner.
PromptVersionId	Type reference Properties Create, Filter, Group, Sort, Update Description ID of the PromptVersion object.
SnoozeUntil	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The timestamp for when the user’s snooze request expires. The user won’t see the prompt again until the next scheduled time when they navigate to the page after the snooze time expires.
StepCount	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the total number of steps in the walkthrough. Available in API version 49.0 and later.
StepNumber	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the number of the last step the user viewed or interacted with in a walkthrough. Maximum value is 10. Available in API version 49.0 and later.
TimesActionTaken	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the user took action on the in-app guidance.
TimesDismissed	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the user dismissed the in-app guidance.
TimesDisplayed	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the in-app guidance was displayed to the user.
TimesSnoozed	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of times the user snoozes the prompt.
UserId	Type reference Properties Create, Filter, Group, Sort, Update Description ID of the user.

Associated Objects

This object has the following associated objects. They are available in API version 46.0 and later.

PromptActionOwnerSharingRule: Sharing rules are available for the object.
PromptActionShare: Sharing is available for the object.