PromptVersionLocalization

Represents the translated value of a label for-app guidance when the Translation Workbench is enabled for your org. Available in API version 48.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 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 Enablement Sites (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.

Prompts and Walkthroughs in Managed Packages

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 Before You Create Second-Generation Managed Packages.

Unmanaged packages must contain a namespace prefix. For more information, see Create and Register Your Namespace for Second-Generation Managed Packages and What happens to my namespace prefix when I install a package?.

Fields

Field	Details
Language	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Indicates the language used in the org where the in-app guidance was created.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. In orgs that aren't Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
ParentId	Type reference Properties Create, Filter, Group, Sort Description ID of the in-app guidance.
Value	Type textarea Properties Create, Filter, Sort, Update Description The actual translated label of the in-app guidance.

Object Reference for the Salesforce Platform

PromptVersionLocalization

Supported Calls

Special Access Rules

Prompts and Walkthroughs in Managed Packages

Fields