FlowDefinition | Tooling API | Salesforce Developers

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name.

Important

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

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 activate and deactivate flows with the Metadata field.
In API version 44.0, we recommend upgrading your flows to flow metadata file names without version numbers and discontinue using the FlowDefinition object to activate or deactivate a flow. Then use the Flow object to activate or deactivate a flow. For more information, see Upgrade Flow Files to API Version 44.0.
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.
Important
You can update masterlabel and description of a FlowDefinition.
FlowDefinition are implicitly created when the Flow object is created, which means FlowDefinition objects can only be updated.

This object is available in API version 34.0 and later.

Supported SOAP API Calls

query(), retrieve(), update()

Supported REST API HTTP Methods

GET, HEAD, PATCH, POST

Fields

Field Name	Details
ActiveVersion	Type Flow Properties Filter, Group, Nillable, Sort Description The active flow version object.
ActiveVersionId	Type ID Properties Filter, Group, Nillable, Sort Description The ID of the active flow version.
Description	Type string Properties Nillable Description Flow definition information, specified by the org’s admin.
DeveloperName	Type string Properties Filter, Group, Sort Description Developer name of this flow definition. In the UI, the label is Flow API Name.
FullName	Type string Properties Create, Group, Nillable Description The full name of the flow definition in the Metadata API. 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.
LatestVersion	Type Flow Properties Filter, Group, Nillable, Sort Description The latest flow version object, regardless of the status.
LatestVersionId	Type ID Properties Filter, Group, Nillable, Sort Description ID of the latest flow version, regardless of the flow’s status.
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` This field is available in API version 38.0 and later.
MasterLabel	Type string Properties Filter, Group, Nillable, Sort Description Label for the flow definition. In the UI, this field’s label is Flow Label.
Metadata	Type `mns:`FlowDefinition Properties Create, Nillable, Update Description The flow definition’s metadata object, containing information about which flow version is active and the flow definition’s description. 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.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace associated with this flow definition.