# KlaviyoAPI::FlowsApi All URIs are relative to *https://a.klaviyo.com* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [**get_flow**](FlowsApi.md#get_flow) | **GET** /api/flows/{id}/ | Get Flow | | [**get_flow_action**](FlowsApi.md#get_flow_action) | **GET** /api/flow-actions/{id}/ | Get Flow Action | | [**get_flow_action_flow**](FlowsApi.md#get_flow_action_flow) | **GET** /api/flow-actions/{id}/flow/ | Get Flow For Flow Action | | [**get_flow_action_messages**](FlowsApi.md#get_flow_action_messages) | **GET** /api/flow-actions/{id}/flow-messages/ | Get Flow Action Messages | | [**get_flow_action_relationships_flow**](FlowsApi.md#get_flow_action_relationships_flow) | **GET** /api/flow-actions/{id}/relationships/flow/ | Get Flow Action Relationships Flow | | [**get_flow_action_relationships_messages**](FlowsApi.md#get_flow_action_relationships_messages) | **GET** /api/flow-actions/{id}/relationships/flow-messages/ | Get Flow Action Relationships Messages | | [**get_flow_flow_actions**](FlowsApi.md#get_flow_flow_actions) | **GET** /api/flows/{id}/flow-actions/ | Get Flow Flow Actions | | [**get_flow_message**](FlowsApi.md#get_flow_message) | **GET** /api/flow-messages/{id}/ | Get Flow Message | | [**get_flow_message_action**](FlowsApi.md#get_flow_message_action) | **GET** /api/flow-messages/{id}/flow-action/ | Get Flow Action For Message | | [**get_flow_message_relationships_action**](FlowsApi.md#get_flow_message_relationships_action) | **GET** /api/flow-messages/{id}/relationships/flow-action/ | Get Flow Message Relationships Action | | [**get_flow_message_relationships_template**](FlowsApi.md#get_flow_message_relationships_template) | **GET** /api/flow-messages/{id}/relationships/template/ | Get Flow Message Relationships Template | | [**get_flow_message_template**](FlowsApi.md#get_flow_message_template) | **GET** /api/flow-messages/{id}/template/ | Get Flow Message Template | | [**get_flow_relationships_flow_actions**](FlowsApi.md#get_flow_relationships_flow_actions) | **GET** /api/flows/{id}/relationships/flow-actions/ | Get Flow Relationships Flow Actions | | [**get_flow_relationships_tags**](FlowsApi.md#get_flow_relationships_tags) | **GET** /api/flows/{id}/relationships/tags/ | Get Flow Relationships Tags | | [**get_flow_tags**](FlowsApi.md#get_flow_tags) | **GET** /api/flows/{id}/tags/ | Get Flow Tags | | [**get_flows**](FlowsApi.md#get_flows) | **GET** /api/flows/ | Get Flows | | [**update_flow**](FlowsApi.md#update_flow) | **PATCH** /api/flows/{id}/ | Update Flow Status | ## get_flow > Hash<String, Object> get_flow(id, opts) Get Flow Get a flow with the given flow ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | opts = { fields_flow_action: ['action_type'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets fields_flow: ['name'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets fields_tag: ['name'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets include: ['flow-actions'] # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships } begin # Get Flow result = api_instance.get_flow(id, opts) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow: #{e}" end ``` #### Using the get_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_with_http_info(id, opts) ```ruby begin # Get Flow data, status_code, headers = api_instance.get_flow_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | | **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **fields_flow** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_action > Hash<String, Object> get_flow_action(id, opts) Get Flow Action Get a flow action from a flow with the given flow action ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | opts = { fields_flow_action: ['action_type'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets fields_flow_message: ['name'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets fields_flow: ['name'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets include: ['flow'] # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships } begin # Get Flow Action result = api_instance.get_flow_action(id, opts) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_action: #{e}" end ``` #### Using the get_flow_action_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_action_with_http_info(id, opts) ```ruby begin # Get Flow Action data, status_code, headers = api_instance.get_flow_action_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_action_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | | **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **fields_flow_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **fields_flow** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_action_flow > Hash<String, Object> get_flow_action_flow(id, opts) Get Flow For Flow Action Get the flow associated with the given action ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | opts = { fields_flow: ['name'] # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets } begin # Get Flow For Flow Action result = api_instance.get_flow_action_flow(id, opts) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_action_flow: #{e}" end ``` #### Using the get_flow_action_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_action_flow_with_http_info(id, opts) ```ruby begin # Get Flow For Flow Action data, status_code, headers = api_instance.get_flow_action_flow_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_action_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | | **fields_flow** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_action_messages > Hash<String, Object> get_flow_action_messages(id, opts) Get Flow Action Messages Get all flow messages associated with the given action ID. Flow messages can be sorted by the following fields, in ascending and descending order: ascending: `id`, `name`, `created`, `updated` descending: `-id`, `-name`, `-created`, `-updated` Returns a maximum of 50 flows per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | opts = { fields_flow_message: ['name'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`
`name`: `contains`, `ends-with`, `equals`, `starts-with`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` page_size: 56, # Integer | Default: 50. Min: 1. Max: 100. sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting } begin # Get Flow Action Messages result = api_instance.get_flow_action_messages(id, opts) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_action_messages: #{e}" end ``` #### Using the get_flow_action_messages_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_action_messages_with_http_info(id, opts) ```ruby begin # Get Flow Action Messages data, status_code, headers = api_instance.get_flow_action_messages_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_action_messages_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | | **fields_flow_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` | [optional] | | **page_size** | **Integer** | Default: 50. Min: 1. Max: 100. | [optional][default to 50] | | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_action_relationships_flow > Hash<String, Object> get_flow_action_relationships_flow(id) Get Flow Action Relationships Flow Get the flow associated with the given action ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | begin # Get Flow Action Relationships Flow result = api_instance.get_flow_action_relationships_flow(id) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_action_relationships_flow: #{e}" end ``` #### Using the get_flow_action_relationships_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_action_relationships_flow_with_http_info(id) ```ruby begin # Get Flow Action Relationships Flow data, status_code, headers = api_instance.get_flow_action_relationships_flow_with_http_info(id) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_action_relationships_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_action_relationships_messages > Hash<String, Object> get_flow_action_relationships_messages(id, opts) Get Flow Action Relationships Messages Get all relationships for flow messages associated with the given flow action ID. Returns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | opts = { filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`name`: `contains`, `ends-with`, `equals`, `starts-with`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination page_size: 56, # Integer | Default: 50. Min: 1. Max: 50. sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting } begin # Get Flow Action Relationships Messages result = api_instance.get_flow_action_relationships_messages(id, opts) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_action_relationships_messages: #{e}" end ``` #### Using the get_flow_action_relationships_messages_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_action_relationships_messages_with_http_info(id, opts) ```ruby begin # Get Flow Action Relationships Messages data, status_code, headers = api_instance.get_flow_action_relationships_messages_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_action_relationships_messages_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` | [optional] | | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] | | **page_size** | **Integer** | Default: 50. Min: 1. Max: 50. | [optional][default to 50] | | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_flow_actions > Hash<String, Object> get_flow_flow_actions(id, opts) Get Flow Flow Actions Get all flow actions associated with the given flow ID. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | opts = { fields_flow_action: ['action_type'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`
`action_type`: `any`, `equals`
`status`: `equals`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination page_size: 56, # Integer | Default: 50. Min: 1. Max: 50. sort: 'action_type' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting } begin # Get Flow Flow Actions result = api_instance.get_flow_flow_actions(id, opts) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_flow_actions: #{e}" end ``` #### Using the get_flow_flow_actions_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_flow_actions_with_http_info(id, opts) ```ruby begin # Get Flow Flow Actions data, status_code, headers = api_instance.get_flow_flow_actions_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_flow_actions_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | | **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` | [optional] | | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] | | **page_size** | **Integer** | Default: 50. Min: 1. Max: 50. | [optional][default to 50] | | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_message > Hash<String, Object> get_flow_message(id, opts) Get Flow Message Get the flow message of a flow with the given message ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | opts = { fields_flow_action: ['action_type'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets fields_flow_message: ['name'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets fields_template: ['name'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets include: ['flow-action'] # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships } begin # Get Flow Message result = api_instance.get_flow_message(id, opts) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_message: #{e}" end ``` #### Using the get_flow_message_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_message_with_http_info(id, opts) ```ruby begin # Get Flow Message data, status_code, headers = api_instance.get_flow_message_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_message_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | | **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **fields_flow_message** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_message_action > Hash<String, Object> get_flow_message_action(id, opts) Get Flow Action For Message Get the flow action for a flow message with the given message ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | opts = { fields_flow_action: ['action_type'] # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets } begin # Get Flow Action For Message result = api_instance.get_flow_message_action(id, opts) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_message_action: #{e}" end ``` #### Using the get_flow_message_action_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_message_action_with_http_info(id, opts) ```ruby begin # Get Flow Action For Message data, status_code, headers = api_instance.get_flow_message_action_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_message_action_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | | **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_message_relationships_action > Hash<String, Object> get_flow_message_relationships_action(id) Get Flow Message Relationships Action Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | begin # Get Flow Message Relationships Action result = api_instance.get_flow_message_relationships_action(id) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_message_relationships_action: #{e}" end ``` #### Using the get_flow_message_relationships_action_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_message_relationships_action_with_http_info(id) ```ruby begin # Get Flow Message Relationships Action data, status_code, headers = api_instance.get_flow_message_relationships_action_with_http_info(id) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_message_relationships_action_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_message_relationships_template > Hash<String, Object> get_flow_message_relationships_template(id) Get Flow Message Relationships Template Returns the ID of the related template

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `templates:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | begin # Get Flow Message Relationships Template result = api_instance.get_flow_message_relationships_template(id) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_message_relationships_template: #{e}" end ``` #### Using the get_flow_message_relationships_template_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_message_relationships_template_with_http_info(id) ```ruby begin # Get Flow Message Relationships Template data, status_code, headers = api_instance.get_flow_message_relationships_template_with_http_info(id) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_message_relationships_template_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_message_template > Hash<String, Object> get_flow_message_template(id, opts) Get Flow Message Template Return the related template

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `templates:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | opts = { fields_template: ['name'] # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets } begin # Get Flow Message Template result = api_instance.get_flow_message_template(id, opts) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_message_template: #{e}" end ``` #### Using the get_flow_message_template_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_message_template_with_http_info(id, opts) ```ruby begin # Get Flow Message Template data, status_code, headers = api_instance.get_flow_message_template_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_message_template_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | | **fields_template** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_relationships_flow_actions > Hash<String, Object> get_flow_relationships_flow_actions(id, opts) Get Flow Relationships Flow Actions Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID. Flow action relationships can be sorted by the following fields, in ascending and descending order: `id`, `status`, `created`, `updated` Use filters to narrow your results. Returns a maximum of 50 flow action relationships per request, which can be paginated with offset pagination. Offset pagination uses the following parameters: `page[size]` and `page[number]`.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | opts = { filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`action_type`: `equals`
`status`: `equals`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` page_size: 56, # Integer | Default: 50. Min: 1. Max: 100. sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting } begin # Get Flow Relationships Flow Actions result = api_instance.get_flow_relationships_flow_actions(id, opts) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_relationships_flow_actions: #{e}" end ``` #### Using the get_flow_relationships_flow_actions_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_relationships_flow_actions_with_http_info(id, opts) ```ruby begin # Get Flow Relationships Flow Actions data, status_code, headers = api_instance.get_flow_relationships_flow_actions_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_relationships_flow_actions_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`action_type`: `equals`<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` | [optional] | | **page_size** | **Integer** | Default: 50. Min: 1. Max: 100. | [optional][default to 50] | | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_relationships_tags > Hash<String, Object> get_flow_relationships_tags(id) Get Flow Relationships Tags Return the tag IDs of all tags associated with the given flow.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` `tags:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | begin # Get Flow Relationships Tags result = api_instance.get_flow_relationships_tags(id) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_relationships_tags: #{e}" end ``` #### Using the get_flow_relationships_tags_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_relationships_tags_with_http_info(id) ```ruby begin # Get Flow Relationships Tags data, status_code, headers = api_instance.get_flow_relationships_tags_with_http_info(id) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_relationships_tags_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_tags > Hash<String, Object> get_flow_tags(id, opts) Get Flow Tags Return all tags associated with the given flow ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` `tags:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | opts = { fields_tag: ['name'] # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets } begin # Get Flow Tags result = api_instance.get_flow_tags(id, opts) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_tags: #{e}" end ``` #### Using the get_flow_tags_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flow_tags_with_http_info(id, opts) ```ruby begin # Get Flow Tags data, status_code, headers = api_instance.get_flow_tags_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flow_tags_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | | | | **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flows > Hash<String, Object> get_flows(opts) Get Flows Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:read` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new opts = { fields_flow_action: ['action_type'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets fields_flow: ['name'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets fields_tag: ['name'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets filter: 'filter_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`
`name`: `contains`, `ends-with`, `equals`, `starts-with`
`status`: `equals`
`archived`: `equals`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`trigger_type`: `equals` include: ['flow-actions'], # Array | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships page_cursor: 'page_cursor_example', # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination page_size: 56, # Integer | Default: 50. Min: 1. Max: 50. sort: 'created' # String | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting } begin # Get Flows result = api_instance.get_flows(opts) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flows: #{e}" end ``` #### Using the get_flows_with_http_info variant This returns an Array which contains the response data, status code and headers. > get_flows_with_http_info(opts) ```ruby begin # Get Flows data, status_code, headers = api_instance.get_flows_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->get_flows_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **fields_flow_action** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **fields_flow** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **fields_tag** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sparse-fieldsets | [optional] | | **filter** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`status`: `equals`<br>`archived`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`trigger_type`: `equals` | [optional] | | **include** | [**Array<String>**](String.md) | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#relationships | [optional] | | **page_cursor** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#pagination | [optional] | | **page_size** | **Integer** | Default: 50. Min: 1. Max: 50. | [optional][default to 50] | | **sort** | **String** | For more information please visit https://developers.klaviyo.com/en/v2023-12-15/reference/api-overview#sorting | [optional] | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## update_flow > Hash<String, Object> update_flow(id, flow_update_query) Update Flow Status Update the status of a flow with the given flow ID, and all actions in that flow.

*Rate limits*:
Burst: `3/s`
Steady: `60/m` **Scopes:** `flows:write` ### Examples ```ruby require 'time' require 'klaviyo-api-sdk' # setup authorization KlaviyoAPI.configure do |config| # Configure API key authorization: Klaviyo-API-Key config.api_key['Klaviyo-API-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['Klaviyo-API-Key'] = 'Bearer' end api_instance = KlaviyoAPI::FlowsApi.new id = 'id_example' # String | ID of the Flow to update. Ex: XVTP5Q flow_update_query = KlaviyoAPI::FlowUpdateQuery.new({data: KlaviyoAPI::FlowUpdateQueryResourceObject.new({type: KlaviyoAPI::FlowEnum::FLOW, id: 'id_example', attributes: KlaviyoAPI::FlowUpdateQueryResourceObjectAttributes.new({status: 'status_example'})})}) # FlowUpdateQuery | begin # Update Flow Status result = api_instance.update_flow(id, flow_update_query) p result rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->update_flow: #{e}" end ``` #### Using the update_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > update_flow_with_http_info(id, flow_update_query) ```ruby begin # Update Flow Status data, status_code, headers = api_instance.update_flow_with_http_info(id, flow_update_query) p status_code # => 2xx p headers # => { ... } p data # => Hash<String, Object> rescue KlaviyoAPI::ApiError => e puts "Error when calling FlowsApi->update_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | ID of the Flow to update. Ex: XVTP5Q | | | **flow_update_query** | [**FlowUpdateQuery**](FlowUpdateQuery.md) | | | ### Return type **Hash<String, Object>** ### Authorization [Klaviyo-API-Key](../README.md#Klaviyo-API-Key) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json