PromptError | 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 completions.

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 user permission. Everyone can see the In-App Guidance setup page. To show more than three walkthroughs to users, use the View Walkthroughs user permission, which is part of the Walkthroughs permission set license. The Sales Enablement (myTrailhead) subscription includes this feature. For pricing details, contact your Salesforce account executive. Note the restrictions on user visibility of the walkthroughs you create in the Packaging Prompts and Walkthroughs section.

Fields

Field	Details
IsError	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the in-app guidance had an error true or a warning false. The default is false.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the PromptError record.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the User or Group.
PromptActionId	Type reference Properties Create, Filter, Group, Sort, Update Description ID of the PromptAction that the PromptError is related to.
StepNumber	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the step number that the user encountered an error or warning in a walkthrough.
Type	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the type of error or warning. Possible values are: `NoAccessToApp`—A step on this walkthrough is on an app that some of your users don’t have access to. `NoAccessToPage`—A step on the walkthrough is on a page that some of your users don’t have access to. `ReferenceElementNotFound`—The target element has moved or is no longer on your page. Targeted prompts attached to unavailable elements convert to floating prompts. Check your access to the element, or enter targeting mode and reassign the targeted prompt. `Unavailable`—Users tried to open this walkthrough using its URL, but it's inactive or the users aren’t licensed to see it. To make it accessible to users, check its settings or activate it.

Associated Objects

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

PromptErrorOwnerSharingRule: Sharing rules are available for the object.
PromptErrorShare: Sharing is available for the object.