PromptVersion

Represents an in-app guidance prompt or walkthrough. Available in API version 46.0 and later.

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(), 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.

Packaging Prompts and Walkthroughs

See Creating Managed Packages in Salesforce Help for more information.

See Considerations for Prompts in Lightning Experience in Salesforce Help for more information about installing and managing prompt packages and about editing and cloning prompts installed from packages.

If the package includes a custom profile or permission that isn’t part of a Salesforce org, the in-app guidance is installed, but it doesn't include those custom items. For example, an org installs a prompt with several custom profiles not included in their org. The prompts are installed without those custom profiles.

If the package includes a standard app that isn’t part of a Salesforce org, the in-app guidance is installed, but it's not usable.

Unmanaged packages must contain a namespace prefix. For more information, see Register a Namespace Prefix and What happens to my namespace prefix when I install a package? in Salesforce Help.

For walkthrough packages:

If a managed or unmanaged package includes walkthroughs for standard apps, walkthroughs are installed. However, they aren't visible to users without subscribing to myTrailhead or starting a 30-day trial.
If a security-reviewed, first-generation managed package includes walkthroughs with at least one step on a page within a custom app, users can see the walkthroughs without a subscription to myTrailhead or a trial.

When orgs install in-app guidance from packages, the in-app guidance will retain publish state as indicated by the IsPublished field. For example, if the package prompt is active, it will also be active when installed by the org.

Fields

Field	Details
ActionButtonLabel	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Label for the action button. Maximum of 25 characters. For walkthroughs, this field can only be specified on the last step.
ActionButtonLink	Type url Properties Create, Filter, Nillable, Sort, Update Description URL for the action button. Maximum of 1,000 characters. You can’t use the `GROUP BY` option in a SOQL query for this field. For walkthroughs, this field can only be specified on the last step.
Body	Type textarea Properties Create, Update Description Body content. For floating prompts, there’s a maximum of 240 characters. For docked prompts, there’s a maximum of 4000 characters. However, docked prompts use a rich text editor, so the maximum refers to the HTML markup, not the readable text.
DelayDays	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of days between occurrences. For walkthroughs, this field can only be specified on the first step.
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the in-app guidance. Maximum of 255 characters.
DismissButtonLabel	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Label for the dismiss button of a floating prompt. Maximum of 15 characters.
DisplayPosition	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the position of the floating prompt on the page. Valid values are: `TopLeft` `TopCenter` `TopRight` `MiddleLeft` `MiddleCenter` `MiddleRight` `BottomLeft` `BottomCenter` `BottomRight`
DisplayType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the type of prompt. Valid values are: `DockedComposer`—the docked prompt `FloatingPanel`—the floating prompt
EndDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the date to stop showing the in-app guidance. For walkthroughs, this field can only be specified on the first step.
Header	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Label for the header of the docked prompt. This is the label contained in the window’s browser bar. Maximum of 36 characters.
ImageAltText	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the alt text of an image. Required if `ImageLocation` or `ImageID` is specified.
ImageId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the ContentAsset that holds the image. Required if `ImageLocation` or `ImageAltText` is specified.
ImageLocation	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the location of the image in relation to the body text. Required if `ImageID` or `ImageAltText` is specified. Valid values are: `Top` `Bottom` `Right`—for floating prompts only `Left`—for floating prompts only
IndexWithIsPublished	Type string Properties Filter, idLookup, Nillable, Sort Description Used by Salesforce for efficient querying.
IndexWithoutIsPublished	Type string Properties Filter, idLookup, Nillable, Sort Description Used by Salesforce for efficient querying.
IsPublished	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the in-app guidance is active `yes` or not `no`.
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description The master label. Maximum of 80 characters.
ParentId	Type reference Properties Create, Filter, Group, Sort Description ID of the in-app guidance.
PublishedByUserId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the user who activated the in-app guidance. If the in-app guidance is part of a package, this is the user who installed the package.
PublishedDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the date the in-app guidance was activated. If the in-app guidance is part of a package, this is the date when the package was installed. For walkthroughs, this field can only be specified on the first step.
ShouldDisplayActionButton	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if an action button or link is included in the in-app guidance `yes` or not `no`.
ShouldIgnoreGlobalDelay	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the prompt ignores the global time delay between in-app guidance and instead shows on page load `yes` or not `no`. The default is `no`.
StartDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the date to start showing. For walkthroughs, this field can only be specified on the first step.
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.
TargetAppDeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The app’s developer name where the in-app guidance appears. Deprecated in API version 51.0.
TargetAppNamespacePrefix	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The app’s namespace prefix where the in-app guidance appears. Must match the target app’s `NamespacePrefix` in the org that the package is being installed into. Maximum of 15 characters. Deprecated in API version of 51.0.
TargetPageKey1	Type string Properties Create, Filter, Group, Sort, Update Description Used by Salesforce to identify the page location along with `targetPageKey2`, `targetPageKey3`, and `targetPageType`.
TargetPageKey1Ref	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Used by Salesforce to identify the prompt’s page location along with `targetPageKey2`, `targetPageKey3`, and `targetPageType`.
TargetPageKey2	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Used by Salesforce to identify the prompt’s page location along with `targetPageKey1`, `targetPageKey3`, and `targetPageType`.
TargetPageKey3	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Used by Salesforce to identify the prompt’s page location along with `targetPageKey1`, `targetPageKey2`, and `targetPageType`.
TargetPageType	Type string Properties Create, Filter, Group, Sort, Update Description The type of page where the in-app guidance appears.
ThemeColor	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates which custom theme color is applied to in-app guidance. Required if themeSaturation is specified. Specify on the first step of the walkthrough to apply to the entire walkthrough. Valid values are: `Theme1`—derived from the current brand color `Theme2`—derived from the current page background color `Theme3`—derived from the current global header color `Theme4`—derived from the current app theme color
ThemeSaturation	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates which color value, or saturation, is applied to in-app guidance that has a custom theme color applied. Required if themeColor is specified. Specify on the first step of the walkthrough to apply to the entire walkthrough. Valid values are: `Dark` `Light`
TimesToDisplay	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Maximum number of times to display the in-app guidance (that is, the number of occurrences). Salesforce detects if the user interacts with (or ignores) the in-app guidance to determine if we should show the in-app guidance again or cancel scheduled recurrences. This may run counter to the number of occurrences scheduled. Maximum value of 30. For walkthroughs, this field can only be specified on the first step.
Title	Type string Properties Create, Filter, Group, Sort, Update Description The label for the title of the in-app guidance. Maximum of 36 characters.
UserAccess	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates which permissions can see the in-app guidance. Valid values are: `Everyone`—there are no restrictions on who can see `SpecificPermissions`—only users with all the specific user permissions specified can see the in-app guidance
UserProfileAccess	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates which profiles can see the in-app guidance. Valid values are: `Everyone`—there are no permission restrictions on who can see `SpecificProfiles`—users with any of the specific user profiles specified can see the in-app guidance
VersionNumber	Type int Properties Create, Filter, Group, Sort, Update Description The number remains `1` since multiple versions aren’t saved in the org.
VideoLink	Type url Properties Create, Filter, Nillable, Sort, Update Description URL for the video in a docked prompt. Maximum of 1,000 characters. You can only specify this field or the `ImageId` field, not both. To find the embed code for a video, follow the instructions from the video host website. Usually the steps can be found by searching for the name of the website and “embed video.” For example, here’s what the embed code looks like for YouTube: `<iframe width="560" height="315" src="https://www.youtube.com/embed/Ko-gcObzTVo" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>` Then, you would enter the URL found in the `src` attribute. For the example used, enter `https://www.youtube.com/embed/Ko-gcObzTVo`.

Object Reference for Salesforce and Lightning Platform

PromptVersion

Supported Calls

Special Access Rules

Packaging Prompts and Walkthroughs

Fields