PromptAction

Represents how the user interacted with the in-app guidance prompt. Available in API version 46.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.

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.

Supported Calls

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

Fields

Field	Details
LastDisplayDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date the prompt was last displayed to the user.
LastResult	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Indicates the last user interaction. Valid values are `Not Seen`, `No Action`, `Dismiss`, and `Custom Action`.
LastResultDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date the prompt was last interacted with.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the prompt.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner.
PromptVersionId	Type reference Properties Create, Filter, Group, Sort, Update Description ID of the PromptVersion object.
TimesActionTaken	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the user took action on the prompt.
TimesDismissed	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the user dismissed the prompt.
TimesDisplayed	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the prompt was displayed to the user.
UserId	Type reference Properties Create, Filter, Group, Sort, Update Description ID of the user.

Associated Objects

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

PromptActionOwnerSharingRule: Sharing rules are available for the object.
PromptActionShare: Sharing is available for the object.

SOAP API Developer Guide

PromptAction

Supported Calls

Fields

Associated Objects