| AssociatedRecordId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort, Update
- Description
- The ID of the record the flow is associated with.
- This field is a polymorphic relationship field.
- Relationship Name
- AssociatedRecord
- Relationship Type
- Lookup
- Refers To
- Campaign
|
| Description |
- Type
- textarea
- Properties
- Filter, Group, Nillable, Sort
- Description
- The description of the flow.
|
| ErrorCode |
- Type
- text
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- The error code if the flow element run encountered an error. This
field is available in API version 59.0 and later. Valid values are:
-
ACTIVATING_USER_ACCOUNT_DEACTIVATED—We
can't run this flow because the user who activated it has a
deactivated user record.
-
ACTIVATING_USER_LOST_PERMISSIONS—We can't
run this flow because the user that activated it no longer
has permission to it.
-
CANNOT_PUBLISH_SEGMENT—We can't run this
flow because we can't publish the segment it's using. Contact
Salesforce Customer Support and ask for help with the error
ID.
-
CANNOT_QUERY_SEGMENT_MEMBER_DATA—We can't
run this flow because we can't query the segment membership
data it's using. Contact Salesforce Customer Support and ask
for help with the error ID.
-
CANNOT_REFRESH_DATA_STREAM—We can't run
this flow because we can't refresh your data stream metadata.
Contact Salesforce Customer Support and ask for help with the
error ID.
-
CANNOT_REFRESH_IDENTITY_RES_DATA—We can't
run this flow because we can't refresh your identity
resolution data. Contact Salesforce Customer Support and ask
for help with the error ID.
-
CANNOT_REFRESH_IDENTITY_RES_METADATA—We
can't run this flow because we can't refresh your identity
resolution metadata. Contact Salesforce Customer Support and
ask for help with the error ID.
-
CANNOT_UPDATE_DATASTREAM_METADATA—We
can't run this flow because we can't update your DataStream
metadata. Contact Salesforce Customer Support and ask for
help with the error ID.
-
DATA_ACTION_STATUS_ERROR—We can’t run
this flow because we couldn’t create the data action. To try
again, save and activate a new version of the flow.
-
FLOW_FAILED_TO_START—This flow failed to
start. Contact Salesforce Customer Support and ask for help
with the error ID.
|
| ErrorDetails |
- Type
- text
- Properties
- Filter, Group, Nillable, Sort
- Description
- The error ID. This field is available in API version 59.0 and
later.
|
| FlowCategory |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort, Update
- Description
- The API name of a category. Sharing rules assign permissions to
view and edit flows by category and subcategory. This field is
available in API version 60.0 and later.
|
| FlowDefinition |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- Description
- Represents the flow definition.
|
| FlowSubcategory |
- Type
- text
- Properties
- Filter, Group, Nillable, Sort
- Description
- The API name of a subcategory. Sharing rules assign permissions to
view and edit flows by category and subcategory. This field is
available in API version 60.0 and later.
|
| Id |
- Type
- text
- Properties
- Filter, Group, Sort
- Description
- The ID of the flow.
|
| 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.
|
| Name |
- Type
- string
- Properties
- Filter, Group, idLookup, Sort
- Description
- The label of the flow.
|
| OwnerId |
- Type
- reference
- Properties
- Filter, Group, Sort, Update
- Description
- The ID of the user who owns the flow.
- This field is a polymorphic relationship field.
- Relationship Name
- Owner
- Relationship Type
- Lookup
- Refers To
- Group, User
|
| ProgressStatus |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, 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 5 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.
This process can take up to
2
hours.
-
Scheduled—
Indicates a flow scheduled to start on the date and time
selected by the user.
|
| ScheduledStartDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The date and time that the flow is scheduled to start.
|
| SegmentId |
- Type
- reference
- Properties
- Filter, Group, Nillable, Sort
- Description
- The ID of the segment used in the flow.
- This field is a relationship field.
- Relationship Name
- Segment
- Relationship Type
- Lookup
- Refers To
- MarketSegment
|
| Type |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- The trigger type of the flow. Specifies what causes the flow to
run. Valid values are:
-
Capability—The
flow starts when the specified capability that the flow
integrates with is invoked. This value is available in API
version 60.0 and later.
-
FormSubmissionEvent—The flow runs when a
user submits data via a webform. In Flow Builder, this value
corresponds to Form.
This value is available in API version 60.0 and later.
-
Segment—The flow
runs at the scheduled time of a segment.
|
j