Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

EmbeddedServiceFlowConfig

Represents whether an Embedded Service Flow feature is enabled or not. This object is available in API version 45.0 and later.

Supported SOAP API Calls

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

To access this type, you need the Customize Application user permission.

Fields

Field	Details
EmbeddedServiceConfigId	Type reference Properties Filter, Group, Sort Description The unique ID of an EmbeddedServiceConfig (the Embedded Service deployment) that the flow config is associated with.
Enabled	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Specifies whether the embedded flow is enabled (`true`) or not (`false`). Defaults to `false`.
FullName	Type string Properties Create, Group, Nillable Description The full name of the parent object EmbeddedServiceConfig in Metadata API. The full name can include a namespaceprefix. 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.
Metadata	Type EmbeddedServiceFlowConfig Properties Create, Nillable, Update Description The embedded service flow config'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.

Usage

To get a Flow feature working, you need three things: an EmbeddedServiceConfig deployment, an EmbeddedServiceFlowConfig record, and an EmbeddedServiceFlow record with the type set to FL_Flow. The EmbeddedServiceFlowConfig record controls whether the Flow feature associated with this deployment is enabled or disabled.