Newer Version Available

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

FlowRecordVersion

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

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(),search()

Special Access Rules

This object is available only in Salesforce Starter edition.

Fields

Field Name Details
ActivatedById
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the user that activated the flow. This field is available in API version 60.0 and later.
This field is a relationship field.
Relationship Name
ActivatedBy
Relationship Type
Lookup
Refers To
User
ActivatedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time when the flow was activated. This field is available in API version 60.0 and later.
Entries
Type
int
Properties
Filter, Group, Sort
Description
The number of entries in this flow. To use this field, your org must use Salesforce Enterprise and Unlimited Editions with Marketing Cloud Growth Edition. This field is available in API version 60.0 and later.
Errors
Type
int
Properties
Filter, Group, Sort
Description
The number of errors in this flow. To use this field, your org must use Salesforce Enterprise and Unlimited Editions with Marketing Cloud Growth Edition. This field is available in API version 60.0 and later.
Exits
Type
int
Properties
Filter, Group, Sort
Description
The number of exits from this flow. To use this field, your org must use Salesforce Enterprise and Unlimited Editions with Marketing Cloud Growth Edition. This field is available in API version 60.0 and later.
FlowId
Type
text
Properties
Filter, Group, Sort
Description
The ID of the parent flow running this version.
Id
Type
text
Properties
Filter, Group, Sort
Description
The ID of the flow version.
IsPaused
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the segment-triggered flow is paused (true) or not (false). When the value is true, no additional records are processed until the flow is resumed. The default value is false. This field is available in API version 60.0 and later.
PausedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time the segment-triggered flow was paused. This field is available in API version 60.0 and later.
PausingUserId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the user who paused the segment-triggered flow. This field is available in API version 60.0 and later.
This field is a relationship field.
Relationship Name
PausingUser
Relationship Type
Lookup
Refers To
User
ProgressStatus
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The running status of the flow. Valid values are:
  • Canceled— Specifies a flow that was deactivated by a user. The flow doesn’t process previously added records and 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 a user can activate it.
  • 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 5 users with the Manage Flows permission who most recently logged into Salesforce.
  • Finishing— Indicates a flow that was deactivated by a user, but is finishing records previously added 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 resources it requires to run. This process can take up to 2 hours.
  • Scheduled— Indicates a flow scheduled to start on the date and time selected by the user.
ReasonPaused
Type
textarea
Properties
Filter, Group, Nillable, Sort
Description
The reason the segment-triggered flow was paused. This field is available in API version 60.0 and later.
ResumedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time the segment-triggered flow resumed. This field is available in API version 60.0 and later.
ResumingUserId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the user who resumed the segment-triggered flow. This field is available in API version 60.0 and later.
This field is a relationship field.
Relationship Name
ResumingUser
Relationship Type
Lookup
Refers To
User
ScheduledStartDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date and time the flow started. This field is available in API version 60.0 and later.
VersionNumber
Type
number
Properties
Filter, Group, Nillable, Sort
Description
The version number of the flow version.