PromptAction (Beta) | Object Reference for Salesforce and Lightning Platform

As a beta feature, Prompts is a preview and isn’t part of the “Services” under your master subscription agreement with Salesforce. Use this feature at your sole discretion, and make your purchase decisions only on the basis of generally available products and features. Salesforce doesn’t guarantee general availability of this feature within any particular time frame or at all, and we can discontinue it at any time. This feature is for evaluation purposes only, not for production use. It’s offered as is and isn’t supported, and Salesforce has no liability for any harm or damage arising out of or in connection with it. All restrictions, Salesforce reservation of rights, obligations concerning the Services, and terms for related Non-Salesforce Applications and Content apply equally to your use of this feature.

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

Admins have access to add or edit prompts. For non-admin users, assign the Manage Prompts and Modify Metadata user permission. Everyone can see the In-App Guidance setup page.

Supported Calls

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

Fields

Field	Details
LastDisplayDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date the prompt 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 `Not Seen`, `No Action`, `Dismiss`, and `Custom Action`.
LastResultDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date the prompt was last interacted with.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the prompt.
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.
TimesActionTaken	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the user took action on the prompt.
TimesDismissed	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the user dismissed the prompt.
TimesDisplayed	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the prompt was displayed to the user.
UserId	Type reference Properties Create, Filter, Group, Sort, Update Description ID of the user.