Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

FlowRecord

Represents the details of a flow. This object is available in API version 58.0 and later.

Supported Calls

delete(), query(), update()

Special Access Rules

This object is available only in Salesforce Starter edition.

Fields

Field Name	Details
AssociatedRecordId	Type text Properties Filter, Group, Nillable, Sort, Update Description The ID of the record the flow is associated with.
Description	Type text Properties Filter, Group, Sort Description The description of the flow.
FlowDefinition	Type text Properties Filter, Group, Sort Description Represents the flow definition.
Id	Type text Properties Filter, Group, Sort Description The ID of the flow.
Name	Type text Properties Filter, Group, Sort Description The label of the flow.
ProgressStatus	Type enum Properties Filter, Group, Sort Description The progress status of the flow. Valid values are: `Canceled`— Indicates a flow that has been deactivated by a user who doesn't process previously added records. No additional records are added to this flow. `Completed`— Indicates a flow that is complete. No additional records are eligible to be processed in this flow. `Draft`— Indicates a flow that is under construction and isn't active yet. This status can be invalid because it needs additional information before it can be activated by the user. `Error`— Indicates a flow that has been deactivated because it encountered an error. When the error occurs, the error details are emailed to up to five users with the Manage Flows permission who most recently logged into Salesforce. `Finishing`— Indicates a flow that has been deactivated by a user, but is finishing previously added records that are eligible to run to completion. No additional records are added to this flow. `InProgress`— Indicates a flow that is running or ready to run. `PreparingData`— Indicates a flow that is preparing the necessary data to run. `Scheduled`— Indicates a flow scheduled to start on the date and time selected by the user.
ScheduledStartDate	Type dateTime Properties Filter, Group, Sort Description The date and time that the flow is scheduled to start.
Segment	Type text Properties Filter, Group, Sort Description The ID of the segment used in the flow.
Type	Type enum Properties Filter, Group, Sort Description The trigger type of the flow. The only valid value is: `Segment` —Refers to a segment-based flow.