latestOpenAPI 3.1.02026-08-2284340459.3 KB
cd4c91e0e6c2
Data Flows
MCP
Add Data Flow
Authorization scope: data flow:write
This endpoint creates a data flow.
📖 Instructions for usage
create_data_flow
Create a new source-to-target data flow.
Parameters
----------
name : Display name for the data flow.
source_name : Connector type for the source, as shown by list_connections —
e.g. mysql, postgresql, snowflake, salesforce, hubspot, facebook ads, tiktok.
Not an exhaustive list: new connectors are added regularly, so pass the type
of your connection even if it is not listed here. (blueprint / blueprint_custom
flows are created in the console, not here.)
source_connection_id : cross_id of the source connection (from list_connections).
target_name : Connector type for the target (same convention as source_name).
target_connection_id : cross_id of the target connection.
loading_method : How data is loaded into the target. Common values:
append, merge, replace. Defaults to "append".
target_settings : Optional dict with target-specific fields, e.g.:
{"database_name": "MY_DB", "schema_name": "PUBLIC", "table_name": "my_table"}
Required fields vary by target connector type.
Note: blueprint / blueprint_custom (recipe) sources are NOT supported here — create
those flows in the Boomi Data Integration console.
To see a real example of this object, list your data flows and GET a similar one — use its definition as a reference.
📚 Per-source request/response examples: https://bitbucket.org/boomii/data-integration-sources-examples/src/main/
post/v1/accounts/{account_id}/environments/{environment_id}/rivers
Path parameters
account_idstring required
environment_idstring required
Query parameters
river_cross_idstring nullable
Request body
Response
Successful Response