Flow

Represents the metadata associated with a flow that encompasses the flow’s structure, logic, and run-time behavior. It allows you to build dynamic applications that guide users through interactive screens, automate processes, and connect with various Salesforce and external services. This includes managing data operations like creating, updating, or deleting records, handling complex decisions, looping through collections, and invoking actions like Apex or external services to extend functionality. A flow contains options for API versioning, various execution environments, and detailed configuration of elements to design powerful automation solutions.

Where possible, we changed non-inclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Here are the limitations related to how you can use Metadata API to work with flows:

  • You can’t use Metadata API to access a flow installed from a managed package unless the flow is a template.
  • Spaces in a flow file name can lead to errors when you deploy the flow. You can include spaces at the beginning or end of a name, but these spaces are removed when you deploy the flow.
  • You can deploy changes to an active flow if in a non-production org, such as a scratch or sandbox org. To deploy changes in a production org, you must enable the Deploy processes and flows as active preference. After you deploy changes to an active flow, the flow’s detail page shows a new flow version that’s active. The new version includes your changes.
  • You can delete a flow version if it isn’t active and doesn’t have any paused interviews. If the flow version has paused interviews, wait for those interviews to resume and finish, or delete them.

Don’t edit the metadata of retrieved Process Builder processes, such as flow components whose processType is Workflow or InvocableProcess. If you deploy process metadata that you edited, you can’t open the process in the target org.

This type extends Metadata and inherits its fields.

Flows are stored in the Flow directory of the corresponding package directory. The file name matches the flow’s unique full name, and the extension is .flow.

The flow Metadata API is available in API version 24.0 and later.

  • Type: FlowAccessType (enumeration of type string)
  • Required: No
  • Type: FlowActionCall[]
  • Required: No
  • Introduced: API version 31.0
  • Description: An array of nodes that defines calls to action.
  • Type: FlowApexPluginCall[]
  • Required: No
  • Description: An array of nodes that defines calls to Apex plug-ins.
  • Type: double
  • Required: No
  • Introduced: API version 50.0
  • Description: The API version that defines the execution behavior of the flow. Flows created before API version 50.0 show an API version of 0 on the Flows list view in Setup. To show the correct API version number, create another version of the flow, and set the API version for running the flow to 49.0 or later.
  • Type: boolean
  • Required: No
  • Introduced: API version 63.0
  • Description: Indicates whether the flow’s metrics are logged to Data Cloud. The default value is false.
  • Type: FlowAssignment[]
  • Required: No
  • Description: An array of assignment nodes.
  • Type: FlowChoice[]
  • Required: No
  • Description: An array of static choice options.
  • Type: FlowCollectionProcessor[]
  • Required: No
  • Introduced: API version 50.0
  • Description: An array of nodes that process collections.
  • Type: FlowConstant[]
  • Required: No
  • Description: An array of constants.
  • Type: FlowCustomProperty[]
  • Required: No
  • Introduced: API version 63.0
  • Description: An array of custom properties that specify flow properties such as the option to show a progress indicator in a screen flow.
  • Type: string
  • Required: No
  • Type: FlowDecision[]
  • Required: No
  • Description: An array of decision nodes.
  • Type: string
  • Required: No
  • Description: Description of the flow.
  • Type: FlowDynamicChoiceSet[]
  • Required: No
  • Description: An array that constructs a set of choice options based on a database lookup.
  • Type: FlowEnd[]
  • Required: No
  • Introduced: API version 68.0
  • Description: An array of end nodes.
  • Type: FlowEnvironment (enumeration of type string)[]
  • Required: No
  • Introduced: API version 55.0
  • Description: The environment in which the flow can run.
  • Possible values:
    • Default — The flow can run from a Visualforce component, Lightning page, flow action, or custom Aura component.
    • Offline — The flow can run only offline. Flow types that support offline flows must set this value. This value is available in API version 62.0 and later.
    • Slack — The flow can run in Slack and the default environment. You specify the Slack flow environment when you save the flow.
  • Type: FlowExitRule[]
  • Required: No
  • Introduced: API version 61.0
  • Description: An array of exit rules that determine when to end the flow for a user in a segment-triggered flow.
  • Type: FlowExperiment[]
  • Required: No
  • Introduced: API version 61.0
  • Description: An array of experiments.
  • Type: FlowFormula[]
  • Required: No
  • Description: An array of formulas.

  • Type: string

  • Required: No

  • Description: Required. Inherited from the Metadata component. Name of the file in Metadata API.

    A unique name for the flow that contains only underscores and alphanumeric characters. The name must be unique across the org, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

    To deploy or retrieve a version, you can specify the version number. For example, sampleFlow-3 specifies version 3 of the flow whose unique name is sampleFlow. If you don’t specify a version number, the flow is the latest version.

    In API version 43.0 and earlier, this field included the version number. In API version 44 and later, this field no longer includes the version number.

  • Type: FlowNodeGroup[]
  • Required: No
  • Introduced: API version 68.0
  • Description: An array of group nodes.

  • Type: string

  • Required: No

  • Description: Label for the interview. This label helps users and administrators differentiate interviews from the same flow.

    In the user interface, this label appears in the Paused Flow Interviews component on the user’s Home tab and in the list of paused flow interviews in Setup.

  • Type: boolean
  • Required: No
  • Introduced: API version 47.0
  • Description: Override the default behavior and restrict access to enabled profiles or permission sets by setting this property to true. The default value is false.
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Introduced: API version 45.0
  • Description: Indicates whether the process or flow is a template. The default value is false. When installed from managed packages, subscribers can’t view or clone processes or flows because of intellectual property (IP) protection. But when those processes and flows are templates, subscribers can open them in a builder, clone them, and customize the clones.
  • Type: string
  • Required: Yes
  • Description: Required. Label for the flow.
  • Type: FlowLoop[]
  • Required: No
  • Introduced: API version 30.0
  • Description: An array of nodes for iterating through collections.
  • Type: string
  • Required: No
  • Introduced: API version 54.0
  • Description: The name of the workflow rule that the flow was migrated from.
  • Type: FlowOrchestratedStage[]
  • Required: No
  • Introduced: API version 53.0
  • Description: An array of stage nodes in an orchestration.
  • Type: string
  • Required: No
  • Type: FlowMetadataValue[]
  • Required: No
  • Introduced: API version 31.0
  • Description: Metadata values for the flow.

  • Type: FlowProcessType (enumeration of type string)

  • Required: No

  • Introduced: API version 64.0

  • Description: The type of the flow, as determined by the active version, or the latest version, if there’s no active version.

    Across flow versions, you can change the type only from Flow to AutoLaunchedFlow or vice versa. Before you change the flow type, make sure that the flow contains only the elements, resources, and functionality that the new flow type supports.

    These values are reserved for future or Salesforce internal use.

    This field is available in API version 31.0 and later.

  • Possible values:

    • ActionableEventManagementFlow — A flow that triggers an actionable event orchestration process in the background and automatically executes different types of actions based on the event type. This value is available in API version 62.0 and later.
    • ActionCadenceAutolaunchedFlow — A flow that’s executed when a user completes a cadence step. This value is available in API version 56.0 and later.
    • ActionCadenceStepFlow — A screen flow used as a cadence step. This value is available in API version 56.0 and later.
    • ActivityObjectMatchingFlow — A flow that launches when Einstein Activity Capture detects and captures a new activity, such as an email. This type of flow runs in the background without user interaction. This value is available with Sync Email as Salesforce Activity in API version 64.0 and later.
    • Appointments — A flow for Lightning Scheduler. This value is available in API version 44.0 and later.
    • ApprovalWorkflow
    • AutoLaunchedFlow — A flow that doesn’t require user interaction.
    • CheckoutFlow — A flow used in Lightning B2B Commerce to create a checkout in a store. This value is available in API version 48.0 and later.
    • ContactRequestFlow — A flow that lets customers request to be contacted by customer support. This flow is used to create contact request records. This value is available in API version 45.0 and later.
    • CustomerLifecycle — A Salesforce Surveys flow that lets you associate survey questions with different stages in customer lifecycles. This value is available in API version 49.0 and later and only when the Customer Lifecycle Designer license is enabled.
    • CustomEvent — A process that is invoked when it receives a platform event message. In the UI, it’s an event process. This value is available in API version 41.0 and later.
    • DataCaptureFlow — In the UI, Data Capture flows configure the Form tab in the Field Service mobile app. When the Data Capture flow is launched, its Flow metadata is publicly available in JavaScript format. This value is available in API version 62.0 and later.
    • DcvrFrameworkDataCaptureFlow — A screen flow that presents assessment questions from Discovery Framework. Launches when invoked by a user on a mobile device. This type of flow collects or displays information, requires user interaction, and works offline or online. This value is available in API version 62.0 and later.
    • EvaluationFlow — A flow for evaluating custom entry and exit conditions in an orchestration. Uses the isOrchestrationConditionMet output variable and discards values from any other output variables. This value is available in API version 54.0 and later.
    • FieldServiceMobile — A flow for the Field Service mobile app. This value is available in API version 39.0 and later.
    • FieldServiceWeb — A flow for embedded Appointment Booking. Its UI label is Field Service Embedded Flow. This value is available in API version 41.0 and later.
    • Flow — A flow that requires user interaction because it contains one or more screens or local actions, choices, or dynamic choices. In the UI and Salesforce Help, it’s a screen flow. Screen flows can be launched from the UI, such as with a flow action, Lightning page, or web tab.
    • FSCLending — A flow for Financial Services Cloud Mortgage. This value is available in API version 46.0 and later.
    • IdentityUserRegistrationFlow — A flow to handle user registration and updates for single sign-on with the authentication provider framework. Available in API version 64.0 and later.
    • IndicatorResultFlow — A flow for Outcome Management that calculates and creates indicator results for a selected indicator performance period. This value is available with the Outcome Management license in API version 60.0 and later.
    • IndividualObjectLinkingFlow — A flow that associates individuals with interactions such as voice calls, messaging sessions, or case-related emails. This value is available in API version 58.0 and later.
    • InvocableProcess — A process that another process or the Invocable Actions resource in REST API invokes. This value is available in API version 38.0 and later.
    • Journey — An audience-driven flow for Marketing Cloud. This value is available in API version 57.0 and later.
    • LoginFlow
    • LoyaltyManagementFlow — A flow for the Loyalty Management app that’s invokable by loyalty program processes. This value is available in API version 54.0 and later.
    • Orchestrator — An orchestration that organizes flows into groups of steps contained in a series of stages. This value is available in API version 53.0 and later.
    • PromptFlow — A flow for Prompt Builder. Pass data between Prompt Builder and the flow. This value is available in API version 60.0 and later.
    • RecommendationStrategy — Build recommendations for your users. A recommendation launches its assigned flow. This value is available in API version 54.0 and later. See Flow Builder Strategies.
    • RoutingFlow — A flow for Salesforce Omni-Channel routing and other business logic. This value is available in API version 52.0 and later.
    • Survey — A flow for Salesforce Surveys. From the UI, this type of flow is created in Survey Builder. This value is available in API version 42.0 and later.
    • SurveyEnrich — A Salesforce Surveys flow that uses the Survey Data Mapper. From the UI, this type of flow is created in the Survey Builder and requires an associated survey flow type. This value is available in API version 49.0 or later and only when the Customer Lifecycle Designer license is enabled.
    • Workflow — A process that is invoked when a record is created or edited. In the UI and Salesforce Help, it’s a record change process.
    • ActionPlan
    • AppProcess
    • CartAsyncFlow
    • DigitalForm
    • JourneyBuilderIntegration
    • ManagedContentFlow
    • OrchestrationFlow
    • SalesEntryExperienceFlow
    • TransactionSecurityFlow
    • UserProvisioningFlow
  • Type: FlowRecordCreate[]
  • Required: No
  • Description: An array of nodes for creating records in the database.
  • Type: FlowRecordDelete[]
  • Required: No
  • Description: An array of nodes for deleting records in the database.
  • Type: FlowRecordLookup[]
  • Required: No
  • Description: An array of nodes for looking up records in the database.
  • Type: FlowRecordRollback[]
  • Required: No
  • Introduced: API version 52.0
  • Description: An array of nodes for rolling back transactions in the screen flow.
  • Type: FlowRecordUpdate[]
  • Required: No
  • Description: An array of nodes for updating records in the database.
  • Type: FlowRunInMode (enumeration of type string)
  • Required: No
  • Introduced: API version 48.0
  • Description: The context that the flow runs in.
  • Possible values:
    • DefaultMode — How the flow is launched determines whether the flow runs in user context or in system context. In the UI, this value appears as User or System Context—Depends on How Flow is Launched.
    • SystemModeWithSharing — The flow respects org-wide default settings, role hierarchies, sharing rules, manual sharing, teams, and territories. The flow doesn’t respect object permissions, field-level access, or other permissions of the running user. In the UI, this value appears as System Context with Sharing—Enforces Record-Level Access.
    • SystemModeWithoutSharing— — The flow can access all data. In the UI, this value appears as System Context without Sharing—Access All Data. This value is available in API version 49.0 and later.
    • UserMode — The flow runs with the user’s security context explicitly enforced, without inheriting sharing settings from the calling context. In the UI, this value appears as User Context—Enforces User Permissions. This value is available in API version 68.0 and later.
  • Type: FlowScreen[]
  • Required: No
  • Description: An array of screen nodes.
  • Type: string
  • Required: No
  • Description: Reserved for future use.
  • Type: string
  • Required: No
  • Type: FlowStage[]
  • Required: No
  • Introduced: API version 42.0
  • Description: An array of stage resources that you can use throughout the flow.
  • Type: FlowStart
  • Required: No
  • Introduced: API version 47.0
  • Description: The flow’s Start element, which specifies how and when the flow starts.

  • Type: string

  • Required: No

  • Description: Specifies which node or element is the starting point in the flow.

    This field isn’t used in flows created or saved in Flow Builder in Winter ’20 and later. Those flows use the start field instead to specify how the flow starts.

  • Type: FlowVersionStatus (enumeration of type string)
  • Required: No
  • Description: The activation status of the flow.
  • Possible values:
    • Active
    • Draft — In the UI, this status appears as Inactive.
    • Obsolete — In the UI, this status appears as Inactive.
    • InvalidDraft — In the UI, this status appears as Draft.
    • UnderReview — In the UI, this status appears as Under Review.
  • Type: FlowStep[]
  • Required: No
  • Description: An array of step nodes.
  • Type: FlowSubflow[]
  • Required: No
  • Introduced: API version 25.0
  • Description: An array of subflows.
  • Type: string
  • Required: No
  • Introduced: API version 56.0
  • Description: The ID that defines the time zone in which the flow runs.
  • Type: FlowTransform[]
  • Required: No
  • Introduced: API version 59.0
  • Description: An array of data transformations.
  • Type: FlowVariable[]
  • Required: No
  • Description: An array of variable definitions.
  • Type: FlowWait[]
  • Required: No
  • Introduced: API version 32.0
  • Description: An array of wait nodes.

Defines a call to an action from the flow.

This metadata type is available in API version 31.0 and later.

This type extends FlowNode and inherits its fields.

  • Type: string
  • Required: No
  • Description: Required. Name for the action. Must be unique across actions with the same actionType.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after this action call.
  • Type: FlowDataTypeMapping[]
  • Required: No
  • Introduced: API version 48.0
  • Description: An array of data type mappings for input and output values that have the generic sObject data type.
  • Type: string
  • Required: No
  • Description: Reserved for future use.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute if the action call results in an error.
  • Type: FlowTransactionModel (enumeration of type string)
  • Required: No
  • Introduced: API version 51.0
  • Description: Required. Specifies the transactional model for flows that execute invocable actions.
  • Possible values:
    • Automatic — Creates a transaction if the invocable action supports it and there’s pending DML.
    • CurrentTransaction — Keeps the invocable action running in the same transaction.
    • NewTransaction — Creates a transaction before the invocable action is executed.
  • Type: boolean
  • Required: No
  • Introduced: API version 61.0
  • Description: Specifies whether to pause the flow until the action is completed.
  • Type: string
  • Required: No
  • Version: This field is available in API version 58.0 to 61.0.

This field is deprecated in API version 62.0 and later.

  • Description: Specifies the name of the versioned action. Supported only when nameSegment is specified.
  • Type: int
  • Required: No
  • Introduced: API version 61.0
  • Description: Specify the number of months, days, hours, or minutes to pause the flow while it waits for the action to be completed.
  • Type: FlowScheduledPathOffsetUnit (enumeration of type string)
  • Required: No
  • Introduced: API version 61.0
  • Description: Specify the time unit used to wait when the async action executes.
  • Possible values:
    • Months
    • Days
    • Hours
    • Minutes
  • Type: boolean
  • Required: No
  • Introduced: API version 48.0
  • Description: Indicates whether the action’s output parameters are automatically available in the flow without creating any variables. When the value is true, you can reference an output parameter by specifying the API name of the Action element in the flow. The default value is false. When the value is false, create variables manually to store output values from the action.
  • Type: FlowConnector
  • Required: No
  • Introduced: API version 62.0
  • Description: Specifies which node to execute if an async action execution is timed out.
  • Type: FlowActionCallTimeoutPath (enumeration of type string)
  • Required: No
  • Introduced: API version 66.0
  • Description: Include or exclude a timeout path for an asynchronous action in a flow.
  • Possible values:
    • DisableTimeoutPath
    • EnableTimeoutPath
  • Type: int
  • Required: No
  • Version: This field is available in API version 58.0 to 61.0.

This field is deprecated in API version 62.0 and later.

  • Description: Specifies the version of the versioned action. By default, the value is 1. Supported only when versionSegment is specified.
  • Type: string
  • Required: No
  • Description: Reserved for future use.

Defines an input parameter from the flow to the action. This metadata type is available in API version 31.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the input parameter.

Defines an output parameter from the action to the flow. This metadata type is available in API version 31.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. Specifies the variable that you want to assign the target output value to.
  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the output parameter.

A path determines which node of the flow is executed after the Einstein Decision element. A path defines and links to the subsequent node. This metadata type is available in API version 63.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: FlowConnector
  • Required: Yes
  • Description: Required. Which node to execute after completing the current node.
  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the path.

Defines a call to an Apex plug-in from the flow.

This type extends FlowNode and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. The name of the Apex class.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after this Apex plug-in call.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute if the Apex plug-in call results in an error.

Defines an input parameter from the flow to the Apex plug-in.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the input parameter.

Defines an output parameter from the Apex plug-in to the flow.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. Specifies the variable that you want to assign the target output value to.
  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the output parameter.

Defines an assignment node that can dynamically change the value of a variable in the flow.

This type extends FlowNode and inherits its fields.

  • Type: FlowAssignmentItem[]
  • Required: No
  • Description: An array of assignment operations that’s executed in the given order, starting from the index 0.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after this assignment node.

Defines an operation to apply to a variable.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Description: Specifies the variable that you want to assign the target output value to.
  • Type: FlowElementReferenceOrValue
  • Required: No
  • Description: Defines the value that you want the operator to apply to the variable reference in the assignToReference field.

An enumeration of type string that specifies the operation to apply to the variable in the assignToReference field. See “Flow Operators in Assignment Elements” in Salesforce Help.

These values are valid.

Defines an attribute that’s shared across multiple Flow metadata subtypes.

This type extends FlowBaseElement and inherits its fields.

Introduced in API version 65.0.

  • Type: FlowAttributeType (enumeration of type string)

  • Required: Yes

  • Description: Specifies the type of the flow attribute value. Valid values are:

    • LlmDescription
    • LlmPrompt
  • Type: string
  • Required: No
  • Description: The value of the flow attribute.

Base class for all flow elements that require contextual information in metadata values. This class is an abstract class.

Introduced in API version 32.0.

Defines the data structure of a capability. When the capability is invoked, it triggers the flow to run and data is passed between the flow and capability. This metadata type is available in API version 60.0 and later.

This type extends FlowElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. The specified capability that the flow integrates with. The valid format is Name://Name, for example, PromptBuilder://SalesEmail
  • Type: FlowCapabilityInput[]
  • Required: No
  • Description: An array of capability inputs. The flow sets the input values and passes the data to the capability.

Defines the data structure of a capability input. This metadata type is available in API version 60.0 and later.

This type extends FlowElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. The input name is the same for the capability and the flow.
  • Type: string (enumeration of type string)
  • Required: No
  • Description: The data type of the capability input. Valid types are:
  • Possible values:
    • Boolean — This value is available in API version 61.0 and later.
    • Currency — This value is available in API version 61.0 and later.
    • Date — This value is available in API version 61.0 and later.
    • Number — This value is available in API version 61.0 and later.
    • sObject — This value corresponds to a record variable. This value is available in API version 60.0 and later.
    • String — This value is available in API version 61.0 and later.
  • Type: boolean
  • Required: Yes
  • Description: Required. Indicates whether the input is a collection of values. The default value is false.

A choice resource is a standalone choice option that you can reference or reuse throughout the flow. See Salesforce Help: Flow Resource: Choice.

This type extends FlowElement and inherits its fields.

  • Type: FlowIcon
  • Required: No
  • Introduced: API version 64.0
  • Description: The icon to display for the choice in the screen.
  • Type: string
  • Required: Yes
  • Description: Required. Choice label to display in the screen.
  • Type: FlowDataType (enumeration of type string)
  • Required: Yes
  • Description: Required. Valid types are:
  • Possible values:
    • Currency
    • Date
    • Number
    • String
    • Boolean
    • Time
  • Type: FlowChoiceUserInput
  • Required: No
  • Description: Enables the choice to allow user input when the choice is selected. Not supported for choices in multi-select fields.
  • Type: FlowElementReferenceOrValue
  • Required: No
  • Description: Actual value that’s used during flow execution, for example, in assignments, calls to Apex plug-ins, and record elements. If null, this choice always has the value of null.

Allows the choice to include a user input field that appears when the user selects a choice. User input isn’t supported for choices in multi-select fields.

This type extends FlowBaseElement and inherits its fields.

  • Type: boolean
  • Required: No
  • Description: Indicates whether users are required to enter something into the field when they select the choice.
  • Type: string
  • Required: No
  • Description: Text that’s displayed to prompt the user for input at runtime. Supports merge fields.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Type: FlowComparisonOperator (enumeration of type string)
  • Required: No

This type extends FlowElement and inherits its fields.

  • Type: string
  • Required: No
  • Type: FlowDataType (enumeration of type string)
  • Required: No
  • Type: string
  • Required: Yes
  • Type: string
  • Required: No
  • Type: boolean
  • Required: No
  • Type: string
  • Required: No
  • Type: string
  • Required: No

This type extends FlowBaseElement and inherits its fields.

  • Type: boolean
  • Required: No
  • Type: string
  • Required: No
  • Type: string
  • Required: No

Defines the rule to assign a value to the field reference. This metadata type is available in API version 51.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. Specifies the reference to the field to which the specified operator is applied.
  • Type: FlowElementReferenceOrValue
  • Required: Yes
  • Description: Required. Defines the value that the operator applies to the variable reference in the assignToFieldReference field.

Defines a node that processes the contents of a collection, depending on the collectionProcessorType.

This type extends FlowNode and inherits its fields.

Introduced in API version 50.0.

  • Type: string
  • Required: No
  • Description: The name of the variable that’s assigned to the next value of the collection.
  • Type: FlowCollectionProcessorType (enumeration of type string)
  • Required: Yes
  • Description: The type of the collection processor.
  • Possible values:
    • SortCollectionProcessor — This value is available in API version 50.0 and later.
    • RecommendationMapCollectionProcessor — This value is available in API version 53.0 and later.
    • FilterCollectionProcessor — This value is available in API version 53.0 and later.
  • Type: string
  • Required: Yes
  • Description: The collection being sorted, filtered, or assigned to recommendations.
  • Type: string (enumeration of type string)
  • Required: No
  • Description: Defines how the filtering conditions are evaluated.
  • Possible values:
    • And
    • Or
    • Custom logic, such as (1 AND (2 OR 3))
    • Formula
  • Type: FlowCondition[]
  • Required: No
  • Description: An array of conditions for the input collection.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after processing the collection.
  • Type: string
  • Required: No
  • Description: The formula expression that filters the input collection. If the formula evaluates to true, the record is added to the output collection.

  • Type: int

  • Required: No

  • Introduced: API version 51.0

  • Description: The maximum number of records to include in the generated collection. There’s no default value. All items of the collection are kept if it’s greater than the size of the collection.

    If sortField and sortOrder are also specified, the records are sorted before the limit takes effect.

    This field is nillable in API version 51.0 and later.

  • Type: string
  • Required: No
  • Description: The sObject type of the output collection.
  • Type: FlowCollectionSortOption[]
  • Required: No
  • Introduced: API version 51.0
  • Description: An array of options to sort the items in the collection.

Sets the sorting field, sort order, and placement of empty or null values in the sorted collection. This metadata type is available in API version 51.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: boolean
  • Required: Yes
  • Description: Place empty or null values first in the sorted list by setting this value to true. The default value is false.

  • Type: string

  • Required: No

  • Description: Determines the sorting of records that meet the filter criteria. Required for record collections and collections of Apex-defined variables.

    If the collection is a primitive data type, such as a list of string or integer values, sortField isn’t supported.

Defines a condition for a rule.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Type: string (enumeration of type string)
  • Required: No
  • Description: Operation to apply to the variable reference in the assignToReference field. The valid value is:
  • Possible values:
    • Count
  • Type: string (enumeration of type string)
  • Required: No
  • Description: Specifies logic for the conditions. Value can be:
  • Possible values:
    • and — Evaluates to true only if all its conditions evaluate to true
    • or — Evaluates to true if any of its conditions evaluate to true
  • Type: FlowCondition[]
  • Required: No
  • Description: An array of conditions that must be true for the flow to execute the rule.

  • Type: string

  • Required: No

  • Description: The type of condition that a requirement in an automation is used for. Valid values are:

    • Container
    • EntryCondition
    • ExitCondition
  • Type: string
  • Required: No
  • Description: Required. Unique name of the element that serves as the left side of the condition expression.
  • Type: FlowComparisonOperator (enumeration of type string)
  • Required: Yes
  • Description: Required. Comparison operators in conditions for flow elements and resources. The date comparison operators, such as IsAfter, IsBefore, and IsOn, apply to Date fields only, not DateTime fields. See Flow Operators.
  • Possible values:
    • Contains
    • EndsWith
    • EqualTo
    • GreaterThan
    • GreaterThanLastNumberOfDays — Returns true if the date value is more than N days before today. If N is a decimal, only the integer portion is used. This value is available in API version 67.0 and later.
    • GreaterThanOrEqualTo
    • HasError — This value is available in API version 64.0 and later.
    • HasNoValue — Returns true if the date value has no value. This value is available in API version 67.0 and later.
    • HasValue — Returns true if the date value has a value. This value is available in API version 67.0 and later.
    • In — This value is available in API version 56.0 and later.
    • IsAfter — Returns true if the date value is after the specified date. This value is available in API version 67.0 and later.
    • IsAnniversaryOfToday — Returns true if the month and day of the date value match today’s month and day. This value is available in API version 67.0 and later.
    • IsBefore — Returns true if the date value is before the specified date. This value is available in API version 67.0 and later.
    • IsBlank — A text value with zero characters or with only whitespace. Use to determine whether a text field or variable is blank. For other data type values, use to determine whether a field or variable is null. This value is available in API version 61.0 and later.
    • IsChanged— — This value is available in API version 52.0 and later.
    • IsEmpty — An empty collection. This value is available in API version 61.0 and later.
    • IsLastMonth — Returns true if the date value falls within the previous calendar month. This value is available in API version 67.0 and later.
    • IsNextMonth — Returns true if the date value falls within the next calendar month. This value is available in API version 67.0 and later.
    • IsNotAnniversaryOfToday — Returns true if the month and day of the date value don’t match today’s month and day. This value is available in API version 67.0 and later.
    • IsNull — A value that is either not set or references no value. Use to determine whether a field or variable value is set to no value.
    • IsOn — Returns true if the date value is the same as the specified date. This value is available in API version 67.0 and later.
    • IsThisMonth — Returns true if the date value falls within the current calendar month. This value is available in API version 67.0 and later.
    • IsToday — Returns true if the date value is today’s date. This value is available in API version 67.0 and later.
    • IsTomorrow — Returns true if the date value is tomorrow’s date. This value is available in API version 67.0 and later.
    • IsYesterday — Returns true if the date value is yesterday’s date. This value is available in API version 67.0 and later.
    • LastNumberOfDays — Returns true if the date value falls within the last N days, including today. If N is a decimal, only the integer portion is used. This value is available in API version 67.0 and later.
    • LastNumberOfMonths — Returns true if the date value falls within the last N calendar months, excluding the current month. If N is a decimal, only the integer portion is used. This value is available in API version 67.0 and later.
    • LastNumberOfYears — Returns true if the date value falls within the last N calendar years, excluding the current year. If N is a decimal, only the integer portion is used. This value is available in API version 67.0 and later.
    • LastYear — Returns true if the date value falls within the previous calendar year. This value is available in API version 67.0 and later.
    • LessThan
    • LessThanOrEqualTo
    • NextNumberOfDays — Returns true if the date value falls within the next N days, including today. If N is a decimal, only the integer portion is used. This value is available in API version 67.0 and later.
    • NextNumberOfMonths — Returns true if the date value falls within the next N calendar months, excluding the current month. If N is a decimal, only the integer portion is used. This value is available in API version 67.0 and later.
    • NextYear — Returns true if the date value falls within the next calendar year. This value is available in API version 67.0 and later.
    • None — Save a flow with an incomplete condition, so you can finish building the flow later. This value is available in API version 58.0 and later.
    • NotEqualTo
    • NotIn — This value is available in API version 56.0 and later.
    • StartsWith
    • ThisYear — Returns true if the date value falls within the current calendar year. This value is available in API version 67.0 and later.
    • WasSelected — Requires a choice on the left side.
    • WasSet — This value is available in API version 30.0 and later.
    • WasVisited — Requires a node on the left side.
  • Type: FlowElementReferenceOrValue
  • Required: No
  • Description: Unique name of an element or the actual value, such as text or a number, for the right side of the condition expression.

Connectors determine the order in which the nodes of the flow are executed. A connector defines and links to the subsequent node.

This type extends FlowBaseElement and inherits its fields.

  • Type: boolean
  • Required: No
  • Description: Make the connector a Go To Connector by setting this value to true. The default value is false. This value is available in API version 53.0 and later. See Flow Connectors.
  • Type: string
  • Required: Yes
  • Description: Required. Which node to execute after completing the current node.

A constant resource defines a fixed value that can be used throughout your flow.

This type extends FlowElement and inherits its fields.

  • Type: FlowDataType (enumeration of type string)
  • Required: Yes
  • Description: Required. Valid types are:
  • Possible values:
    • Currency
    • Date
    • Number
    • String
    • Boolean
    • Time
  • Type: FlowElementReferenceOrValue
  • Required: No
  • Description: Default value of the constant. This field can’t have merge fields, nor can it reference another resource besides $GlobalConstant.EmptyString.

Defines a custom error element to roll back a change that triggered a flow and inform the user exactly what caused the error.

This type extends FlowNode and inherits its fields.

  • Type: FlowConnector
  • Required: No
  • Description: Required. Which node to execute after completing the current node.
  • Type: string
  • Required: No
  • Description: Describes the error message.

Defines a custom error message for a custom error element.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. Specifies the custom error message.
  • Type: string
  • Required: No
  • Description: References the erroneous field that’s associated with the custom error message.
  • Type: boolean
  • Required: Yes
  • Description: Required. When this field is set to true, indicates that the custom error message displays inline on a field. When it is set to false, it displays in a window on a record page. The default value is false.

Defines the name and value of a custom property in a flow. This metadata type is available in API version 63.0 and later.

  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the custom property associated with the flow.
  • Type: FlowElementReferenceOrValue
  • Required: No
  • Description: Defines the value of the custom property associated with the flow. When the FlowCustomProperty’s name is set to ScreenProgressIndicator,
  • Possible values:
    • “Location”:“Top”,“Type”:“Simple”
    • “Location”:“Footer”,“Type”:“Simple”
    • “Location”:“Top”,“Type”:“Path”

Defines a data lookup in the flow’s Start element. This metadata type is available in API version 68.0 and later.

This type extends FlowElement and inherits its fields.

  • Type: string
  • Required: No
  • Description: Required. The field on the object specified by sourceApiName to use for the lookup join.
  • Type: string
  • Required: No
  • Description: Required. A reference expression for the lookup relationship from the primary record.
  • Type: string
  • Required: No
  • Description: Required. The API name of the object on which the data lookup is defined.
  • Type: string
  • Required: No
  • Description: Required. The type of the object specified by sourceApiName. Valid value is DataModelObject.

This data type mapping defines the specific sObject data type for input and out values that have the generic sObject data type. This metadata type is available in API version 48.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Introduced: API version 61.0
  • Description: The name of the Apex class.
  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Description: Required. API name of the input or output variable. The T__ prefix is required for input variables. The U__ prefix is required for output variables. For example, T__inputCollection represents the API name of the input variable inputCollection.
  • Type: string
  • Required: No
  • Description: API name of the specific sObject data type that this value maps to. For example, Account.
  • Type: string
  • Required: No
  • Type: string
  • Required: No

A node that evaluates a set of rules and routes the flow execution based on the first rule that evaluates to true.

This type extends FlowNode and inherits its fields.

  • Type: FlowAttribute[]
  • Required: No
  • Introduced: API version 65.0
  • Description: An array of attributes for the decision.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute if none of the rules evaluate to true.
  • Type: string
  • Required: No
  • Description: Label for the default connector.
  • Type: FlowRule[]
  • Required: No
  • Description: An array of rules for the decision. The rules are evaluated in the order that they’re listed, and the connector of the first true rule is used. If no rules are true, then the default connector is used. In Flow Builder, rules are referred to as decision outcomes.

Retrieves data or metadata from an object and dynamically generates a set of choices at run time. Depending on the fields that are set, this element represents a record choice or a picklist choice.

  • A record choice dynamically generates choices based on records that meet specified filter criteria. If a dynamic choice doesn’t have the picklistField and picklistObject parameters set, it’s a record choice and it can’t have a data type of Picklist or Multipicklist.
  • A picklist choice dynamically generates choices based on the available values for a picklist or multi-select picklist field. If a dynamic choice has the picklistField and picklistObject parameters set, it’s a picklist choice and it must have a data type of Picklist or Multipicklist.

This type extends FlowElement and inherits its fields.

  • Type: string
  • Required: No
  • Introduced: API version 54.0
  • Description: The collection that’s used to generate choices.

  • Type: FlowDataType (enumeration of type string)

  • Required: Yes

  • Description: Required. Valid types are:

    Picklist and Multipicklist are available in API version 35.0 and later. Record is available in API version 54.0 and later.

  • Possible values:

    • Boolean
    • Currency
    • Date
    • Multipicklist — Picklist choices only
    • Number
    • Picklist — Picklist choices only
    • Record
    • String
    • Time

  • Type: string

  • Required: Yes

  • Description: Required for record choices. Specifies the object field. The values of the object field are displayed to the user as choice labels for selecting a record.

    For example, for an account, if you want the dynamically generated choices to be displayed as the account names from the records that are retrieved from the database, specify Name in displayField.

    Not supported for picklist choices. Picklist choices always display the labels for the retrieved picklist values.

  • Type: string
  • Required: No

  • Type: FlowRecordFilter[]

  • Required: No

  • Description: An array of filters to apply to the records retrieved from the database. For example, filter accounts to include only the accounts that were created in the past three months.

    Not supported for picklist choices.

  • Type: int

  • Required: No

  • Introduced: API version 25.0

  • Description: Maximum number of choices to include in the generated set of choices. Maximum and default: 200.

    If sortField and sortOrder are also specified, the records are sorted before the limit takes effect.

    This field is nillable in API version 45.0 and later.

  • Type: string

  • Required: Yes

  • Description: Required for record choices. The object whose fields you want to retrieve from the database and use to generate the set of choices. For example, use “Account” to dynamically generate choices from the information in account records in the database.

    Not supported for picklist choices.

  • Type: FlowOutputFieldAssignment[]

  • Required: No

  • Description: An array that assigns fields from the user-selected record to variables that can be used elsewhere in the flow. For example, when the user selects an account name from the dynamically generated list of choice options, outputAssignments can assign the ID and AnnualRevenue from the user-selected account to variables that you specify.

    Not supported for picklist choices.

  • Type: string

  • Required: No

  • Introduced: API version 35.0

  • Description: Required for picklist choices. The field whose available values you want to retrieve from the database and use to generate the picklist choice. For example, use “Industry” to dynamically generate one choice for each available value on the Industry picklist field.

    Not supported for record choices.

  • Type: string

  • Required: No

  • Introduced: API version 35.0

  • Description: Required for picklist choices. The object whose field metadata you want to retrieve from the database and use to generate the picklist choice. For example, use “Account” to dynamically generate choices from a picklist field on the Account object.

    Not supported for record choices.

  • Type: string

  • Required: No

  • Introduced: API version 25.0

  • Description: Field that’s used for sorting records that meet the filter criteria. If this field isn’t specified, the returned records aren’t sorted.

    You can only sort records by fields that have the Sort API field property, as specified in SOAP API.

    Not supported for picklist choices.

  • Type: SortOrder (enumeration of type string)

  • Required: No

  • Introduced: API version 25.0

  • Description: Order in which to sort the records. If this field isn’t specified, then the results aren’t sorted.

    Not supported for picklist choices.

  • Possible values:

    • Asc — Ascending
    • Desc — Descending

  • Type: string

  • Required: No

  • Description: Stored value for the choice, which can differ from what is displayed to the user as the choice options (displayField). For example, the displayField could be the account “Name” while the valueField is the account “Id.”

    Not supported for picklist choices. Picklist choices always store the API value for the retrieved picklist values.

Base class for all flow elements. This class is an abstract class.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Description: Description of the flow element.
  • Type: string
  • Required: No
  • Description: Unique name of the flow element.

Defines a reference to an existing element or a particular value that you specify. Make sure that you specify only one of the fields.

  • Type: string
  • Required: No
  • Description: Use this field to specify a JSON response value of an Apex-defined record. Use this field only for FlowScreenFieldInputParameter and FlowActionCallInputParameter. If you want to specify a different data type or element reference, don’t use this field.
  • Type: boolean
  • Required: No
  • Description: Use this field to specify a boolean value. If you want to specify a different data type or element reference, don’t use this field.
  • Type: string (enumeration of type string)
  • Required: No
  • Introduced: API version 63.0
  • Description: When complexValueType is specified, use this field to specify flow resources and fields in the data structure. Use these fields to describe the data structure:
  • Possible values:
    • fieldReference — The list of field API names.
    • objectType — The object type, sObject or Apex.
    • type — The API name of the sObject or Apex class.
    • elementReference — The API name of the flow resource that contains the list of fields specified in fieldReference.
  • Type: FlowComplexValueType (enumeration of type string)
  • Required: No
  • Introduced: API version 63.0
  • Description: Use this field to specify the type of data structure to reference. Use complexValue to specify the data structure.
  • Possible values:
    • ComplexObjectFieldDetails — Use when referencing a field and need the label and type in addition to the API name.
    • JoinDefinition — When InnerJoin is specified in transformType, indicates flow resources for source and target collections, join keys, selected fields to join. and field mappings in a join transformation. JoinDefinition isn’t a valid value for FlowInlineTransform.
    • FieldReference — Use this field to define the flow resource and its fields referenced in the flow.
  • Type: dateTime
  • Required: No
  • Introduced: API version 30.0
  • Description: Use this field to specify a dateTime value. If you want to specify a different data type or element reference, don’t use this field.
  • Type: date
  • Required: No
  • Description: Use this field to specify a date value. If you want to specify a different data type or element reference, don’t use this field.
  • Type: string
  • Required: No
  • Description: Use this field to specify the name of an existing flow resource. If you want to specify a value instead of an element reference, don’t use this field.
  • Type: FlowDataType (enumeration of type string)
  • Required: No
  • Introduced: API version 59.0
  • Description: Use this field to specify the formula result’s data type of the transformed data. Corresponds to the target data field in Flow Builder. This field requires the formulaExpression field. See FlowTransform
  • Possible values:
    • Apex
    • Boolean
    • Currency
    • Date
    • DateTime
    • Number
    • String
    • sObject — This value corresponds to a record variable.
    • Time
  • Type: string
  • Required: No
  • Introduced: API version 59.0
  • Description: Use this field to specify the formula expression that transforms the data in the flow. In Flow Builder, it corresponds to the target data field in the Transform element. This field requires the formulaDataType field. See FlowTransform.
  • Type: FlowInputConfiguratorMode (enumeration of type string)
  • Required: No
  • Type: boolean
  • Required: No
  • Type: double
  • Required: No
  • Description: Use this field to specify a double value. If you want to specify a different data type or element reference, don’t use this field.
  • Type: string
  • Required: No
  • Description: Use this field to specify the name of an existing setup reference. Required for Omni-Channel elements. If you want to specify a value instead of a setup reference, don’t use this field. Required when setupReferenceType is specified.
  • Type: string
  • Required: No
  • Description: Use this field to specify the type of setup reference. Required when setupReference is specified.
  • Type: string
  • Required: No
  • Description: Use this field to specify a JSON response value of an sObject record. Use this field only for FlowScreenFieldInputParameter and FlowActionCallInputParameter. If you want to specify a different data type or element reference, don’t use this field.

  • Type: string

  • Required: No

  • Description: Use this field to specify a string value. If you want to specify a different data type or element reference, don’t use this field.

    When the FlowMetadataValue’s name field is set to SendNoApproverEmails, valid values are true or false and are case-insensitive.

    When the FlowMetadataValue’s name field is set to BuilderType or OriginalBuilderType, the valid value is LightningFlowBuilder. The value is reserved for internal use.

  • Type: xsd:time
  • Required: No
  • Type: FlowInlineTransform
  • Required: No
  • Introduced: API version 62.0
  • Description: Use this field to specify a value for an inline data transformation.
  • Type: string
  • Required: No
  • Description: Reserved for future use.
  • Type: string
  • Required: No

Marks where a path in a flow ends. Corresponds to the End element in Flow Builder. Available only in flows that use the Auto-Layout canvas.

This metadata type is available in API version 68.0 and later.

If a flow has 1 or more End elements, every path in the flow must end with an End element.

This type extends FlowNode and inherits its fields.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Type: string
  • Required: Yes

Defines the conditions and logic that enables an exit rule to evaluate to true. This metadata type is available in API version 62.0 and later.

This type extends FlowElement and inherits its fields.

  • Type: string
  • Required: No
  • Type: FlowCondition[]
  • Required: No
  • Description: An array of conditions for the exit rule.
  • Type: string
  • Required: Yes
  • Description: Required. Label for the exit rule.
  • Type: string (enumeration of type string)
  • Required: No
  • Description: Required. Logical operator in conditions for the exit rule.
  • Possible values:
    • and — Evaluates to true only if all its conditions evaluate to true
    • or — Evaluates to true if any of its conditions evaluate to true
  • Type: int
  • Required: Yes
  • Description: Indicates how the exit rule is ordered against other exit rules. The ruleOrder value must be unique within the flow.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes

A node that routes the flow execution based on a specified experiment distribution percentage. This metadata type is available in API version 61.0 and later.

This type extends FlowNode and inherits its fields.

  • Type: int
  • Required: No
  • Introduced: API version 64.0
  • Description: The amount of time that the experiment runs.

  • Type: FlowScheduledPathOffsetUnit (enumeration of type string)

  • Required: No

  • Introduced: API version 64.0

  • Description: The unit of measurement for experiment duration. Valid values are:

    • Minutes
    • Hours
    • Days
    • Weeks
    • Months
  • Type: FlowExperimentFallbackMode (enumeration of type string)
  • Required: No
  • Type: date
  • Required: No
  • Type: string
  • Required: No
  • Type: int
  • Required: No
  • Introduced: API version 64.0
  • Description: Specifies the distribution percentage of the test group. A valid number in the range 0-99.

  • Type: FlowExperimentType

  • Required: Yes

  • Description: Required. The type of experiment. Valid value is:

    • Random

Defines an experiment path. This metadata type is available in API version 61.0 and later.

This type extends FlowElement and inherits its fields.

  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after this experiment path.
  • Type: string
  • Required: Yes
  • Description: Required. Label for the path.
  • Type: int
  • Required: Yes
  • Description: Required. The distribution percentage for this path.

Calculates a value using functions and elements in the flow.

This type extends FlowElement and inherits its fields.

  • Type: FlowDataType (enumeration of type string)

  • Required: No

  • Introduced: API version 31.0

  • Description: The data type for the formula.

    dataType defaults to Number if it isn’t defined in a formula.

  • Possible values:

    • Boolean
    • Currency
    • Date
    • DateTime
    • Number
    • String
    • Time
  • Type: string
  • Required: Yes
  • Description: Required. Salesforce formula expression. The return value must match the data type. For API version 30.0 and earlier, the return value must be numeric.
  • Type: int
  • Required: No
  • Description: Scale of the return value, specifically, the number of digits to the right of the decimal point. Available only when the data type is Number or Currency. Corresponds to the Decimal Places field in Flow Builder.

Allows a resource to include an icon. This metadata type is available in API version 64.0 and later.

  • Type: string
  • Required: No
  • Introduced: API version 64.0
  • Description: The name of the selected Salesforce Lightning Design System icon.

Specifies how to transform source data to target data in an Action element within a flow. This metadata type is available in API version 62.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Description: The Apex class of the target data after transformation if its data type is Apex.
  • Type: FlowDataType (enumeration of type string)
  • Required: No
  • Description: Required. Specifies the data type of the transformed data. In Flow Builder, it corresponds to the target data. Valid types are:
  • Possible values:
    • Apex
    • Boolean
    • Currency
    • Date
    • DateTime
    • Multipicklist
    • Number
    • Picklist
    • sObject — This value corresponds to a record variable.
    • String
    • Time
  • Type: boolean
  • Required: No
  • Description: Indicates whether the variable is a collection of values. The default value is false.
  • Type: string
  • Required: No
  • Type: string
  • Required: No

Assigns the value for a record field based on a resource or static value.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Description: Required. The name of the field to assign a value to when a record is created or updated.

Validation rules verify that the data entered by the user meets the specified requirements. If the validation rule evaluates to false, then the specified error message is displayed.

  • Type: string
  • Required: Yes
  • Description: Required. The error message to display when formulaExpression is false.
  • Type: string
  • Required: Yes
  • Description: Required. A formula that’s used to validate the user input.

A construct for iterating through a collection.

This type extends FlowNode and inherits its fields.

Introduced in API version 30.0.

  • Type: string
  • Required: No
  • Description: The variable that’s assigned to the current value in the collection before navigating to the target of nextValueConnector.
  • Type: string
  • Required: No
  • Description: The collection being looped through.
  • Type: IterationOrder (enumeration of type string)
  • Required: No
  • Description: Valid values are: Asc —Iterate through the collection in the order the values are listed (first to last). Desc —Iterate through the collection in the reverse order the values are listed (last to first).
  • Possible values:
    • Asc — Iterate through the collection in the order the values are listed (first to last).
    • Desc — Iterate through the collection in the reverse order the values are listed (last to first).
  • Type: FlowConnector
  • Required: No
  • Description: A reference to the next element in the collection.
  • Type: FlowConnector
  • Required: No
  • Description: The element to navigate to when all entries in the collection have been iterated through.

Defines contextual information that can be passed between elements in a flow. Flow metadata values can be used in an application that produces or consumes flows.

Introduced in API version 31.0.

  • Type: string

  • Required: Yes

  • Description: Required. Name for the metadata value. This name doesn’t need to be unique across all elements.

    To specify that a flow approval process send no email notifications to approvers, use SendNoApproverEmails .

A node is a type of element that’s visible in the flow diagram.

This type extends FlowElement and inherits its fields.

  • Type: FlowElementSubtype (enumeration of type string)
  • Required: No
  • Description: Reserved for internal use.
  • Possible values:
    • SortCollectionProcessor
    • RecommendationMapCollectionProcessor
    • FilterCollectionProcessor
    • WaitDate
    • WaitUntilEvent
    • WaitAttribute
    • WaitDuration
    • InteractiveStep
    • BackgroundStep
    • MuleSoftStep
    • ManagedContentRoleInteractiveStep
    • ManagedContentVariantSetLockBackgroundStep
    • ManagedContentVariantSetReadyBackgroundStep
    • ManagedContentVariantAutoPublishBackgroundStep
    • ManagedContentVariantAutoUnpublishBackgroundStep
    • AddPromptInstructions
    • ApprovalStep
    • AgxBackgroundStep
    • AgxInteractiveStep
    • SendToFlow
    • SplitPathByDate
    • SplitPathByField
  • Type: string
  • Required: No
  • Introduced: API version 68.0
  • Description: Name of the group that the node belongs to.
  • Type: string
  • Required: No
  • Description: Name of the node. This non-unique label is different from the unique name of the node, which is inherited from FlowElement.
  • Type: int
  • Required: Yes
  • Description: Required. Horizontal location of the node, in pixels from the left. In API version 64.0 and later, if a flow is saved in auto-layout, this field is set to 0.
  • Type: int
  • Required: Yes
  • Description: Required. Vertical location of the node, in pixels from the top. In API version 64.0 and later, if a flow is saved in auto-layout, this field is set to 0.

A group of flow nodes for organizational purposes. This metadata type is available in API version 68.0 and later.

This type extends FlowNode and inherits its fields.

  • Type: FlowConnector
  • Required: No
  • Description: Reserved for future use.
  • Type: FlowNodeGroupType (enumeration of type string)
  • Required: Yes
  • Description: Required. Type of group.
  • Possible values:
    • generic

  • Type: string

  • Required: No

  • Description: Connector branch that the group is on. Valid values depend on the sourceReference value:

    • Start (immediate path): immediate
    • Start (scheduled path): The API name of the path.
    • Standard element: regular
    • Decision (outcome): The API name of the outcome.
    • Decision (default path): default
    • Loop (for each item): forEach
    • Loop (after last item): noMoreValues
    • Fault path: fault
  • Type: string
  • Required: No
  • Description: Name of the node immediately preceding the group. If the preceding node is the Start element, use __Start.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Description: The label that identifies this component in the Salesforce UI and in metadata listings. Character limits and translation behavior follow the enclosing type.
  • Type: string
  • Required: No

A stage node that contains steps in an orchestration. This metadata type is available in API version 53.0 and later.

This type extends FlowNode and inherits its fields.

  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after this stage.
  • Type: FlowStageStepExitActionInputParameter[]
  • Required: No
  • Description: An array of input parameters from the stage to the evaluation flow. These parameters specify an exit condition for the stage.
  • Type: string
  • Required: No
  • Description: The name of the evaluation flow used as an exit condition for the stage.
  • Type: FlowStageStepExitActionOutputParameter[]
  • Required: No
  • Description: An array of output parameters from the evaluation flow to the stage. These parameters specify an exit condition for the stage.
  • Type: string (enumeration of type string)
  • Required: No
  • Description: Defines how the stage exit conditions are evaluated.
  • Possible values:
    • And
    • Or
    • Custom logic, such as (1 AND (2 OR 3))
    • Formula
  • Type: FlowCondition[]
  • Required: No
  • Description: An array of requirements that must be met to exit the stage.
  • Type: FlowStageStep[]
  • Required: No
  • Description: An array of stage step resources.

Assigns a record field’s value to a variable that can be used elsewhere in the flow.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. Reference to the variable where you want to store the value of the record field.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the field whose value is to be assigned after a record lookup.

Create a record in the database using values from the flow.

The flow record create, lookup, update, and delete operations are different from the CRUD-based metadata calls create(), retrieve(), update(), and delete(). The flow record methods apply to record operations from within a flow, which aren’t the same as doing any metadata calls to CRUD setup entities.

This type extends FlowNode and inherits its fields.

The flow record create , lookup , update , and delete operations are different from the CRUD-based metadata calls create() , retrieve() , update() , and delete() . The flow record methods apply to record operations from within a flow, which aren’t the same as doing any metadata calls to CRUD setup entities.
  • Type: string
  • Required: No
  • Description: Reference to the variable where you want to store the ID after the record is created.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after creating the record.
  • Type: boolean
  • Required: No
  • Introduced: API version 62.0
  • Description: Indicates whether the element creates or updates records. The default value is false, indicating that the element only creates records.

  • Type: boolean

  • Required: No

  • Introduced: API version 62.0

  • Description: Indicates whether the element creates or updates records only if all records are created or updated successfully. If set to true and a record fails, then the transaction rolls back and no records are created or updated.

    If set to false, the transaction creates or updates only the records that are successful. The default value is true.

  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute if the attempt to create a record results in an error.
  • Type: string
  • Required: No
  • Introduced: API version 61.0
  • Description: The filter logic applied to the filter condition requirements. To require all conditions, use AND. To require any conditions, use OR. For custom condition logic, enter the entire logic string. For example, 1 AND 2 OR (3 AND 4).
  • Type: FlowRecordFilter[]
  • Required: No
  • Introduced: API version 61.0
  • Description: An array that specifies the criteria to select which records to create or update in the database.
  • Type: FlowInputFieldAssignment[]
  • Required: No
  • Description: An array that assigns values to the specified fields of the record being created.
  • Type: string
  • Required: No
  • Description: Specifies the record variable whose field values are used to populate the new record’s fields.
  • Type: string
  • Required: No
  • Description: Required. The object type that the element creates.
  • Type: string (enumeration of type string)
  • Required: No
  • Introduced: API version 61.0
  • Description: The operation to perform if multiple matching records are found.
  • Possible values:
    • None
    • UpdateAllRecords
    • UpdateLatestRecord
  • Type: string (enumeration of type string)
  • Required: No
  • Introduced: API version 61.0
  • Description: The operation to perform if one matching record is found.
  • Possible values:
    • None
    • UpdateAllRecords
  • Type: string (enumeration of type string)
  • Required: No
  • Introduced: API version 61.0
  • Description: The operation to perform if no matching records are found.
  • Possible values:
    • None
  • Type: boolean
  • Required: No
  • Introduced: API version 48.0
  • Description: Indicates whether the record ID is automatically available in the flow without creating any variables. When the value is true, you can reference the record ID by specifying the API name of the Create Records element in the flow. The default value is false. When the value is false, create a variable to store the record ID.
  • Type: string
  • Required: No
  • Introduced: API version 62.0
  • Description: If doesUpsert is true, specifies the external ID field on the record. You can provide a value for this property or for the Upsert Standard ID Field property, but not both.
  • Type: string
  • Required: No
  • Introduced: API version 62.0
  • Description: If doesUpsert is true, specifies the standard ID field like Account ID on the object. You can provide a value for this property or for the Upsert External ID Field property, but not both.

Deletes one or more records in the database.

The flow record create, lookup, update, and delete operations are different from the CRUD-based metadata calls create(), retrieve(), update(), and delete(). The flow record methods apply to record operations from within a flow, which aren’t the same as doing any metadata calls to CRUD setup entities.

This type extends FlowNode and inherits its fields.

The flow record create , lookup , update , and delete operations are different from the CRUD-based metadata calls create() , retrieve() , update() , and delete() . The flow record methods apply to record operations from within a flow, which aren’t the same as doing any metadata calls to CRUD setup entities.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after deleting the record.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute if the attempt to delete a record results in an error.
  • Type: string
  • Required: No
  • Type: FlowRecordFilter[]
  • Required: No
  • Description: An array that specifies the criteria used to select which records to delete from the database. For example, delete accounts whose last activity was older than a specified date.
  • Type: string
  • Required: No
  • Description: Specifies the record variable whose record ID is used to identify which record to delete in the database.
  • Type: string
  • Required: No
  • Description: Required. The name of the object whose records are deleted.

Sets the criteria for searching records in the database.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Description: Required. The field to be used for filtering records.
  • Type: FlowRecordFilterOperator (enumeration of type string)
  • Required: No
  • Description: Required.
  • Possible values:
    • EqualTo
    • NotEqualTo
    • GreaterThan
    • LessThan
    • GreaterThanOrEqualTo
    • LessThanOrEqualTo
    • StartsWith
    • EndsWith
    • Contains
    • IsNull

Finds records in the database and stores their field values in the flow. Corresponds to a Get Records element in Flow Builder.

The flow record create, lookup, update, and delete operations are different from the CRUD-based metadata calls create(), retrieve(), update(), and delete(). The flow record methods apply to record operations from within a flow, which aren’t the same as doing any metadata calls to CRUD setup entities.

This type extends FlowNode and inherits its fields.

The flow record create , lookup , update , and delete operations are different from the CRUD-based metadata calls create() , retrieve() , update() , and delete() . The flow record methods apply to record operations from within a flow, which aren’t the same as doing any metadata calls to CRUD setup entities.
  • Type: boolean
  • Required: No
  • Introduced: API version 30.0
  • Description: Specifies that all values are set to null when no record is found. Supported only when storeOutputAutomatically is false.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after getting records from the database.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute if the attempt to get records results in an error.
  • Type: string
  • Required: No
  • Introduced: API version 50.0
  • Description: The filter logic that’s applied to the filter condition requirements. To require all conditions, use AND. To require any conditions, use OR. For custom condition logic, enter the entire logic string. For example, 1 AND 2 OR (3 AND 4).

  • Type: FlowRecordFilter[]

  • Required: No

  • Description: An array that specifies the criteria used to select the record from the database.

    If the filters return more than one record, they’re sorted according to the specified sortField and sortOrder. If outputReference specifies a non-collection record variable or if getFirstRecordOnly is true, only the first record in the sorted list is selected.

    If sortField or sortOrder isn’t specified, records aren’t returned in any particular order. If outputReference specifies a non-collection record variable or if getFirstRecordOnly is true, only the first record in the unsorted list is selected.

  • Type: boolean
  • Required: No
  • Introduced: API version 47.0
  • Description: Indicates whether to store field values for only one record, even when multiple records meet the filter criteria. Supported only when storeOutputAutomatically is true. When storeOutputAutomatically is false, what determines whether one or multiple records are stored is whether outputReference specifies a record variable or a record collection variable.
  • Type: FlowElementReferenceOrValue
  • Required: No
  • Introduced: API version 63.0
  • Description: Specifies the maximum number of records to store. Valid values are between 2 and 20,000. Supported only when getFirstRecordOnly is false.
  • Type: string
  • Required: No
  • Description: Name of the object from which to select the record.
  • Type: FlowOutputFieldAssignment[]
  • Required: No
  • Description: An array that assigns fields from the selected record to variables that can be used elsewhere in the flow. Supported only when storeOutputAutomatically is false.
  • Type: string
  • Required: No
  • Description: Specifies the record variable or record collection variable that stores the queried fields’ values. Supported only when storeOutputAutomatically is false.
  • Type: string[]
  • Required: No
  • Description: An array that specifies which fields from the selected record are saved to the specified record variable.
  • Type: FlowRelatedRecordLookup[]
  • Required: No
  • Description: An array that specifies the related records to look up in the database.

  • Type: string

  • Required: No

  • Introduced: API version 25.0

  • Description: The field that’s used for sorting the records that meet the filter criteria. If this field isn’t specified, the returned records aren’t sorted.

    You can only sort records by fields that have the Sort API field property, as specified in SOAP API.

  • Type: SortOrder (enumeration of type string)
  • Required: No
  • Introduced: API version 25.0
  • Description: Order in which to sort the records. If this field isn’t specified, then the results aren’t sorted.
  • Possible values:
    • Asc — Ascending
    • Desc — Descending
  • Type: boolean
  • Required: No
  • Introduced: API version 47.0
  • Description: Indicates whether the returned records’ field values are automatically available in the flow without creating any variables. When the value is true, the flow can reference a field by specifying the name of the Get Records element and the record field, such as Get_Contacts.AccountId. Supported only when processType is Flow or AutoLaunchedFlow.

Rolls back the current transaction and cancels its pending record changes. Corresponds to the Roll Back Records element in Flow Builder. Available only in screen flows.

This metadata type is available in API version 52.0 and later.

This type extends FlowNode and inherits its fields.

  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after rolling back the current transaction.

Finds records in the database and updates them with values from the flow.

The flow record create, lookup, update, and delete operations are different from the CRUD-based metadata calls create(), retrieve(), update(), and delete(). The flow record methods apply to record operations from within a flow, which aren’t the same as doing any metadata calls to CRUD setup entities.

This type extends FlowNode and inherits its fields.

The flow record create , lookup , update , and delete operations are different from the CRUD-based metadata calls create() , retrieve() , update() , and delete() . The flow record methods apply to record operations from within a flow, which aren’t the same as doing any metadata calls to CRUD setup entities.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after completing the record update.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute if the attempt to update a record results in an error.
  • Type: string
  • Required: No
  • Type: FlowRecordFilter[]
  • Required: No
  • Description: An array that specifies the criteria used to select the records to update in the database.
  • Type: FlowInputFieldAssignment[]
  • Required: No
  • Description: An array that assigns values to the specified fields of the record being updated.
  • Type: string
  • Required: No
  • Description: Specifies the record variable whose field values are used to update the record’s fields.
  • Type: string
  • Required: No
  • Description: Required. Name of the object whose records are updated.

This feature is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer’s sole discretion.

Finds records in the database that are related to the records specified in FlowRecordLookup and stores their field values in the flow. Corresponds to a Get Records element in Flow Builder.

This type extends FlowBaseElement and inherits its fields.

Beta.

This feature is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory . Use of this pilot or beta service is at the Customer’s sole discretion.
  • Type: string
  • Required: No
  • Description: The filter logic that’s applied to the filter condition requirements. To require all conditions, use AND. To require any conditions, use OR. For custom condition logic, enter the entire logic string. For example, 1 AND 2 OR (3 AND 4).

  • Type: FlowRecordFilter[]

  • Required: No

  • Description: An array that specifies the criteria used to select the record from the database.

    If the filters return more than one record, they’re sorted according to the specified sortField and sortOrder. If outputReference specifies a non-collection record variable or if getFirstRecordOnly is true, only the first record in the sorted list is selected.

    If sortField or sortOrder isn’t specified, records aren’t returned in any particular order. If outputReference specifies a non-collection record variable or if getFirstRecordOnly is true, only the first record in the unsorted list is selected.

  • Type: boolean
  • Required: No
  • Description: Indicates whether to store field values for only one record, even when multiple records meet the filter criteria. Supported only when storeOutputAutomatically is true. When storeOutputAutomatically is false, what determines whether one or multiple records are stored is whether outputReference specifies a record variable or a record collection variable.
  • Type: FlowElementReferenceOrValue
  • Required: No
  • Description: Specifies the maximum number of records to store. Valid values are between 2 and 20,000. Supported only when getFirstRecordOnly is false.
  • Type: string[]
  • Required: No
  • Description: An array that specifies which fields from the selected record are saved to the specified record variable.
  • Type: string
  • Required: No
  • Description: Name of the related object from which to select related records.
  • Type: FlowRelatedRecordLookup[]
  • Required: No
  • Description: An array that specifies the related records to look up in the database.
  • Type: string
  • Required: No
  • Description: Specifies the API name of the relationship field used to link the object to its related object. This field is required for retrieving related records.

  • Type: string

  • Required: No

  • Description: The field that’s used for sorting the records that meet the filter criteria. If this field isn’t specified, the returned records aren’t sorted.

    You can only sort records by fields that have the Sort API field property, as specified in SOAP API.

  • Type: SortOrder (enumeration of type string)
  • Required: No
  • Description: Order in which to sort the records. If this field isn’t specified, then the results aren’t sorted.
  • Possible values:
    • Asc — Ascending
    • Desc — Descending

Defines the conditions and logic that enables a rule to evaluate to true.

This type extends FlowElement and inherits its fields.

  • Type: FlowAttribute[]
  • Required: No
  • Introduced: API version 65.0
  • Description: An array of attributes for the flow rule.

  • Type: string

  • Required: Yes

  • Description: Specifies logic for the conditions. Value can be:

    • and—Evaluates to true if all of its conditions are true.
    • or—Evaluates to true if any conditions are true.
    • Advanced logic like 1 AND (2 OR 3)—Evaluates to true if the first condition is true and either the second or third condition is true.

    When you use advanced logic, the string can contain up to 1,000 characters.

  • Type: FlowCondition[]
  • Required: No
  • Description: An array of conditions for the rule.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute if this rule evaluates to true in a decision first.
  • Type: boolean
  • Required: No
  • Introduced: API version 50.0
  • Description: If set to true, conditions evaluate to true only if the record didn’t meet the required conditions before the triggering update but now meets the conditions after the update.
  • Type: boolean
  • Required: No
  • Type: string
  • Required: Yes
  • Description: Required. Label for the connector.

Specifies when and how frequently to run the flow. This metadata type is available in API version 47.0 and later.

  • Type: int
  • Required: No
  • Introduced: API version 66.0
  • Description: The number of the day of the month on which the flow runs. For example, 1 is the first day of the month, 2 is the second day of the month, and so on. You can use -1 for the last day of the month.
  • Type: string
  • Required: No
  • Introduced: API version 66.0
  • Description: The number of the days of the week on which the flow is to run. For example, 1, 2, 3, where 1 is Sunday, 2 is Monday, and so on.
  • Type: date
  • Required: No
  • Description: Reserved for future use.
  • Type: xsd:time
  • Required: No
  • Description: Reserved for future use.
  • Type: FlowStartFrequency (enumeration of type string)
  • Required: No
  • Description: Specifies how frequently to run the flow.
  • Possible values:
    • Once
    • Daily
    • Weekly
    • OnActivate — For segment-triggered flows only. This value is available in API version 49.0 and later.
    • Hourly — For segment-triggered flows only. This value is available in API version 66.0 and later.
    • Monthly — For segment-triggered flows only. This value is available in API version 66.0 and later.
    • Weekdays — For segment-triggered flows only. This value is available in API version 66.0 and later.
    • Yearly — For segment-triggered flows only. This value is available in API version 66.0 and later.
  • Type: int
  • Required: No
  • Introduced: API version 66.0
  • Description: For segment-triggered flows only. The number of times to run the flow for this schedule based on the frequency value. For example, if this field is 2, and frequency is Hourly, the flow runs every hour for 2 hours . When this number is met, the flow no longer runs for this schedule.
  • Type: date
  • Required: No
  • Description: The date when the flow runs, or when the flow’s run schedule starts recurring.
  • Type: xsd:time
  • Required: No
  • Description: The time of day when the flow runs, based on the org’s default time zone.

Defines a scheduled path. This metadata type is available in API version 51.0 and later.

This type extends FlowElement and inherits its fields.

  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after this scheduled path.
  • Type: string
  • Required: No
  • Description: Label for the scheduled path.
  • Type: int
  • Required: No
  • Description: The maximum number of scheduled path interviews to execute in a single batch, from 1 to 200. Default is 200.
  • Type: int
  • Required: No
  • Description: Number of months, days, hours, or minutes to offset the time that the scheduled path executes. Negative values offset the time to execute before the provided time. Positive values offset the time to execute after the provided time.
  • Type: FlowScheduledPathOffsetUnit (enumeration of type string)
  • Required: No
  • Description: Specify the time unit used to offset when the scheduled path executes.
  • Possible values:
    • Months — This value is available in API version 56.0 and later.
    • Days
    • Hours
    • Minutes
  • Type: FlowScheduledPathType (enumeration of type string)
  • Required: No
  • Description: The type of scheduled path. null is used for time-triggered and record-triggered paths. The default value is null.
  • Possible values:
    • AsyncAfterCommit — The scheduled path runs asynchronously after a save.
  • Type: string
  • Required: No
  • Description: Field used to determine when the scheduled path executes. The field’s object is defined in FlowStart.
  • Type: FlowScheduledPathTimeSource (enumeration of type string)
  • Required: No
  • Description: Specify if a field or event is used to determine when the scheduled path executes.
  • Possible values:
    • RecordField
    • RecordTriggerEvent

Screens capture information from users and display information to users.

This type extends FlowNode and inherits its fields.

  • Type: FlowScreenAction[]
  • Required: No
  • Introduced: API version 59.0
  • Description: An array of screen actions.

  • Type: boolean

  • Required: No

  • Introduced: API version 26.0

  • Description: Indicates whether to show (true) or hide (false) the Previous button on the screen at runtime. When true, the Previous button appears only if the user visited a previous screen in the flow path and if showFooter for the screen is set to true. Set this field to false when revisiting the previous screen triggers an action that you don’t want repeated, such as a credit card transaction.

    Default: true

    You can set either allowBack or allowFinish to false, but not both.

  • Type: boolean

  • Required: No

  • Introduced: API version 26.0

  • Description: Indicates whether to show (true) or hide (false) the Finish button on the screen at runtime. When true, the Finish button appears only if the screen element is the end of a flow path, and if showFooter for the screen is set to true. The default value is true.

    Set to false if user is required to go back to a previous screen to continue or complete the flow. For example, don’t include a Finish button on a screen that tells the user to go back and make corrections on a previous screen.

    You can set allowBack or allowFinish to false, but not both.

  • Type: boolean

  • Required: No

  • Introduced: API version 33.0

  • Description: Indicates whether to show (true) or hide (false) the Pause button on the screen at runtime. The default value is true.

    A flow screen displays the Pause button if all these conditions are true.

    • Let users pause flows is enabled in the organization’s process automation settings.
    • allowPause for the screen is set to true.
    • If the flow is embedded in a Visualforce page, the flow:interview component has its showAllowPause attribute set to true.
    • The showFooter field for the screen is set to true.
  • Type: string
  • Required: No
  • Description: A label for the Back button.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after the screen node.
  • Type: FlowScreenField[]
  • Required: No
  • Description: An array of fields to display on the screen.

  • Type: string

  • Required: No

  • Description: Text that appears if the end user clicks a link for help text.

    Supports merge fields in API version 26.0 and later.

  • Type: boolean
  • Required: No
  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Description: A label for the Next or Finish button.
  • Type: string
  • Required: No
  • Description: A label for the Pause button.
  • Type: string
  • Required: No
  • Introduced: API version 33.0
  • Description: A confirmation message that appears when an end user clicks Pause.

  • Type: boolean

  • Required: No

  • Introduced: API version 42.0

  • Description: Indicates whether to show (true) or hide (false) the screen’s footer at Lightning runtime. Classic runtime isn’t supported. The default value is true.

    The footer includes navigation actions for the screen. If showFooter is hidden, use Lightning components on the screen to show navigation actions.

  • Type: boolean

  • Required: No

  • Introduced: API version 42.0

  • Description: Indicates whether to show (true) or hide (false) the screen’s header at Lightning runtime. Classic runtime isn’t supported. The default value is true.

    The header includes access to help text for the screen. If showHeader is hidden, use Lightning components on the screen to show help text.

  • Type: FlowScreenStyleSetting[]
  • Required: No
  • Introduced: API version 66.0
  • Description: An array of flow screen style settings to customize the visual experience of a screen at run time.
  • Type: FlowScreenTrigger[]
  • Required: No
  • Introduced: API version 59.0
  • Description: An array of triggers configured for a flow screen field or a flow screen field attribute.

Defines an action that can be triggered by one or more flow screen components.

This metadata type is available in API version 59.0 and later.

This type extends FlowElement and inherits its fields.

  • Type: string
  • Required: No
  • Description: Required. The API name of the flow screen action.
  • Type: string
  • Required: Yes
  • Description: Requiired. The label of the flow screen action.
  • Type: string
  • Required: No
  • Description: The API name of the flow screen action.
  • Type: string
  • Required: No
  • Introduced: API version 63.0
  • Description: Specifies the version of the screen action to be invoked.

Defines an iput parameter for a flow screen action.

This metadata type is available in API version 59.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes

Represents a screen component. See Salesforce Help: Standard Flow Screen Components.

This type extends FlowElement and inherits its fields.

  • Type: string[]

  • Required: No

  • Description: An array of references to FlowChoices or FlowDynamicChoiceSets. The resulting choice options appear in the order specified in this array, where the element at index 0 provides the top-most choice option. Supported for these types of screen components.

    • RadioButtons
    • DropdownBox
    • MultiSelectCheckboxes
    • MultiSelectPicklist

    Multi-select checkboxes and multi-select picklist fields are available in API version 26.0 and later.

  • Type: FlowDataType (enumeration of type string)

  • Required: No

  • Description: Data type of the screen component. Only supported for the InputField, RadioButtons, and DropdownBox types of screen components. Valid data types are:

    Boolean input fields, which appear as checkbox fields at runtime, are available in API version 26.0 and later.

    Only the string data type is supported for multi-select checkboxes and multi-select picklist fields. Multi-select fields are available in API version 26.0 and later.

    Date/time input fields are available in API version 43.0 and later.

  • Possible values:

    • Boolean
    • Currency
    • Date
    • DateTime
    • Number
    • String
    • Time

  • Type: string

  • Required: No

  • Description: The name of the FlowChoice element to use as the default value for the screen component. Supported for these types of screen components.

    • RadioButtons
    • DropdownBox
    • MultiSelectCheckboxes
    • MultiSelectPicklist

    For DropdownBox field types only, if defaultSelectedChoiceReference is empty or null, the reference at index 0 of choiceReferences is used as the default value.

    You can specify only one FlowChoice element as the default value for multi-select checkboxes and multi-select picklist fields. Multi-select fields are available in API version 26.0 and later.

  • Type: FlowElementReferenceOrValue
  • Required: No
  • Description: The value that is used by default when the screen component requires users to provide input. Only supported for InputField, LargeTextArea, and PasswordField.
  • Type: string
  • Required: No
  • Introduced: API version 42.0
  • Description: The name of the Lightning component to display.
  • Type: FlowScreenField[]
  • Required: No
  • Introduced: API version 49.0
  • Description: An array of columns to display in a section, or an array of fields to display in a column.
  • Type: string
  • Required: No
  • Description: Field label that is displayed on the screen. Supports merge fields.

  • Type: FlowScreenFieldType (enumeration of type string)

  • Required: Yes

  • Description: Required. The type of field to display on a flow screen.

    At runtime, each multi-select field stores its field value as a concatenation of the user-selected choice values, separated by semicolons. Any semicolons in the selected choice values are removed when added to the multi-select field value.

  • Possible values:

    • DisplayText
    • InputField
    • LargeTextArea
    • PasswordField
    • RadioButtons
    • DropdownBox
    • MultiSelectCheckboxes — This value is available in API version 26.0 and later.
    • MultiSelectPicklist — This value is available in API version 26.0 and later.
    • ComponentInstance — This value is available in API version 42.0 and later.
    • ComponentChoice — and ComponentInput—This value is available in API version 48.0 and later for the Survey processType value only.
    • Region — Specifies that a screen field in a section is a column. This value is available in API version 51.0 and later.
    • RegionContainer — Specifies that a screen field is a section. This value is available in API version 51.0 and later.
    • ObjectProvided — Specifies that a screen field is a field from a Salesforce object. This value is available in API version 51.0 and later.

  • Type: string

  • Required: No

  • Description: Text that appears if the end user clicks the help icon (info) for the screen component.

    Supports merge fields in API version 26.0 and later.

  • Type: FlowScreenFieldInputParameter[]
  • Required: No
  • Introduced: API version 42.0
  • Description: An array of input parameters. Supported only when fieldType is ComponentInstance.

  • Type: FlowScreenFieldInputsRevisited (enumeration of type string)

  • Required: No

  • Description: Controls whether the flow remembers the input value if the user moves to any screen and then returns to the screen component.

    The default value is UseStoredValues.

    This property applies to screen components in API version 51.0 and later and to record fields on flow screens in API version 57.0 and later.

  • Possible values:

    • UseStoredValues — Uses values from when the user last visited this screen.
    • ResetValues — Refreshes inputs to incorporate changes elsewhere in the flow.
  • Type: boolean
  • Required: No
  • Description: Indicates whether the user must select a choice or provide input. Not supported for DisplayText or boolean inputField.
  • Type: boolean
  • Required: No
  • Type: string
  • Required: No
  • Description: Specifies the Salesforce object field for an ObjectProvided field.
  • Type: FlowScreenFieldOutputParameter[]
  • Required: No
  • Introduced: API version 42.0
  • Description: An array of output parameters. Supported only when fieldType is ComponentInstance and when storeOutputAutomatically is false.

  • Type: FlowRegionContainerType (enumeration of type string)

  • Required: No

  • Introduced: API version 55.0

  • Description: Stores information about a section component header. Possible values include:

    Available only when the component type is Section.

  • Possible values:

    • SectionWithHeader
    • SectionWithoutHeader

  • Type: int

  • Required: No

  • Description: Controls the number of digits to the right of the decimal point up to 17 places. If you leave this field blank or set it to zero, only whole numbers appear when your flow runs.

    Available only when the data type is Number or Currency. Corresponds to the Decimal Places field in Flow Builder.

  • Type: string
  • Required: No
  • Introduced: API version 62.0
  • Description: The API name of the template specified by the provider.
  • Type: string
  • Required: No
  • Introduced: API version 62.0
  • Description: The API name of the source that provides the template.

  • Type: boolean

  • Required: No

  • Introduced: API version 47.0

  • Description: Indicates whether the screen component’s output parameters are automatically available in the flow without creating any variables. When the value is true, you can reference an output parameter by specifying the name of the screen component and the output parameter, such as Mailing_Address.City.

    Supported only when fieldType is ComponentInstance.

  • Type: FlowInputValidationRule
  • Required: No
  • Description: A rule that’s used to validate the user input when the screen component is of type InputField, LargeTextArea, or PasswordField.
  • Type: FlowVisibilityRule
  • Required: No
  • Introduced: API version 47.0
  • Description: A condition-based rule that’s used to render or hide the screen component.

Defines an input parameter from the flow to the extension. FlowScreenFieldInputParameter is available in API version 42.0.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the input parameter.

Defines an output parameter from the extension to the flow. FlowScreenFieldOutputParameter is available in API version 42.0.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. Specifies the variable to which you want to assign the output parameter value.
  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the output parameter.

Defines how a screen component looks on a screen element at run time.

This metadata type is available in API version 64.0 and later.

  • Type: FlowScreenStyleSetting[]
  • Required: No
  • Introduced: API version 66.0
  • Description: An array of flow screen style settings to customize the visual experience of a screen component at run time.
  • Type: FlowElementReferenceOrValue
  • Required: Yes
  • Description: The vertical alignment of the screen component. Valid values are top, middle, bottom.
  • Type: FlowElementReferenceOrValue
  • Required: Yes
  • Description: The number of columns the width of the screen component fills up in a screen element’s 12-column wide spatial grid. Valid values are numbers 1 through 12.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Type: string
  • Required: Yes
  • Description: The label that identifies this component in the Salesforce UI and in metadata listings. Character limits and translation behavior follow the enclosing type.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Type: string
  • Required: Yes

A style setting for a flow screen or flow screen component.

This type extends FlowBaseElement and inherits its fields.

Introduced in API version 66.0.

  • Type: string
  • Required: Yes
  • Description: The name of the screen style property such as, --slds-c-input-color-border.
  • Type: FlowElementReferenceOrValue
  • Required: Yes
  • Description: Defines the value for the screen style property such as, <stringValue>#4AC7CA</stringValue>.
  • Type: string (enumeration of type string)
  • Required: No
  • Description: Specifies where the style setting is applied on a screen. Valid values: Not supported for screen components.
  • Possible values:
    • Container
    • Header
    • NextOrFinish
    • Previous
    • Pause

Defines an event handler for a flow screen component.

This metadata type is available in API version 59.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. The API name of the event from eventSource that the trigger listens for.
  • Type: string
  • Required: Yes
  • Description: Required. The screen field, screen field attribute, action, or action attribute where eventName takes place.
  • Type: FlowScreenTriggerHandler[]
  • Required: No
  • Description: An array of flow screen handlers to conditionally run when the configured event is recevied.

Defines conditions for a flow screen trigger handler.

This metadata type is available in API version 59.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string

  • Required: No

  • Introduced: API version 63.0

  • Description: Specifies logic for the conditions. Valid values are:

    • and—Evaluates to true only if all its conditions evaluate to true
    • or—Evaluates to true if any of its conditions evaluate to true
    • Advanced logic like 1 AND (2 OR 3)—Evaluates to true if the first condition is true and either the second or third condition if true.

    When you use advanced logic, the string must consist of 1,000 or fewer characters.

  • Type: FlowCondition[]
  • Required: No
  • Introduced: API version 63.0
  • Description: An array of conditions that must be true to trigger the handler.
  • Type: string (enumeration of type string)
  • Required: No
  • Introduced: API version 64.0
  • Description: Specifies when to run screen actions after a screen loads.
  • Possible values:
    • runOnLoad — Run screen actions the first time a screen is visited, regardless of the occurrence of any triggering events.
    • runOnRevisit — Run screen actions every time a screen is revisited by the user clicking Next, regardless of the occurrence of any triggering events.
  • Type: string
  • Required: Yes
  • Description: Required. The API name of the FlowScreenAction to run when conditions are met.

A section of your flow that can be represented in the UI, such as with breadcrumbs.

When an interview starts, any stages where isActive is true are added to the $Flow.ActiveStages global variable, which holds a collection of stages. Each stage’s stageOrder determines the order they’re added in. The stage with the lowest stageOrder is assigned to the $Flow.CurrentStage global variable.

This type extends FlowElement and inherits its fields.

  • Type: boolean
  • Required: Yes
  • Description: Indicates whether the stage is active by default.
  • Type: string
  • Required: Yes
  • Description: A user-friendly label for this stage.
  • Type: int
  • Required: Yes
  • Description: Indicates how the stage is ordered against other stages. The stageOrder value must be unique within the flow.

A step resource defines a step within a stage node. This metadata type is available in API version 53.0 and later.

This type extends FlowElement and inherits its fields.

  • Type: string
  • Required: No
  • Description: Required. Name of the flow associated with the step.
  • Type: InvocableActionType (enumeration of type string)
  • Required: No
  • Description: Required. The type of the step.
  • Possible values:
    • stepApproval — An Approval step available only for flow approval processes. This value is available in API version 62.0 and later.
    • stepBackground — A Background step available for both flow approval processes and orchestrations.
    • stepInteractive — An Interactive step available only for orchestrations.
    • stepMuleSoft — A MuleSoft step available only for orchestrations.
  • Type: FlowStageStepAssignee[]
  • Required: No
  • Description: An array of users, groups, or queues that are assigned to complete the interactive step.
  • Type: string
  • Required: No
  • Type: boolean
  • Required: No
  • Description: Reserved for future use.
  • Type: boolean
  • Required: No
  • Introduced: API version 65.0
  • Description: Specifies whether to run the step in rollback mode.
  • Type: string
  • Required: No
  • Description: The name of the evaluation flow used as an entry condition for the step.
  • Type: string (enumeration of type string)
  • Required: Yes
  • Description: Defines how the entry requirements for a step are evaluated.
  • Possible values:
    • And
    • Or
    • Custom logic, such as (1 AND (2 OR 3))
    • Formula
  • Type: FlowCondition[]
  • Required: No
  • Description: An array of requirements that must be met to start the step.
  • Type: FlowStageStepExitActionInputParameter[]
  • Required: No
  • Description: An array of input parameters from the step to the evaluation flow. These parameters specify an exit condition for the step.
  • Type: string
  • Required: No
  • Description: The name of the step exit evaluation flow.
  • Type: string (enumeration of type string)
  • Required: No
  • Description: Defines how the exit requirements for an interactive step are evaluated.
  • Possible values:
    • And
    • Or
    • Custom logic, such as (1 AND (2 OR 3))
    • Formula
  • Type: FlowCondition[]
  • Required: No
  • Description: An array of requirements to be met for exiting an interactive step.
  • Type: string
  • Required: Yes
  • Description: Required. The label for the step.
  • Type: FlowStageStepOutputConfigParam[]
  • Required: No
  • Introduced: API version 65.0
  • Description: An array of mock output values to use to debug the step in rollback mode.
  • Type: boolean
  • Required: No
  • Description: Not used in API version 63.0.
  • Type: string (enumeration of type string)
  • Required: No
  • Introduced: API version 67.0
  • Description: Indicates whether an approval step assigned to a group requires all group members to approve.
  • Possible values:
    • 0 — A single group member, queue member, or delegate approves or rejects the approval work item, which approves or rejects the approval step.
    • 100 — All group members or their delegates approve their child approval work items to approve the step. If any group member or delegate rejects their child approval work item, the approval step is rejected.
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Description: Reserved for future use.
  • Type: string
  • Required: No
  • Type: FlowElementSubtype (enumeration of type string)
  • Required: No
  • Description: Reserved for internal use.

An assignee associated with an Interactive step. Applicable only for interactive steps. This metadata type is available in API version 53.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: FlowStageStepAssigneeType (enumeration of type string)
  • Required: Yes
  • Description: Required. The type of the assignee associated with the interactive step.
  • Possible values:
    • Group
    • Queue
    • User
    • invalid— — This value is available in API version 61.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Type: string
  • Required: Yes

Defines an input parameter from the step to its associated evaluation flow. This metadata type is available in API version 53.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. The unique name for the input parameter of the evaluation flow used by a step as an entry condition.
  • Type: FlowElementReferenceOrValue
  • Required: No
  • Description: Defines the value of the input parameter of the evaluation flow used by a step as an entry condition.

Defines an output parameter from an evaluation flow used to determine if the step meets entry criteria. This metadata type is available in API version 53.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Reserved for future use.
  • Type: string (enumeration of type string)
  • Required: Yes
  • Description: Required. A unique name for the output parameter of the evaluation flow used by a step as an entry condition.
  • Possible values:
    • isOrchestrationConditionMet

Defines an input parameter from the stage or step to its associated evaluation flow. This metadata type is available in API version 53.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. A unique name for the input parameter of the evaluation flow used by a stage or step as an exit condition.
  • Type: FlowElementReferenceOrValue
  • Required: No
  • Description: Defines the value of the input parameter of the evaluation flow used by a stage or step as an exit condition.

Defines an output parameter from an evaluation flow used to determine if the stage or step meets exit criteria. This metadata type is available in API version 53.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Reserved for future use.
  • Type: string
  • Required: Yes
  • Description: Required. A unique name for the output parameter of the evaluation flow used by a stage or step as an exit condition. The only possible value is isOrchestrationConditionMet.

Defines an input parameter from the step to the flow. This metadata type is available in API version 53.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the input parameter for a flow associated with the step.
  • Type: FlowElementReferenceOrValue
  • Required: No
  • Description: Defines the value of the input parameter of the flow associated with a step.

Defines a mock output value for a step. This metadata type is available in API version 65.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the mock output value associated with the step.
  • Type: FlowElementReferenceOrValue
  • Required: Yes
  • Description: Required. Defines the value of the mock output value. For enhanced security and data privacy, don’t store personal identifiable information in this field.

Defines an output parameter from the step to the flow. This metadata type is available in API version 53.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Reserved for future use.
  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the output parameter for a flow associated with the step.

Represents the flow’s Start element, which specifies how the flow starts. In an autolaunched flow, the Start element also defines when and how frequently to run the flow. To run the flow only for specific records, the Start element can define filter criteria.

This metadata type is available in API version 47.0 and later.

This type extends FlowNode and inherits its fields.

  • Type: string
  • Required: No
  • Introduced: API version 63.0
  • Description: The ID of the activation that triggers the flow.
  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Description: The name of the activation template that determines the contact point for each channel configured in the activation template for a segment-triggered flow. This field is available in 66.0 and later.
  • Type: FlowCapability[]
  • Required: No
  • Introduced: API version 60.0
  • Description: An array of capabilities that can pass data with the flow. Only one capability is supported in API version 60.0 and later.
  • Type: string (enumeration of type string)
  • Required: No
  • Description: Defines how the filtering conditions are evaluated.
  • Possible values:
    • And
    • Or
  • Type: FlowCondition[]
  • Required: No
  • Description: An array of conditions that must be true for the event to trigger.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which element to execute first.
  • Type: int
  • Required: No
  • Type: string
  • Required: No
  • Introduced: API version 61.0
  • Description: The data graph associated with the flow. Reference fields from this data graph throughout the flow.
  • Type: FlowDataLookup[]
  • Required: No
  • Introduced: API version 68.0
  • Description: An array of data lookups that define how to retrieve related records at run time.
  • Type: FlowDataTypeMapping[]
  • Required: No
  • Introduced: API version 63.0
  • Description: An array of data type mappings for input and output values that have the generic sObject data type.
  • Type: boolean
  • Required: No
  • Introduced: API version 50.0
  • Description: If set to true, conditions evaluate to true only if the record didn’t meet the required conditions before the triggering update but now meets the conditions after the update.

  • Type: FlowEntryType (enumeration of type string)

  • Required: No

  • Introduced: API version 60.0

  • Description: Specifies when a unified individual can join a flow. Valid values are:

    • AfterCompletion—Unified individuals can join the flow only after they complete all previous flow runs of the same flow definition.
    • Always—Unified individuals can always join the flow.
    • Never—Unified individuals can never reenter the flow. This value is available in API version 63.0 and later.

  • Type: string

  • Required: No

  • Introduced: API version 61.0

  • Description: The name of the automation event that triggers the automation event-triggered flow. Valid values are:

    • trgrOnSmsSubscription
    • trgrOnEmailSubscription
    • trgrOnOrderPlacement
    • The API name of a form
    • The API name of an external service
  • Type: InvocableActionType (enumeration of type string)
  • Required: No
  • Description: The type of the automation event that triggers the automation event-triggered flow.
  • Possible values:
    • exploreConversation — Available in API version 61.0 and later.
    • externalEvent
    • processWebStoreUserRgstr
    • trgrOnB2cCartAbandoned
    • trgrOnCustomEvent — Available in API version 64.0 and later.
    • trgrOnEmailBounceEngagement
    • trgrOnEmailLinkClickEngagement
    • trgrOnEmailOpenEngagement
    • trgrOnEmailSubscription
    • trgrOnFormSubmission
    • trgrOnOrderPlacement
    • trgrOnPostOrdMktCmpnEngagement
    • trgrOnReferralEventSubmission — Available in API version 65.0 and later.
    • trgrOnSmsDeliveryFailureEngagement
    • trgrOnSmsLinkClickEngagement
    • trgrOnSmsResponseEngagement
    • trgrOnSmsSubscription
    • trgOnVoucherStsChgOtbdEngmt — Available in API version 65.0 and later.
    • trgrOnWebCartAbandoned
    • trgrOnWhatsAppDeliveredEngagement
    • trgrOnWhatsAppDlvrFailureEngmt
    • trgrOnWhatsAppLinkClickEngmt
    • trgrOnWhatsAppReadEngagement
    • trgrOnWhatsAppResponseEngmt
    • trgrOnWhatsAppSubscription
  • Type: FlowActionCall
  • Required: No
  • Description: The invocable action in the Start element of a broadcast flow. This field is available in 66.0 and later.
  • Type: string
  • Required: No
  • Introduced: API version 55.0
  • Description: A formula that’s used to filter what records execute the flow during a save. Available only in record-triggered flows.
  • Type: string
  • Required: No
  • Introduced: API version 50.0
  • Description: The filter logic that’s applied to the filter condition requirements. To require all conditions, use AND. To require any conditions, use OR. For custom condition logic, enter the entire logic string, for example 1 AND 2 OR (3 AND 4).
  • Type: FlowRecordFilter[]
  • Required: No
  • Description: An array of filters to apply when retrieving records from the database. For example, filter accounts to include only the records that haven’t been updated in the last 4 weeks.
  • Type: FlowRunAsUser (enumeration of type string)
  • Required: No
  • Introduced: API version 60.0
  • Description: Specifies who to run the flow as.
  • Possible values:
    • TriggeringUser — Run the flow as the user that triggered the flow.
    • DefaultWorkflowUser — Run the flow as the default workflow user.
  • Type: string
  • Required: No
  • Introduced: API version 59.0
  • Description: Required only for form-triggered flows. The content key value for the form used to trigger the flow.
  • Type: string
  • Required: No
  • Type: boolean
  • Required: No
  • Type: boolean
  • Required: No
  • Type: int
  • Required: No
  • Introduced: API version 67.0
  • Description: The maximum number of interviews to execute in a single batch for a schedule-triggered flow, from 1 to 200. Default is 200.
  • Type: string
  • Required: No
  • Description: The object whose records you want to retrieve from the database. A flow interview starts for each record that meets the filter conditions.
  • Type: string
  • Required: No
  • Type: string
  • Required: No

  • Type: string

  • Required: No

  • Description: A comma-separated list of channels used to choose the individual in the segment-triggered flow. The flow ranks these channels to select an individual. Valid values are: Email, Phone.

    If the flow finds contact points for both, it uses the higher-ranked channel. For example, if the list is Phone, Email and both exist, the flow selects the individual associated with the phone. This field is available in 66.0 and later.

  • Type: boolean

  • Required: No

  • Introduced: API version 60.0

  • Description: Indicates whether to republish the segment and update segment membership before the flow runs or on the segment’s Data Cloud publish schedule. When the value is true, the segment is immediately republished before the flow runs, and ignores the segment’s publish schedule. When the value is false, the segment is republished on the segment’s Data Cloud publish schedule, but the segment isn’t republished if the schedule is set to Do not refresh.

    The default value is false.

  • Type: RecordTriggerType (enumeration of type string)

  • Required: No

  • Introduced: API version 48.0

  • Description: Specifies what type of record changes can start the flow.

    Available only when triggerType is RecordBeforeSave or DataCloudDataChange.

  • Possible values:

    • Create — When a record is created.
    • Update — When a record is updated.
    • CreateAndUpdate — When a record is created and updated.
    • Delete — When a record is deleted. This value is available in API version 50.0 and later.
    • None — For flows that aren’t record-triggered flows. This value is available in API version 55.0 and later.
  • Type: FlowReentryMode (enumeration of type string)
  • Required: No
  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Type: FlowSchedule
  • Required: No
  • Description: Required when triggerType is Scheduled. Specifies when and how frequently the flow runs.
  • Type: FlowScheduledPath[]
  • Required: No
  • Introduced: API version 51.0
  • Description: Specifies the flow’s scheduled paths.
  • Type: string
  • Required: No
  • Introduced: API version 56.0
  • Description: The segment used to trigger the flow.
  • Type: boolean
  • Required: No
  • Description: Indicates whether a segment-triggered flow sends a message to only one contact per individual (true) or multiple contacts (false). The default value is (false). If activationTemplate is set, this field must be true. This field is available in 66.0 and later.
  • Type: string
  • Required: No
  • Description: Reserved for future use.
  • Type: string
  • Required: No
  • Introduced: API version 63.0
  • Description: The API name of the data graph that includes the data model object that triggers the automation event-triggered flow.
  • Type: string
  • Required: No
  • Introduced: API version 63.0
  • Description: The Data Cloud path to the data model object that triggers the automation event-triggered flow.

  • Type: FlowTriggerType (enumeration of type string)

  • Required: No

  • Introduced: API version 47.0

  • Description: Specifies what causes the flow to run. If you exclude this field, the flow has no trigger and starts only when a user or app launches the flow.

    Available only when processType is AutoLaunchedFlow or PromptFlow.

  • Possible values:

    • Activation — The flow starts when an activation is published. This value is available in API version 63.0 and later.
    • AutomationEvent — The flow starts when an automation event such as an SMS subscription occurs. This value is available in API version 62.0 and later.
    • Capability — When capabilityTypes is set, the flow starts when the capability is run. This value is available in API version 60.0 and later.
    • DataCloudDataChange — The flow starts when data model object (DMO) or calculated insight object (CIO) conditions are met. This value is available in API version 59.0 and later.
    • DataGraphDataChange — The flow starts when conditions are met in the specified data graph field. This value is available in API version 63.0 and later.
    • EventDrivenJourney — Reserved for internal use.
    • ExternalSystemChange — The flow starts when a relevant change is detected in an external system. This value is available in API version 63.0 and later.
    • IndivRelatedRecord — The flow starts when an object or an object with fields related to an individual is created or updated. This value is available in API version 66.0 and later.
    • PlatformEvent — The flow starts when a platform event message is received. This value is available in API version 49.0 and later.
    • RecordAfterSave — The flow starts after a record is saved. This value is available in API version 49.0 and later.
    • RecordBeforeDelete — Deleting a record triggers an autolaunched flow before the record is deleted from the database. This value is available in API version 50.0 and later.
    • RecordBeforeSave — Creating and/or updating a record triggers an autolaunched flow to make more updates to that record before it’s saved to the database. This value is available in API version 48.0 and later.
    • Scheduled — The flow starts at the scheduled time. This value is available in API version 47.0 and later.
    • ScheduledJourney — The flow starts only at the scheduled time and frequency. This value is available in API version 49.0 and later.
    • Segment — At the scheduled time, the flow send emails to individuals included in the chosen segment. This value is available in API version 56.0 and later.
  • Type: string
  • Required: No
  • Introduced: API version 65.0
  • Description: Specifies the version of the automation event.

Defines an input parameter to the flow Start element. This metadata type is available in API version 62.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. The unique name for the input parameter to the Start element.

Steps function as placeholders when you’re building a flow.

This type extends FlowNode and inherits its fields.

  • Type: FlowConnector[]
  • Required: No
  • Description: Specifies which node to execute after the step node.

A subflow element references another flow, which it calls at run time. The flow that contains the subflow element is referred to as the parent flow. It’s available in API version 25.0 and later.

This type extends FlowNode and inherits its fields.

  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after the subflow.
  • Type: string
  • Required: No
  • Description: References the flow to call at runtime. The value must be an API name of a flow and it can’t contain an appended hyphen and version number.
  • Type: FlowSubflowInputAssignment[]
  • Required: No
  • Description: An array of input variable assignments that are set at the start of the flow.
  • Type: boolean
  • Required: No
  • Introduced: API version 49.0
  • Description: Indicates whether the subflow’s output parameters are automatically available in the flow without creating any variables. When the value is true, you can reference an output parameter by specifying the API name of the subflow in the flow. When the value is false, create variables manually to store output values from the subflow. The default value is false.

Assigns an element or value from the parent flow to a variable in the referenced flow. Input assignments occur when the subflow calls the referenced flow. It’s available in API version 25.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the variable in the referenced flow.

Assigns the value of a variable from the referenced flow to a variable in the parent flow. Output assignments occur when the referenced flow is finished running. It’s available in API version 25.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Description: Unique name for the variable in the parent flow.
  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the variable in the referenced flow.

Defines a text template that can be used throughout the flow.

This type extends FlowElement and inherits its fields.

  • Type: boolean

  • Required: No

  • Description: If set to true, the flow resource remembers the View as Plain Text setting used for the text template after the flow resource is saved. If set to false, the flow resource uses the View as Rich Text setting.

    The default value is false.

  • Type: string
  • Required: Yes
  • Description: Actual text of the template. Supports merge fields.

Defines a node that can dynamically transform the value of source data to target data in the flow. This metadata type is available in API version 59.0 and later.

This type extends FlowNode and inherits its fields.

  • Type: string
  • Required: No
  • Description: The Apex class of the target data after transformation if its data type is Apex.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute after this data transformation.
  • Type: FlowDataType (enumeration of type string)
  • Required: No
  • Description: Required. Specifies the data type of the transformed data. In Flow Builder, it corresponds to the target data in the Transform element. Valid types are:
  • Possible values:
    • Apex
    • Boolean — This value is available in API version 62.0.
    • Currency — This value is available in API version 62.0.
    • Date — This value is available in API version 62.0.
    • DateTime — This value is available in API version 62.0.
    • Number — This value is available in API version 62.0.
    • String — This value is available in API version 62.0.
    • sObject — This value corresponds to a record variable.
    • Time
  • Type: boolean
  • Required: No
  • Description: Indicates whether the variable is a collection of values. The default value is false.
  • Type: string
  • Required: No
  • Description: Object type of this variable resource if its data type is sObject.

  • Type: int

  • Required: No

  • Description: Controls the number of digits to the right of the decimal point up to 17 places. If you leave this field blank or set it to zero, only whole numbers appear when your flow runs.

    Corresponds to the Decimal Places field in Flow Builder.

  • Type: string
  • Required: No
  • Type: boolean
  • Required: No
  • Description: Reserved for future use.

Defines the values for transforming specific data in the flow. This metadata type is available in API version 59.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Description: Reserved for future use.
  • Type: string
  • Required: No
  • Description: Reserved for future use.
  • Type: string
  • Required: No
  • Description: Reserved for future use.

Defines the data and actions to transform in the flow. This metadata type is available in API version 59.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string
  • Required: No
  • Description: Reserved for future use.
  • Type: string
  • Required: No
  • Description: Reserved for future use.
  • Type: string
  • Required: No
  • Description: Reserved for future use.
  • Type: string
  • Required: No
  • Type: string
  • Required: No
  • Description: The API name of the field for transformed data in a data transformation mapping. In Flow Builder, it corresponds to the target data field in the Transform element.
  • Type: FlowTransformValueActionType (enumeration of type string)
  • Required: Yes
  • Description: Required. The type of transformation from source data to target data. Valid types are:
  • Possible values:
    • Count — Calculates the number of items in a source collection.
    • GetItemByIndex — Reserved for future use.
    • InnerJoin — Joins selected data from two source collections that are stored in a target collection in a flow. This value is available in API version 63.0 and later. See complexValueType on FlowElementReferenceOrValue. InnerJoin isn’t a valid value for FlowInlineTransform.
    • InvocableAction — Reserved for future use.
    • Map — Specifies a mapping between the datasets in flows. In Flow Builder, it corresponds to the mapping between source data fields and target data fields.
    • Sum — Adds the numeric values of a field on each item in a collection.
  • Type: FlowElementReferenceOrValue
  • Required: No
  • Description: Defines the value of the transformed data. In Flow Builder, the value of this field corresponds to the result of the target data field in the Transform element.

Defines the input parameters of the source data for data transformation. This metadata type is available in API version 60.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string (enumeration of type string)
  • Required: Yes
  • Description: A key that specifies the configuration of input parameters for this data transformation when transformType is set to Sum or Count.
  • Possible values:
    • aggregationField — The field on each item in a source collection that’s used to calculate the transformed value.
    • aggregationValues — The source collection that’s used to calculate the transformed value.

Defines the specific data transformation type that converts the value of a source action output parameter in valueMappingKey before assigning the result to the target output parameter in valueMappingTarget.

With variables, creates updatable values to use in the flow.

This type extends FlowElement and inherits its fields.

  • Type: string
  • Required: No
  • Introduced: API version 46.0
  • Description: The Apex class of this variable if its data type is Apex.
  • Type: FlowDataType (enumeration of type string)
  • Required: Yes
  • Description: Required. Valid types are:
  • Possible values:
    • Apex — This value is available in API version 46.0 and later.
    • Boolean
    • Currency
    • Date
    • DateTime — This value is available in API version 30.0 and later.
    • Number
    • Multipicklist — This value is available in API version 34.0 and later.
    • Picklist — This value is available in API version 34.0 and later.
    • String
    • sObject — This value corresponds to a record variable.
    • Time

  • Type: boolean

  • Required: No

  • Introduced: API version 30.0

  • Description: Indicates whether the variable is a collection of values. In API version 32.0 and later, a collection variable can be of any data type.

    The default value is False.

  • Type: boolean (enumeration of type string)

  • Required: No

  • Introduced: API version 25.0

  • Description: Indicates whether the variable can be set at the start of the flow using URL parameters, Visualforce controllers, or subflow inputs. Default value:

    Disabling input or output access for an existing variable can break the functionality of applications and pages that call the flow and access the variable. For example, you can access variables from URL parameters, processes, and other flows.

  • Possible values:

    • False — for a variable created in API version 25.0 and later or in the Flow Builder in Summer ’12 and later.
    • True — for a variable created in API version 24.0 or in Flow Builder in Spring ’12 and earlier.

  • Type: boolean (enumeration of type string)

  • Required: No

  • Introduced: API version 25.0

  • Description: Indicates whether the variable’s value can be accessed from Visualforce controllers and other flows. Default value:

    Disabling input or output access for an existing variable can break the functionality of applications and pages that call the flow and access the variable. For example, you can access variables from URL parameters, processes, and other flows.

  • Possible values:

    • False — for a variable created in API version 25.0 and later or in the Flow Builder in Summer ’12 and later.
    • True — for a variable created in API version 24.0 or in Flow Builder in Spring ’12 and earlier.
  • Type: string
  • Required: No
  • Description: Object type of this variable if its data type is sObject.

  • Type: int

  • Required: No

  • Description: Controls the number of digits to the right of the decimal point up to 17 places. If you leave this field blank or set it to zero, only whole numbers appear when your flow runs.

    Corresponds to the Decimal Places field in Flow Builder.

  • Type: FlowElementReferenceOrValue

  • Required: No

  • Description: Default value of this variable.

    Default values aren’t supported if the variable’s data type is Picklist or Multipicklist.

Visibility rules render a flow screen component when visibility rule conditions are met. Hides a flow screen component when visibility rule conditions aren’t met. This metadata type is available in API version 47.0 and later.

This type extends FlowBaseElement and inherits its fields.

  • Type: string

  • Required: No

  • Description: Specifies logic for the conditions. Value can be:

    • and—Evaluates to true only if all its conditions evaluate to true.
    • or—Evaluates to true if any of its conditions evaluate to true.
    • Advanced logic like 1 AND (2 OR 3)—Evaluates to true if the first condition is true and either the second or third condition is true.

    When you use advanced logic, the string must consist of 1,000 or fewer characters.

  • Type: FlowCondition[]
  • Required: No
  • Description: An array of conditions that must be true for the flow to wait for this event.

Waits for one or more defined events to occur.

This type extends FlowNode and inherits its fields.

Introduced in API version 32.0.

  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute if the conditions are false for every event in the Wait element.
  • Type: string
  • Required: Yes
  • Description: Label for the default connector.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute if the attempt to wait results in an error. If any of the wait events fail, the flow takes the fault connector.
  • Type: string
  • Required: No
  • Description: Reserved for future use.

  • Type: FlowWaitEvent[]

  • Required: No

  • Description: An array of events that the Wait element is waiting for.

    If the conditions for every event evaluate to false, the defaultConnector is used.

An event that a FlowWait element is waiting for.

This type extends FlowElement and inherits its fields.

Introduced in API version 32.0.

  • Type: string
  • Required: No
  • Introduced: API version 60.0
  • Description: The API name of the event that resumes the flow.
  • Type: string
  • Required: No
  • Description: Name of the automation event that the Wait element is waiting for.
  • Type: InvocableActionType (enumeration of type string)
  • Required: No
  • Description: The type of the automation event that triggers the Wait element is waiting for.
  • Possible values:
    • exploreConversation — This value is available in API version 61.0 and later.
    • trgrOnCustomEvent — This value is available in API version 64.0 and later.
    • trgrOnSmsSubscription
    • trgrOnEmailSubscription
    • trgrOnOrderPlacement
    • trgrOnFormSubmission

  • Type: string

  • Required: No

  • Description: Specifies logic for the conditions. Value can be:

    • and—Evaluates to true only if all its conditions evaluate to true
    • or—Evaluates to true if any of its conditions evaluate to true
    • Advanced logic like 1 AND (2 OR 3)—Evaluates to true if the first condition is true and either the second or third condition is true When you use advanced logic, the string must consist of 1,000 or fewer characters.
  • Type: FlowCondition[]
  • Required: No
  • Description: An array of conditions that must be true for the flow to wait for this event.
  • Type: FlowConnector
  • Required: No
  • Description: Specifies which node to execute if this event is the first event that occurs.
  • Type: string (enumeration of type string)
  • Required: No
  • Description: Required. The event’s type. The type determines which input parameters are available to define this event.
  • Possible values:
    • AlarmEvent — This event is an alarm based off an absolute date/time value.
    • DateRefAlarmEvent — This event is an alarm based off a date/time field on a record.
  • Type: Time
  • Required: No
  • Description: Reserved for future use.
  • Type: string
  • Required: No
  • Introduced: API version 60.0
  • Description: The filter logic that’s applied to the filter condition requirements. To require all conditions, use AND. To require any conditions, use OR. For custom condition logic, enter the entire logic string, for example 1 AND 2 OR (3 AND 4).
  • Type: FlowRecordFilter[]
  • Required: No
  • Introduced: API version 60.0
  • Description: An array of filters to apply when retrieving records from the database. For example, filter accounts to include only the records that haven’t been updated in the last 4 weeks.
  • Type: FlowWaitEventInputParameter[]
  • Required: No
  • Description: An array of the event’s input parameters. The parameter values are set by using values from the flow.
  • Type: FlowWaitInteractionType (enumeration of type string)
  • Required: No
  • Introduced: API version 62.0
  • Description: Specifies what type of event can resume the flow.
  • Possible values:
    • RcsResponse — An RCS response event. This value is available in API version 67.0 and later.
    • SmsResponse — An SMS response event
    • WhatsappResponse — A WhatsApp response event
  • Type: string
  • Required: Yes
  • Description: Required. Label for the wait event.
  • Type: int
  • Required: No
  • Type: string
  • Required: No
  • Introduced: API version 60.0
  • Description: The object that contains the event you want to use to resume the flow.
  • Type: int
  • Required: No
  • Description: Reserved for future use.
  • Type: FlowScheduledPathOffsetUnit (enumeration of type string)
  • Required: No
  • Description: Reserved for future use.
  • Type: FlowWaitEventOutputParameter[]
  • Required: No
  • Description: An array of the event’s output parameters. The parameter values are assigned from the event to variables in the flow.
  • Type: RecordTriggerType (enumeration of type string)
  • Required: No
  • Introduced: API version 60.0
  • Description: Specifies what type of record changes can resume the flow.
  • Possible values:
    • Create — When a related record is created
    • Update — When a related record is updated
    • CreateAndUpdate — When a related record is created and updated
  • Type: date
  • Required: No
  • Type: string
  • Required: No
  • Type: xsd:time
  • Required: No

An input parameter for FlowWaitEvent. The parameter’s value is set by using values from the flow.

This type extends FlowBaseElement and inherits its fields.

Introduced in API version 32.0.

  • Type: string
  • Required: No
  • Description: Unique name for the input parameter.

An output parameter for FlowWaitEvent. The parameter’s value is assigned to a variable in the flow so that it can be referenced in another part of the flow.

This type extends FlowBaseElement and inherits its fields.

Introduced in API version 32.0.

  • Type: string
  • Required: Yes
  • Description: Required. Specifies the variable to which you want to assign the output parameter value.
  • Type: string
  • Required: Yes
  • Description: Required. Unique name for the output parameter.

The valid values in the required actionType on FlowActionCall.

Here’s a sample XML definition of a flow.

Sample XML definition with a subflow element.

Sample XML definition of an autolaunched flow with a loop.

In API version 43.0 and earlier, the Flow object’s fullName field included the flow’s version number. Starting in API version 44, the field no longer includes the version number. Before you deploy using API version 44.0 via Metadata API or Salesforce CLI, make sure that:

  • The flows directory doesn’t include any unused flow versions.
  • For each active flow, the status field is Active. Any flow without a status value is deployed or retrieved with a status value of Draft.
  • The flowDefinitions directory is empty.

For Metadata API only.

  • The package.xml file is set to API version 44.0.
  • For the latest version of each flow, the file name doesn’t include a version number. For example, change myflow-3.flow to myflow.flow.

For Salesforce CLI only.

  • The sfdx-project.json file is set to "sourceApiVersion": "44.0".
  • For the latest version of each flow, the file name doesn’t include a version number. For example, change myflow-1.flow-meta.xml to myflow.flow-meta.xml.

As part of this upgrade, flow definitions are no longer necessary when you deploy or retrieve via Metadata API. If you deploy with flow definitions, the active version numbers in the flow definitions override the status fields in the flows. For example, the active version number in the flow definition is version 3, and the latest version of the flow is version 4 with the status field as Active. After you deploy your flow, the active version is version 3.

After you finished this upgrade, you can integrate with a version control system without worrying about flow file names changing. To reduce deployment issues when you push the source code into a scratch org, make sure that you don’t reuse an existing scratch org.

For more information, see Deploy Processes and Flows as Active in Salesforce Help.

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.