PromptVersion
Represents an in-app guidance prompt or walkthrough.
Prompts and walkthroughs help users discover your products and services, adopt your processes, or learn how to use a new feature. Add prompts and walkthroughs in Lightning Experience pages or apps or in supported Experience Cloud site pages. Add an optional action button or link that goes to a URL. Track views, action button clicks, and walkthrough completions.
Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name.
Introduced in API version 46.0.
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
- To add, edit, manage, and view prompts and walkthroughs in Lightning Experience or in Experience Cloud sites, see Considerations for Creating In-App Guidance and Permissions for Creating and Accessing In-App Guidance in Salesforce Help for permissions.
For considerations about including in-app guidance in a managed package, see Guidelines for In-App Guidance in Managed Packages in Salesforce Help.
For more information about creating managed packages, see Create a First-Generation Managed Package.
Unmanaged packages must contain a namespace prefix. For more information, see Register a Namespace for a First-Generation Managed Packages and What happens to my namespace prefix when I install a package?.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: Label for the action button or link. Maximum of 25 characters. For a walkthrough, specify this value on the last step.
- Type: url
- Properties: Create, Filter, Nillable, Sort, Update
- Introduced: API version 46.0
- Description: URL for the action button or link. Maximum of 1,000 characters. You can’t use the
GROUP BYoption in a SOQL query for this field. For a walkthrough, specify this value on the last step.
-
Type: textarea
-
Properties: Create, Update
-
Description:
Body content.
In API version 60.0 and later, enter up to 4,000 characters for all prompt types.
In earlier API versions, enter up to 240 characters for floating prompts and targeted prompts. Enter up to 4,000 characters for docked prompts.
For docked prompts, the maximum characters include HTML markup, not just readable text.
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 47.0
-
Relationship name: CustomApplication
-
Relationship type: relationship
-
Refers to: TabSet
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: Number of days between occurrences. For a walkthrough, specify this value on the first step.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: Description. Maximum of 255 characters.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: Label for the dismiss button of a floating or targeted prompt. Maximum of 15 characters.
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Description: The position of a floating prompt on the page.
- Possible values:
- TopLeft — TopLeft
- TopCenter — TopCenter
- TopRight — TopRight
- MiddleLeft — MiddleLeft
- MiddleCenter — MiddleCenter
- MiddleRight — MiddleRight
- BottomLeft — BottomLeft
- BottomCenter — BottomCenter
- BottomRight — BottomRight
- Type: picklist
- Properties: Create, Filter, Group, Restricted picklist, Sort, Update
- Description: The type of prompt.
- Possible values:
- DockedComposer — DockedComposer — A docked prompt
- FloatingPanel — FloatingPanel — A floating prompt
- Targeted — Targeted — A targeted prompt. Available in API version 52.0 and later.
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 52.0
- Description: The location of a targeted prompt relative to the element.
- Possible values:
- BottomCenter — BottomCenter
- BottomLeft — BottomLeft
- BottomRight — BottomRight
- LeftBottom — LeftBottom
- LeftCenter — LeftCenter
- LeftTop — LeftTop
- RightBottom — RightBottom
- RightCenter — RightCenter
- RightTop — RightTop
- TopCenter — TopCenter
- TopLeft — TopLeft
- TopRight — TopRight
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The date to stop showing the in-app guidance. For a walkthrough, specify this value on the first step.
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 58.0
- Description: This field corresponds to the Environment picklist in In-App Guidance Builder. Available in version 60.0 and later.
- Possible values:
- Lightning — Lightning — Default. The in-app guidance is used in a Lightning Experience app or page.
- Site — Site — The in-app guidance is used in a supported Experience Cloud site page.
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 58.0
-
Description:
Required if the value of
ExperienceisSite. The ID of the Experience Cloud site context associated with the in-app guidance prompt. Available in version 60.0 and later.This field is a polymorphic relationship field.
-
Relationship name: ExperienceContext
-
Relationship type: polymorphic
-
Refers to: CommunityTemplateDefinition, Site
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: Label for the header of a docked prompt. This value is the label contained in the window’s browser bar. Maximum of 36 characters.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 56.0
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 51.0
- Description: Indicates the alt text of an image. Required if
ImageLocationorImageIDis specified.
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 51.0
-
Description:
The ID of the ContentAsset that holds the image. Required if
ImageLocationorImageAltTextis specified.This is a relationship field.
-
Relationship name: Image
-
Relationship type: relationship
-
Refers to: ContentAsset
- Type: url
- Properties: Create, Filter, Nillable, Sort, Update
- Introduced: API version 53.0
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 51.0
- Description: Indicates the location of the image in relation to the body text. Required if
ImageIDorImageAltTextis specified. - Possible values:
- Top — Top
- Bottom — Bottom
- Right — Right
- Left — Left
- Type: string
- Properties: Filter, idLookup, Nillable, Sort
- Description: Used by Salesforce for efficient querying.
- Type: string
- Properties: Filter, idLookup, Nillable, Sort
- Description: Used by Salesforce for efficient querying.
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: Indicates whether the in-app guidance is active (
true) or not (false).
- Type: string
- Properties: Create, Filter, Group, Sort, Update
- Description: The label. Maximum of 80 characters.
-
Type: reference
-
Properties: Create, Filter, Group, Sort
-
Description:
ID of the in-app guidance.
This is a relationship field.
-
Relationship name: Parent
-
Relationship type: masterdetail
-
Refers to: Prompt
-
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 value is the user who installed the package.
This is a relationship field.
-
Relationship name: PublishedByUser
-
Relationship type: relationship
-
Refers to: User
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: Indicates the date the in-app guidance was activated. If installed from a package, this value is the date when the package was installed. For walkthroughs, this field can only be specified on the first step.
- Type: textarea
- Properties: Create, Nillable, Update
- Introduced: API version 52.0
- Description: Used by Salesforce to identify the element that the targeted prompt is associated with.
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: Indicates whether an action button or link is included (
true) or not (false).
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 48.0
- Description: Indicates whether the in-app guidance ignores the global time delay and instead shows on page load (
true) or not (false).
-
Type: date
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Description:
Indicates the date to start showing the in-app guidance. For a walkthrough, specify this value on the first step.
In API version 48.0 and earlier, this field is required.
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 49.0
- Description: Required for walkthroughs only. Indicates the number of the last step the user viewed or interacted with in a walkthrough. Include up to 10 steps. Numbers must be consecutive without repeated or skipped numbers.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Version: Deprecated in API version 51.0 and later.
- Description: The app’s developer name where the in-app guidance appears.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Version: Deprecated in API version 51.0 and later.
- Description: The app’s namespace prefix where the in-app guidance appears. This value must match the target app’s
NamespacePrefixin the org that the package is being installed into. Maximum of 15 characters.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: Required. Used by Salesforce to identity the prompt’s page location along with
targetPageKey2,targetPageKey3,targetPageKey4, andtargetPageType.
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 51.0
- Description: Used by Salesforce to identify the prompt’s page location along with
TargetPageKey2,TargetPageKey3,TargetPageKey4, andTargetPageType.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: Used by Salesforce to identify the prompt’s page location along with
TargetPageKey1,TargetPageKey3,TargetPageKey4, andTargetPageType.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 51.0
- Description: Used by Salesforce to identify the prompt’s page location along with
TargetPageKey1,TargetPageKey2,TargetPageKey4, andTargetPageType.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 53.0
- Description: Used by Salesforce to identify the page location along with
TargetPageKey1,TargetPageKey2,TargetPageKey3, andTargetPageType.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The type of page where the in-app guidance appears.
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 53.0
- Description: Used by Salesforce to determine if in-app guidance is specific to a record type.
- Relationship name: TargetRecordType
- Relationship type: relationship
- Refers to: RecordType
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 50.0
- Description: Indicates which custom theme color is applied to the in-app guidance. Required if
ThemeSaturationis specified. For a walkthrough, specify this value on the first step. - Possible values:
- Theme1 — Theme1 — derived from the current brand color
- Theme2 — Theme2 — derived from the current page background color
- Theme3 — Theme3 — derived from the current global header color
- Theme4 — Theme4 — derived from the current app theme color
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 50.0
- Description: Indicates which color value, or saturation, is applied to the in-app guidance that has a custom theme color. Required if
ThemeColoris specified. For a walkthrough, specify this value on the first step. - Possible values:
- Dark — Dark
- Light — Light
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: Required if recurrences are scheduled. The maximum number of times to show the in-app guidance. Salesforce detects whether the user interacts with the in-app guidance, then determines whether to show the in-app guidance again or cancel scheduled recurrences. Maximum value of 30. For a walkthrough, specify this value on the first step.
- Type: string
- Properties: Create, Filter, Group, Sort, Update
- Description: Required. The label for the title. Maximum of 36 characters.
-
Type: picklist
-
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
-
Description:
Indicates which permissions can see the in-app guidance.
In API version 48.0 and earlier, this field is required.
-
Possible values:
- Everyone — Everyone
- SpecificPermissions — SpecificPermissions
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 48.0
- Description: Indicates which profiles can see the in-app guidance.
- Possible values:
- Everyone — Everyone
- SpecificProfiles — SpecificProfiles
- Type: int
- Properties: Create, Filter, Group, Sort, Update
- Description: Required. The number remains
1since multiple versions aren’t saved in the org.
- Type: url
- Properties: Create, Filter, Nillable, Sort, Update
- Introduced: API version 48.0
- Description: The embed URL for a video in a docked prompt. Maximum of 1,000 characters. You can specify this field or the
imagefield, but not both. See Considerations for Creating In-App Guidance.