Flow

Use the Flow object to retrieve and update specific flow versions.

With Flow, you can create an application that navigates users through a series of screens to query and update records in the database. You can also execute logic and provide branching capability based on user input to build dynamic applications. For information about the corresponding UI-based flow building tool, see Flow Builder in the Salesforce Help.

When using the Tooling API to work with flows, consider that:

You can describe information for a flow installed from a managed package but not its metadata.
Every time you update a flow version, you’re actually deleting the existing flow version and creating a new flow version from it, with a new ID.
To activate a flow, change the Status field to active.

Legacy flows created with the Desktop Flow Designer can’t be modified with the API. Update your flow by recreating it with Flow Builder.

Note

You can delete a flow version as long as it isn’t active and has no paused interviews. If the flow version has paused interviews, wait for those interviews to resume and finish, or delete them.

This object is available in API version 34.0 and later.

Supported SOAP Calls

create(), delete(), query(), retrieve(), update(), upsert()

Supported REST API HTTP Methods

DELETE, GET, HEAD, PATCH, POST

Fields

Field	Details
Definition	Type FlowDefinition Properties Filter, Group, Nillable, Sort Description This flow’s definition object.
DefinitionId	Type ID Properties Filter, Group, Sort Description The ID of this flow’s FlowDefinition.
Description	Type string Properties Filter, Group, Nillable, Sort Description A description of the flow, such as what it’s meant to do or how it works.
Environments	Type multipicklist Properties Filter, Nillable Description Indicates where a flow can run. Valid values are: `Default`—The flow can run offline or from a Visualforce component, Lightning page, flow action, or custom Aura component. `Slack`—The flow can run in Slack and the default environment. You specify the Slack flow environment when you save the flow. Available in API version 55.0 and later.
FullName	Type string Properties Create, Group, Nillable Description The full name of the flow in the 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. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. 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.
IsTemplate	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether the process or flow is a template. When installed from managed packages, processes and flows can’t be viewed or cloned by subscribers 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. Available in API version 45.0 and later. Default: false
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged`
MasterLabel	Type string Properties Filter, Group, idLookup, Sort Description Label for the flow. In the UI, this field is Flow Label.
Metadata	Type `mns:` Flow Properties Create, Nillable, Update Description The flow’s metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. If the flow is part of a managed package this field will be Null. Metadata isn’t returned for flows in managed packages, unless the flows are templates.
ProcessType	Type Restricted picklist Properties Filter, Group, Nillable, Sort Description The type of the flow. Valid values are: `Appointments`—A flow for Lightning Scheduler. This value is available in API version 44.0 and later. `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 that customer support get back to them. 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. `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. 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. `InvocableProcess`—A process that can be invoked by another process or the Invocable Actions resource in REST API. This value is available in API version 38.0 and later. `LoginFlow`—A flow for login. Available in API version 51.0 and later. `LoyaltyManagementFlow`—A flow for the Loyalty Management app and can be invoked 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. Available in API version 53.0 and later. `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. These values are reserved for future use. `ActionCadenceFlow` `ActionPlan` `AppProcess` `CartAsyncFlow` `DigitalForm` `Journey` `JourneyBuilderIntegration` `LoginFlow` `ManagedContentFlow` `OrchestrationFlow` `RecommendationStrategy` `SalesEntryExperienceFlow` `TransactionSecurityFlow` `UserProvisioningFlow` This value has significant impact on validation when saving the flow and on the flow’s runtime behavior. Don’t change this value unless you understand the flow properties of the specified type. Note 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 elements, resources, and functionality that the new flow type supports.
RunInMode	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The mode that the flow runs in. Valid values are: `DefaultMode` — The flow version runs in system or user context, depending on how the flow is launched. `SystemModeWithSharing` — The flow version always runs in system mode with sharing. The flow respects org-wide default settings, role hierarchies, sharing rules, manual sharing, teams, and territories. But it doesn’t respect object permissions, field-level access, or other permissions of the running user. Available in API version 48.0 and later.
Status	Type Restricted picklist Properties Filter, Group Description The flow’s status. `Active` `Draft` `Obsolete` `InvalidDraft`
VersionNumber	Type int Properties Filter, Group, Sort Description The flow’s version number.