RecordAction | Object Reference for Salesforce and Lightning Platform

Access to the RecordAction object is determined by a user’s access to the associated parent record.

Note

Supported Calls

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

Special Access Rules

As of Summer ’20 and later, only authenticated internal and external users can access this object.

Fields

Field	Details
ActionDefinition	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required in Lightning Flow for Service implementations that use version 44.0 or later of the API. The API name of the action to associate with the record; for example, the API name of a flow. Use this field rather than FlowDefinition. To distinguish a quick action from a flow with the same API name, we prepend "QuickAction" to the API name of every quick action.
ActionType	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required in Lightning Flow for Service implementations that use version 46.0 or later of the API. The type of action. Possible values are: `Flow` (default) `QuickAction` For versions of the API prior to version 46.0, this field is set to Flow.
FlowDefinition	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Optional in Lightning Flow for Service implementations using version 42.0 or 43.0 of the API. An upgrade to Winter '19 or later, which uses API version 44.0 or later, copies FlowDefinition to ActionDefinition. For versions 42.0 and 43.0, this field is the API name of the flow that’s associated with the record.
FlowInterviewId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Optional. The flow interview ID of the paused or completed flow. This field can’t be set in Process Builder. This is a relationship field. Relationship Name FlowInterview Relationship Type Lookup Refers To FlowInterview
IsMandatory	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Optional. Specifies whether the action is mandatory. The default value is false. At runtime, we show a reminder when the user closes a mandatory flow without completing it. We don't show the reminder for quick actions. Note
IsUiRemoveHidden	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Optional. Specifies whether the ability to remove the action is hidden in the UI. The default value is false. If true, the UI hides the ability to remove the action. However, actions can still be deleted using the API.
Order	Type int Properties Create, Filter, Group, Sort, Update Description Required. The order of the action among all actions associated with this record.
Pinned	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. Specifies whether the action is pinned to the top or bottom of the component. If an action is pinned, users see the Remove option in the UI unless IsUiRemoveHidden is set to true. Possible values are: None (default) Top Bottom
RecordId	Type reference Properties Create, Filter, Group, Sort, Update Description Required. Record associated with the action. In version 46.0 and above, we support most object types. To learn about supported objects, see the Lightning Flow for Service Developer’s Guide. This is a relationship field. Relationship Name Record Relationship Type Lookup Refers To Account, Address, Asset, AssetRelationship, AssignedResource, AssociatedLocation, Campaign, CampaignMember, CarePreauth, CarePreauthItem, Case, CollaborationGroup, Contact, ContactRequest, Contract, CoverageBenefit, CoverageBenefitItem, EnhancedLetterhead, Lead, Location, MemberPlan, OperatingHours, Opportunity, Order, PlanBenefit, PlanBenefitItem, Pricebook2, PricebookEntry, Product2, ProductItem, ProductItemTransaction, ProductRequest, ProductRequestLineItem, ProductRequired, ProductTransfer, PurchaserPlan, PurchaserPlanAssn, ResourceAbsence, ResourcePreference, ReturnOrder, ReturnOrderLineItem, ServiceAppointment, ServiceResource, ServiceResourceSkill, ServiceTerritory, ServiceTerritoryMember, Shipment, SkillRequirement, SocialPersona, SocialPost, TimeSlot, User, Visit, VoiceCall, WorkOrder, WorkOrderLineItem, WorkType, WorkTypeGroup
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. The current state of the action. Possible values are: `New` (default) `Paused` `Complete` `Started` `Unlinked`—The action was unlinked because the flow was paused and the current record for the flow interview changed. Paused and unlinked statuses do not apply to quick actions. This field can’t be set in Process Builder.

Usage

The RecordAction object works with the Actions & Recommendations component in Lightning Experience. Although this junction object can be used to create relationships between records and actions in Salesforce Classic, those relationships can’t be displayed in Salesforce Classic.

API version 44.0 added a field, ActionDefinition, so that a RecordAction in future releases can support other types of actions in addition to flows. API version 44.0 and later maintain the FlowDefinition field to support processes that reference this field in earlier API versions. Upgrading an org to Winter '19 or later, which uses API version 44.0 or later, copies the FlowDefinition field to the ActionDefinition field. FlowDefinition will be deprecated in a future release, so use ActionDefinition instead.

Note

When an action is deleted that’s referenced in an ActionDefinition or FlowDefinition, the RecordAction object is deleted. RecordAction objects are also deleted when the associated parent record is deleted, or when a flow is paused and the current record context has changed. When an action is completed, the associated RecordAction object is also deleted.

Deleted RecordActions are removed from the list when the page is refreshed.

For more information about the Actions & Recommendations component and how it works with RecordActions, see the Lightning Flow for Service Developer Guide.

Java Example

Here’s an example of how to associate flows to a record using the RecordAction object.

1public void associateNewCustomerFlowWithAccount(Account a) {
2   try {
3      RecordAction newRecordAction = new RecordAction();
4      newRecordAction.setRecordId(a.getId());
5      newRecordAction.setActionDefinition(“New_Customer_Flow”);
6      newRecordAction.setOrder(1);
7
8      SaveResult[] results = connection
9            .create(new SObject[] { newRecordAction });
10   } catch (ConnectionException ce) {
11      ce.printStackTrace();
12   }
13}

Data Model

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

RecordActionHistory: History is available for tracked fields of the object.