PromptVersionLocalization

Represents the translated value of a label for an in-app guidance prompt when the Translation Workbench is enabled for your org. Available in API version 48.0 and later.

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.

Supported Calls

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

Special Access Rules

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.

Packaging Prompts

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.

Unmanaged packages for prompts isn’t supported.

When orgs install prompts from packages, the prompts will be the same 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 user.

If the package includes a custom profile or permission that isn’t part of the installer’s Salesforce org, the prompt is installed, but it won’t include those items. For example, you install a prompt with several custom profiles not included in your org. The prompts are installed without those custom profiles.

If the package includes a standard app that isn’t part of the installer’s Salesforce org, the prompts are installed, but aren’t usable.

Fields

Field	Details
Language	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description Indicates the language used in the org where the prompt was created.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization 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 organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if 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 organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
ParentId	Type reference Properties Create, Filter, Group, Sort Description ID of the prompt.
Value	Type textarea Properties Create, Filter, Sort, Update Description The actual translated label of the prompt.

SOAP API Developer Guide

PromptVersionLocalization

Supported Calls

Special Access Rules

Packaging Prompts

Fields