RecordAction

Represents a relationship between a record and a flow. Create a RecordAction for every flow you want associated to a particular record. Available in API version 42.0 and later.

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()

Fields

Field	Details
FlowDefinition	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required in Lightning Guided Engagement implementations. The developer name of the flow to associate 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.
Order	Type int Properties Create, Filter, Group, Sort, Update Description Required. The order of the flow among all flows associated with this record.
Pinned	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Required. Specifies whether the flow is pinned to the top or bottom of the Guided Action List component. Users can’t delete pinned flows from the Guided Action List, however they can be deleted using the API. The default value is None. Top Bottom None
RecordId	Type reference Properties Create, Filter, Group, Sort, Update Description Required. Record associated with the flow.
Status	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Required. The current state of the flow. New Paused Complete This field can’t be set in Process Builder.

Usage

The RecordAction object works with the Guided Action List component in Lightning Experience. Although this object can be used to create relationships between records and flows in Salesforce Classic, those relationships can’t be displayed in Salesforce Classic.

When a FlowDefinition gets deleted, all RecordAction records associated to that FlowDefinition are deleted as well.

When a Flow is completed, the associated RecordAction is deleted.

If you’re using the Guided Action List component to display RecordActions, the deleted RecordActions are removed from the list when the page is refreshed.

For more information about the Guided Action List component and how it works with RecordActions, see the Lightning Guided Engagement 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.setFlowDefinition(“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}

Object Reference for Salesforce and Lightning Platform

RecordAction

Supported Calls

Fields

Usage

Java Example

Data Model