--- schema_version: "1" id: 940f7f0dfe8d8ab76fe9feb4e99bb5524f1b307b2014a58b0f18314b00919cc6 title: PromptAction collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_promptaction.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_promptaction.htm source_site: developer.salesforce.com content_type: documentation content_hash: e25fc9d57c9aa2a5365187135ecb3ccbbfa6a990050cac0ab6e10246b21cb53c description: Represents how the user interacted with the in-app guidance prompt or walkthrough. Available in API version 46.0 and later. --- # PromptAction Represents how the user interacted with the in-app guidance prompt or walkthrough. Available in API version 46.0 and later. 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. ## Supported Calls create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert() ## Special Access Rules To add, edit, manage, and view prompts and walkthroughs in Lightning Experience or in Experience Cloud sites, multiple permissions are required. See [Permissions for Creating and Accessing In-App Guidance](https://help.salesforce.com/s/articleView?id=sales.customhelp_lex_wt_license.htm&type=5&language=en_US "HTML (New Window)") in Salesforce Help. ## Fields | Field | Details | | --- | --- | | LastDisplayDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date the in-app guidance 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: - CustomAction - Dismiss - Error - Finish—(walkthroughs only) - NoAction - NotSeen - Snooze | | LastResultDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Indicates the date the in-app guidance was last interacted with. | | Name | Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the in-app guidance. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PromptVersionId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the PromptVersion object. This is a relationship field. Relationship Name PromptVersion Relationship Type Lookup Refers To PromptVersion | | SnoozeUntil | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The timestamp for when the user’s snooze request expires. The user won’t see the prompt again until they navigate to the page after the snooze time expires. | | StepCount | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Indicates the total number of steps in the walkthrough. Available in API version 49.0 and later. | | 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. Available in API version 49.0 and later. | | TimesActionTaken | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the user took action on the in-app guidance. | | TimesDismissed | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the user dismissed the in-app guidance. | | TimesDisplayed | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description Number of times that the in-app guidance was displayed to the user. | | TimesSnoozed | Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The total number of times the user snoozes the prompt. | | UserId | Type reference Properties Create, Filter, Group, Sort, Update Description ID of the user. This is a relationship field. Relationship Name User Relationship Type Lookup Refers To User | ## Associated Objects This object has the following associated objects. They are available in API version 46.0 and later. [PromptActionOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [PromptActionShare](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.