klaviyo-api-sdk 11.0.0 → 11.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/README.md +374 -130
- data/klaviyo-api-sdk.gemspec +1 -1
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +41 -23
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +82 -76
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +111 -93
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/events_api.rb +128 -116
- data/lib/klaviyo-api-sdk/api/flows_api.rb +199 -169
- data/lib/klaviyo-api-sdk/api/forms_api.rb +19 -7
- data/lib/klaviyo-api-sdk/api/images_api.rb +5 -5
- data/lib/klaviyo-api-sdk/api/lists_api.rb +391 -337
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +151 -115
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +149 -119
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +49 -7
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +2 -2
- data/lib/klaviyo-api-sdk/api/segments_api.rb +170 -146
- data/lib/klaviyo-api-sdk/api/tags_api.rb +108 -42
- data/lib/klaviyo-api-sdk/api/templates_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +7 -7
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/configuration.rb +18 -9
- data/lib/klaviyo-api-sdk/models/campaign_send_job_partial_update_query_resource_object_attributes.rb +34 -0
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +224 -0
- data/lib/klaviyo-api-sdk/models/profile_subscription_delete_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/sms_unsubscription_parameters.rb +228 -0
- data/lib/klaviyo-api-sdk/models/template_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/unsubscription_channels.rb +228 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_parameters.rb +259 -0
- data/lib/klaviyo-api-sdk.rb +4 -0
- metadata +6 -2
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Klaviyo Ruby SDK
|
2
2
|
|
3
|
-
- SDK version: 11.
|
3
|
+
- SDK version: 11.1.0
|
4
4
|
- API revision: 2024-10-15
|
5
5
|
|
6
6
|
## Helpful Resources
|
@@ -110,13 +110,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
110
110
|
Then install the gem locally:
|
111
111
|
|
112
112
|
```shell
|
113
|
-
gem install ./klaviyo-api-sdk-11.
|
113
|
+
gem install ./klaviyo-api-sdk-11.1.0.gem
|
114
114
|
```
|
115
115
|
|
116
116
|
|
117
117
|
Finally add this to the Gemfile:
|
118
118
|
|
119
|
-
gem 'klaviyo-api-sdk', '~> 11.
|
119
|
+
gem 'klaviyo-api-sdk', '~> 11.1.0'
|
120
120
|
|
121
121
|
To install directly from rubygems:
|
122
122
|
|
@@ -172,6 +172,18 @@ begin
|
|
172
172
|
end
|
173
173
|
```
|
174
174
|
|
175
|
+
## OAuth Authentication
|
176
|
+
|
177
|
+
To use OAuth Authentication, pass an access token instead of an API key:
|
178
|
+
|
179
|
+
```ruby
|
180
|
+
KlaviyoAPI.configure do |config|
|
181
|
+
config.access_token = 'your-oauth-access-token'
|
182
|
+
end
|
183
|
+
```
|
184
|
+
|
185
|
+
See our [guide](https://developers.klaviyo.com/en/docs/set_up_oauth) for an overview on setting up an OAuth integration.
|
186
|
+
|
175
187
|
## Error Handling
|
176
188
|
|
177
189
|
This SDK throws an `ApiException` error when the server returns a non-`2XX` response.
|
@@ -679,6 +691,10 @@ KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
|
679
691
|
```ruby
|
680
692
|
KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
|
681
693
|
```
|
694
|
+
##### Method alias:
|
695
|
+
```ruby
|
696
|
+
KlaviyoAPI::Campaigns.get_tags_for_campaign(id, opts)
|
697
|
+
```
|
682
698
|
|
683
699
|
|
684
700
|
|
@@ -703,6 +719,10 @@ KlaviyoAPI::Campaigns.get_message_ids_for_campaign(id)
|
|
703
719
|
```ruby
|
704
720
|
KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id)
|
705
721
|
```
|
722
|
+
##### Method alias:
|
723
|
+
```ruby
|
724
|
+
KlaviyoAPI::Campaigns.get_campaign_relationships_messages(id)
|
725
|
+
```
|
706
726
|
|
707
727
|
|
708
728
|
|
@@ -717,6 +737,10 @@ KlaviyoAPI::Campaigns.get_messages_for_campaign(id, opts)
|
|
717
737
|
```ruby
|
718
738
|
KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts)
|
719
739
|
```
|
740
|
+
##### Method alias:
|
741
|
+
```ruby
|
742
|
+
KlaviyoAPI::Campaigns.get_campaign_messages(id, opts)
|
743
|
+
```
|
720
744
|
|
721
745
|
|
722
746
|
|
@@ -816,19 +840,23 @@ KlaviyoAPI::Campaigns.update_campaign_message(id, body)
|
|
816
840
|
## Catalogs
|
817
841
|
|
818
842
|
|
819
|
-
#### [Add
|
843
|
+
#### [Add Categories to Catalog Item](https://developers.klaviyo.com/en/v2024-10-15/reference/add_categories_to_catalog_item)
|
820
844
|
|
821
845
|
```ruby
|
822
|
-
KlaviyoAPI::Catalogs.
|
846
|
+
KlaviyoAPI::Catalogs.add_categories_to_catalog_item(id, body)
|
823
847
|
```
|
824
848
|
##### Method alias:
|
825
849
|
```ruby
|
826
|
-
KlaviyoAPI::Catalogs.
|
850
|
+
KlaviyoAPI::Catalogs.add_category_to_catalog_item(id, body)
|
827
851
|
```
|
828
852
|
##### Method alias:
|
829
853
|
```ruby
|
830
854
|
KlaviyoAPI::Catalogs.create_catalog_item_relationships_category(id, body)
|
831
855
|
```
|
856
|
+
##### Method alias:
|
857
|
+
```ruby
|
858
|
+
KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
|
859
|
+
```
|
832
860
|
|
833
861
|
|
834
862
|
|
@@ -841,11 +869,11 @@ KlaviyoAPI::Catalogs.add_items_to_catalog_category(id, body)
|
|
841
869
|
```
|
842
870
|
##### Method alias:
|
843
871
|
```ruby
|
844
|
-
KlaviyoAPI::Catalogs.
|
872
|
+
KlaviyoAPI::Catalogs.create_catalog_category_relationships_item(id, body)
|
845
873
|
```
|
846
874
|
##### Method alias:
|
847
875
|
```ruby
|
848
|
-
KlaviyoAPI::Catalogs.
|
876
|
+
KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
|
849
877
|
```
|
850
878
|
|
851
879
|
|
@@ -1666,34 +1694,42 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts)
|
|
1666
1694
|
|
1667
1695
|
|
1668
1696
|
|
1669
|
-
#### [Get
|
1697
|
+
#### [Get Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon)
|
1670
1698
|
|
1671
1699
|
```ruby
|
1672
|
-
KlaviyoAPI::Coupons.
|
1673
|
-
```
|
1674
|
-
##### Method alias:
|
1675
|
-
```ruby
|
1676
|
-
KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts)
|
1700
|
+
KlaviyoAPI::Coupons.get_coupon(id, opts)
|
1677
1701
|
```
|
1678
1702
|
|
1679
1703
|
|
1680
1704
|
|
1681
1705
|
|
1682
1706
|
|
1683
|
-
#### [Get Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/
|
1707
|
+
#### [Get Coupon Code](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_code)
|
1684
1708
|
|
1685
1709
|
```ruby
|
1686
|
-
KlaviyoAPI::Coupons.
|
1710
|
+
KlaviyoAPI::Coupons.get_coupon_code(id, opts)
|
1687
1711
|
```
|
1688
1712
|
|
1689
1713
|
|
1690
1714
|
|
1691
1715
|
|
1692
1716
|
|
1693
|
-
#### [Get Coupon Code](https://developers.klaviyo.com/en/v2024-10-15/reference/
|
1717
|
+
#### [Get Coupon Code IDs for Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_code_ids_for_coupon)
|
1694
1718
|
|
1695
1719
|
```ruby
|
1696
|
-
KlaviyoAPI::Coupons.
|
1720
|
+
KlaviyoAPI::Coupons.get_coupon_code_ids_for_coupon(id, opts)
|
1721
|
+
```
|
1722
|
+
##### Method alias:
|
1723
|
+
```ruby
|
1724
|
+
KlaviyoAPI::Coupons.get_coupon_code_relationships_coupon(id, opts)
|
1725
|
+
```
|
1726
|
+
##### Method alias:
|
1727
|
+
```ruby
|
1728
|
+
KlaviyoAPI::Coupons.get_code_ids_for_coupon(id, opts)
|
1729
|
+
```
|
1730
|
+
##### Method alias:
|
1731
|
+
```ruby
|
1732
|
+
KlaviyoAPI::Coupons.get_coupon_relationships_codes(id, opts)
|
1697
1733
|
```
|
1698
1734
|
|
1699
1735
|
|
@@ -1710,7 +1746,7 @@ KlaviyoAPI::Coupons.get_coupon_codes(opts)
|
|
1710
1746
|
|
1711
1747
|
|
1712
1748
|
|
1713
|
-
#### [Get Coupon Codes
|
1749
|
+
#### [Get Coupon Codes for Coupon](https://developers.klaviyo.com/en/v2024-10-15/reference/get_coupon_codes_for_coupon)
|
1714
1750
|
|
1715
1751
|
```ruby
|
1716
1752
|
KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
|
@@ -1719,6 +1755,10 @@ KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
|
|
1719
1755
|
```ruby
|
1720
1756
|
KlaviyoAPI::Coupons.get_coupon_coupon_codes(id, opts)
|
1721
1757
|
```
|
1758
|
+
##### Method alias:
|
1759
|
+
```ruby
|
1760
|
+
KlaviyoAPI::Coupons.get_codes_for_coupon(id, opts)
|
1761
|
+
```
|
1722
1762
|
|
1723
1763
|
|
1724
1764
|
|
@@ -1838,44 +1878,52 @@ KlaviyoAPI::Events.get_event(id, opts)
|
|
1838
1878
|
|
1839
1879
|
|
1840
1880
|
|
1841
|
-
#### [Get
|
1881
|
+
#### [Get Events](https://developers.klaviyo.com/en/v2024-10-15/reference/get_events)
|
1842
1882
|
|
1843
1883
|
```ruby
|
1844
|
-
KlaviyoAPI::Events.
|
1884
|
+
KlaviyoAPI::Events.get_events(opts)
|
1845
1885
|
```
|
1846
1886
|
|
1847
1887
|
|
1848
1888
|
|
1849
1889
|
|
1850
1890
|
|
1851
|
-
#### [Get Event
|
1891
|
+
#### [Get Metric for Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_for_event)
|
1852
1892
|
|
1853
1893
|
```ruby
|
1854
|
-
KlaviyoAPI::Events.
|
1894
|
+
KlaviyoAPI::Events.get_metric_for_event(id, opts)
|
1895
|
+
```
|
1896
|
+
##### Method alias:
|
1897
|
+
```ruby
|
1898
|
+
KlaviyoAPI::Events.get_event_metric(id, opts)
|
1855
1899
|
```
|
1856
1900
|
|
1857
1901
|
|
1858
1902
|
|
1859
1903
|
|
1860
1904
|
|
1861
|
-
#### [Get
|
1905
|
+
#### [Get Metric ID for Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_id_for_event)
|
1862
1906
|
|
1863
1907
|
```ruby
|
1864
|
-
KlaviyoAPI::Events.
|
1908
|
+
KlaviyoAPI::Events.get_metric_id_for_event(id)
|
1909
|
+
```
|
1910
|
+
##### Method alias:
|
1911
|
+
```ruby
|
1912
|
+
KlaviyoAPI::Events.get_event_relationships_metric(id)
|
1865
1913
|
```
|
1866
1914
|
|
1867
1915
|
|
1868
1916
|
|
1869
1917
|
|
1870
1918
|
|
1871
|
-
#### [Get
|
1919
|
+
#### [Get Profile for Event](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_for_event)
|
1872
1920
|
|
1873
1921
|
```ruby
|
1874
|
-
KlaviyoAPI::Events.
|
1922
|
+
KlaviyoAPI::Events.get_profile_for_event(id, opts)
|
1875
1923
|
```
|
1876
1924
|
##### Method alias:
|
1877
1925
|
```ruby
|
1878
|
-
KlaviyoAPI::Events.
|
1926
|
+
KlaviyoAPI::Events.get_event_profile(id, opts)
|
1879
1927
|
```
|
1880
1928
|
|
1881
1929
|
|
@@ -1910,6 +1958,20 @@ KlaviyoAPI::Flows.delete_flow(id)
|
|
1910
1958
|
|
1911
1959
|
|
1912
1960
|
|
1961
|
+
#### [Get Action for Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_action_for_flow_message)
|
1962
|
+
|
1963
|
+
```ruby
|
1964
|
+
KlaviyoAPI::Flows.get_action_for_flow_message(id, opts)
|
1965
|
+
```
|
1966
|
+
##### Method alias:
|
1967
|
+
```ruby
|
1968
|
+
KlaviyoAPI::Flows.get_flow_message_action(id, opts)
|
1969
|
+
```
|
1970
|
+
|
1971
|
+
|
1972
|
+
|
1973
|
+
|
1974
|
+
|
1913
1975
|
#### [Get Action ID for Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_action_id_for_flow_message)
|
1914
1976
|
|
1915
1977
|
```ruby
|
@@ -1933,6 +1995,10 @@ KlaviyoAPI::Flows.get_action_ids_for_flow(id, opts)
|
|
1933
1995
|
```ruby
|
1934
1996
|
KlaviyoAPI::Flows.get_flow_relationships_flow_actions(id, opts)
|
1935
1997
|
```
|
1998
|
+
##### Method alias:
|
1999
|
+
```ruby
|
2000
|
+
KlaviyoAPI::Flows.get_flow_relationships_actions(id, opts)
|
2001
|
+
```
|
1936
2002
|
|
1937
2003
|
|
1938
2004
|
|
@@ -1947,6 +2013,10 @@ KlaviyoAPI::Flows.get_actions_for_flow(id, opts)
|
|
1947
2013
|
```ruby
|
1948
2014
|
KlaviyoAPI::Flows.get_flow_flow_actions(id, opts)
|
1949
2015
|
```
|
2016
|
+
##### Method alias:
|
2017
|
+
```ruby
|
2018
|
+
KlaviyoAPI::Flows.get_flow_actions(id, opts)
|
2019
|
+
```
|
1950
2020
|
|
1951
2021
|
|
1952
2022
|
|
@@ -1972,8 +2042,12 @@ KlaviyoAPI::Flows.get_flow_action(id, opts)
|
|
1972
2042
|
|
1973
2043
|
|
1974
2044
|
|
1975
|
-
#### [Get Flow
|
2045
|
+
#### [Get Flow for Flow Action](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_for_flow_action)
|
1976
2046
|
|
2047
|
+
```ruby
|
2048
|
+
KlaviyoAPI::Flows.get_flow_for_flow_action(id, opts)
|
2049
|
+
```
|
2050
|
+
##### Method alias:
|
1977
2051
|
```ruby
|
1978
2052
|
KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
|
1979
2053
|
```
|
@@ -2006,26 +2080,6 @@ KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
2006
2080
|
|
2007
2081
|
|
2008
2082
|
|
2009
|
-
#### [Get Flow Action For Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_message_action)
|
2010
|
-
|
2011
|
-
```ruby
|
2012
|
-
KlaviyoAPI::Flows.get_flow_message_action(id, opts)
|
2013
|
-
```
|
2014
|
-
|
2015
|
-
|
2016
|
-
|
2017
|
-
|
2018
|
-
|
2019
|
-
#### [Get Flow Tags](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flow_tags)
|
2020
|
-
|
2021
|
-
```ruby
|
2022
|
-
KlaviyoAPI::Flows.get_flow_tags(id, opts)
|
2023
|
-
```
|
2024
|
-
|
2025
|
-
|
2026
|
-
|
2027
|
-
|
2028
|
-
|
2029
2083
|
#### [Get Flows](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows)
|
2030
2084
|
|
2031
2085
|
```ruby
|
@@ -2078,6 +2132,20 @@ KlaviyoAPI::Flows.get_flow_relationships_tags(id)
|
|
2078
2132
|
|
2079
2133
|
|
2080
2134
|
|
2135
|
+
#### [Get Tags for Flow](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tags_for_flow)
|
2136
|
+
|
2137
|
+
```ruby
|
2138
|
+
KlaviyoAPI::Flows.get_tags_for_flow(id, opts)
|
2139
|
+
```
|
2140
|
+
##### Method alias:
|
2141
|
+
```ruby
|
2142
|
+
KlaviyoAPI::Flows.get_flow_tags(id, opts)
|
2143
|
+
```
|
2144
|
+
|
2145
|
+
|
2146
|
+
|
2147
|
+
|
2148
|
+
|
2081
2149
|
#### [Get Template for Flow Message](https://developers.klaviyo.com/en/v2024-10-15/reference/get_template_for_flow_message)
|
2082
2150
|
|
2083
2151
|
```ruby
|
@@ -2187,6 +2255,10 @@ KlaviyoAPI::Forms.get_version_ids_for_form(id)
|
|
2187
2255
|
```ruby
|
2188
2256
|
KlaviyoAPI::Forms.get_form_relationships_form_versions(id)
|
2189
2257
|
```
|
2258
|
+
##### Method alias:
|
2259
|
+
```ruby
|
2260
|
+
KlaviyoAPI::Forms.get_form_relationships_versions(id)
|
2261
|
+
```
|
2190
2262
|
|
2191
2263
|
|
2192
2264
|
|
@@ -2201,6 +2273,10 @@ KlaviyoAPI::Forms.get_versions_for_form(id, opts)
|
|
2201
2273
|
```ruby
|
2202
2274
|
KlaviyoAPI::Forms.get_form_form_versions(id, opts)
|
2203
2275
|
```
|
2276
|
+
##### Method alias:
|
2277
|
+
```ruby
|
2278
|
+
KlaviyoAPI::Forms.get_form_versions(id, opts)
|
2279
|
+
```
|
2204
2280
|
|
2205
2281
|
|
2206
2282
|
|
@@ -2272,24 +2348,32 @@ KlaviyoAPI::Images.create_image(body)
|
|
2272
2348
|
## Lists
|
2273
2349
|
|
2274
2350
|
|
2275
|
-
#### [
|
2351
|
+
#### [Add Profiles to List](https://developers.klaviyo.com/en/v2024-10-15/reference/add_profiles_to_list)
|
2276
2352
|
|
2277
2353
|
```ruby
|
2278
|
-
KlaviyoAPI::Lists.
|
2354
|
+
KlaviyoAPI::Lists.add_profiles_to_list(id, body)
|
2355
|
+
```
|
2356
|
+
##### Method alias:
|
2357
|
+
```ruby
|
2358
|
+
KlaviyoAPI::Lists.create_list_relationships(id, body)
|
2359
|
+
```
|
2360
|
+
##### Method alias:
|
2361
|
+
```ruby
|
2362
|
+
KlaviyoAPI::Lists.create_list_relationships_profile(id, body)
|
2363
|
+
```
|
2364
|
+
##### Method alias:
|
2365
|
+
```ruby
|
2366
|
+
KlaviyoAPI::Lists.create_list_relationships_profiles(id, body)
|
2279
2367
|
```
|
2280
2368
|
|
2281
2369
|
|
2282
2370
|
|
2283
2371
|
|
2284
2372
|
|
2285
|
-
#### [
|
2373
|
+
#### [Create List](https://developers.klaviyo.com/en/v2024-10-15/reference/create_list)
|
2286
2374
|
|
2287
2375
|
```ruby
|
2288
|
-
KlaviyoAPI::Lists.
|
2289
|
-
```
|
2290
|
-
##### Method alias:
|
2291
|
-
```ruby
|
2292
|
-
KlaviyoAPI::Lists.create_list_relationships_profile(id, body)
|
2376
|
+
KlaviyoAPI::Lists.create_list(body)
|
2293
2377
|
```
|
2294
2378
|
|
2295
2379
|
|
@@ -2306,102 +2390,130 @@ KlaviyoAPI::Lists.delete_list(id)
|
|
2306
2390
|
|
2307
2391
|
|
2308
2392
|
|
2309
|
-
#### [
|
2393
|
+
#### [Get Flows Triggered by List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows_triggered_by_list)
|
2310
2394
|
|
2311
2395
|
```ruby
|
2312
|
-
KlaviyoAPI::Lists.
|
2396
|
+
KlaviyoAPI::Lists.get_flows_triggered_by_list(id, opts)
|
2313
2397
|
```
|
2314
2398
|
##### Method alias:
|
2315
2399
|
```ruby
|
2316
|
-
KlaviyoAPI::Lists.
|
2400
|
+
KlaviyoAPI::Lists.get_flow_triggers_for_list(id, opts)
|
2401
|
+
```
|
2402
|
+
##### Method alias:
|
2403
|
+
```ruby
|
2404
|
+
KlaviyoAPI::Lists.get_list_flow_triggers(id, opts)
|
2317
2405
|
```
|
2318
2406
|
|
2319
2407
|
|
2320
2408
|
|
2321
2409
|
|
2322
2410
|
|
2323
|
-
#### [Get List](https://developers.klaviyo.com/en/v2024-10-15/reference/
|
2411
|
+
#### [Get IDs for Flows Triggered by List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_ids_for_flows_triggered_by_list)
|
2324
2412
|
|
2325
2413
|
```ruby
|
2326
|
-
KlaviyoAPI::Lists.
|
2414
|
+
KlaviyoAPI::Lists.get_ids_for_flows_triggered_by_list(id)
|
2415
|
+
```
|
2416
|
+
##### Method alias:
|
2417
|
+
```ruby
|
2418
|
+
KlaviyoAPI::Lists.get_flow_trigger_ids_for_list(id)
|
2419
|
+
```
|
2420
|
+
##### Method alias:
|
2421
|
+
```ruby
|
2422
|
+
KlaviyoAPI::Lists.get_list_relationships_flow_triggers(id)
|
2327
2423
|
```
|
2328
2424
|
|
2329
2425
|
|
2330
2426
|
|
2331
2427
|
|
2332
2428
|
|
2333
|
-
#### [Get List
|
2429
|
+
#### [Get List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_list)
|
2334
2430
|
|
2335
2431
|
```ruby
|
2336
|
-
KlaviyoAPI::Lists.
|
2432
|
+
KlaviyoAPI::Lists.get_list(id, opts)
|
2337
2433
|
```
|
2338
2434
|
|
2339
2435
|
|
2340
2436
|
|
2341
2437
|
|
2342
2438
|
|
2343
|
-
#### [Get
|
2439
|
+
#### [Get Lists](https://developers.klaviyo.com/en/v2024-10-15/reference/get_lists)
|
2344
2440
|
|
2345
2441
|
```ruby
|
2346
|
-
KlaviyoAPI::Lists.
|
2442
|
+
KlaviyoAPI::Lists.get_lists(opts)
|
2347
2443
|
```
|
2348
2444
|
|
2349
2445
|
|
2350
2446
|
|
2351
2447
|
|
2352
2448
|
|
2353
|
-
#### [Get
|
2449
|
+
#### [Get Profile IDs for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_ids_for_list)
|
2354
2450
|
|
2355
2451
|
```ruby
|
2356
|
-
KlaviyoAPI::Lists.
|
2452
|
+
KlaviyoAPI::Lists.get_profile_ids_for_list(id, opts)
|
2453
|
+
```
|
2454
|
+
##### Method alias:
|
2455
|
+
```ruby
|
2456
|
+
KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
|
2357
2457
|
```
|
2358
2458
|
|
2359
2459
|
|
2360
2460
|
|
2361
2461
|
|
2362
2462
|
|
2363
|
-
#### [Get List
|
2463
|
+
#### [Get Profiles for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profiles_for_list)
|
2364
2464
|
|
2365
2465
|
```ruby
|
2366
|
-
KlaviyoAPI::Lists.
|
2466
|
+
KlaviyoAPI::Lists.get_profiles_for_list(id, opts)
|
2467
|
+
```
|
2468
|
+
##### Method alias:
|
2469
|
+
```ruby
|
2470
|
+
KlaviyoAPI::Lists.get_list_profiles(id, opts)
|
2367
2471
|
```
|
2368
2472
|
|
2369
2473
|
|
2370
2474
|
|
2371
2475
|
|
2372
2476
|
|
2373
|
-
#### [Get
|
2477
|
+
#### [Get Tag IDs for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tag_ids_for_list)
|
2374
2478
|
|
2375
2479
|
```ruby
|
2376
|
-
KlaviyoAPI::Lists.
|
2480
|
+
KlaviyoAPI::Lists.get_tag_ids_for_list(id)
|
2481
|
+
```
|
2482
|
+
##### Method alias:
|
2483
|
+
```ruby
|
2484
|
+
KlaviyoAPI::Lists.get_list_relationships_tags(id)
|
2377
2485
|
```
|
2378
2486
|
|
2379
2487
|
|
2380
2488
|
|
2381
2489
|
|
2382
2490
|
|
2383
|
-
#### [Get
|
2491
|
+
#### [Get Tags for List](https://developers.klaviyo.com/en/v2024-10-15/reference/get_tags_for_list)
|
2384
2492
|
|
2385
2493
|
```ruby
|
2386
|
-
KlaviyoAPI::Lists.
|
2494
|
+
KlaviyoAPI::Lists.get_tags_for_list(id, opts)
|
2387
2495
|
```
|
2388
2496
|
##### Method alias:
|
2389
2497
|
```ruby
|
2390
|
-
KlaviyoAPI::Lists.
|
2498
|
+
KlaviyoAPI::Lists.get_list_tags(id, opts)
|
2391
2499
|
```
|
2392
2500
|
|
2393
2501
|
|
2394
2502
|
|
2395
2503
|
|
2396
2504
|
|
2397
|
-
#### [
|
2505
|
+
#### [Remove Profiles from List](https://developers.klaviyo.com/en/v2024-10-15/reference/remove_profiles_from_list)
|
2398
2506
|
|
2399
2507
|
```ruby
|
2400
|
-
KlaviyoAPI::Lists.
|
2508
|
+
KlaviyoAPI::Lists.remove_profiles_from_list(id, body)
|
2401
2509
|
```
|
2402
2510
|
##### Method alias:
|
2403
2511
|
```ruby
|
2404
|
-
KlaviyoAPI::Lists.
|
2512
|
+
KlaviyoAPI::Lists.delete_list_relationships(id, body)
|
2513
|
+
```
|
2514
|
+
##### Method alias:
|
2515
|
+
```ruby
|
2516
|
+
KlaviyoAPI::Lists.delete_list_relationships_profiles(id, body)
|
2405
2517
|
```
|
2406
2518
|
|
2407
2519
|
|
@@ -2422,20 +2534,46 @@ KlaviyoAPI::Lists.update_list(id, body)
|
|
2422
2534
|
## Metrics
|
2423
2535
|
|
2424
2536
|
|
2425
|
-
#### [Get Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/
|
2537
|
+
#### [Get Flows Triggered by Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows_triggered_by_metric)
|
2426
2538
|
|
2427
2539
|
```ruby
|
2428
|
-
KlaviyoAPI::Metrics.
|
2540
|
+
KlaviyoAPI::Metrics.get_flows_triggered_by_metric(id, opts)
|
2541
|
+
```
|
2542
|
+
##### Method alias:
|
2543
|
+
```ruby
|
2544
|
+
KlaviyoAPI::Metrics.get_flow_triggers_for_metric(id, opts)
|
2545
|
+
```
|
2546
|
+
##### Method alias:
|
2547
|
+
```ruby
|
2548
|
+
KlaviyoAPI::Metrics.get_metric_flow_triggers(id, opts)
|
2429
2549
|
```
|
2430
2550
|
|
2431
2551
|
|
2432
2552
|
|
2433
2553
|
|
2434
2554
|
|
2435
|
-
#### [Get
|
2555
|
+
#### [Get IDs for Flows Triggered by Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_ids_for_flows_triggered_by_metric)
|
2436
2556
|
|
2437
2557
|
```ruby
|
2438
|
-
KlaviyoAPI::Metrics.
|
2558
|
+
KlaviyoAPI::Metrics.get_ids_for_flows_triggered_by_metric(id)
|
2559
|
+
```
|
2560
|
+
##### Method alias:
|
2561
|
+
```ruby
|
2562
|
+
KlaviyoAPI::Metrics.get_flow_trigger_ids_for_metric(id)
|
2563
|
+
```
|
2564
|
+
##### Method alias:
|
2565
|
+
```ruby
|
2566
|
+
KlaviyoAPI::Metrics.get_metric_relationships_flow_triggers(id)
|
2567
|
+
```
|
2568
|
+
|
2569
|
+
|
2570
|
+
|
2571
|
+
|
2572
|
+
|
2573
|
+
#### [Get Metric](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric)
|
2574
|
+
|
2575
|
+
```ruby
|
2576
|
+
KlaviyoAPI::Metrics.get_metric(id, opts)
|
2439
2577
|
```
|
2440
2578
|
|
2441
2579
|
|
@@ -2480,16 +2618,6 @@ KlaviyoAPI::Metrics.get_metric_property(id, opts)
|
|
2480
2618
|
|
2481
2619
|
|
2482
2620
|
|
2483
|
-
#### [Get Metric Relationships Flow Triggers](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metric_relationships_flow_triggers)
|
2484
|
-
|
2485
|
-
```ruby
|
2486
|
-
KlaviyoAPI::Metrics.get_metric_relationships_flow_triggers(id)
|
2487
|
-
```
|
2488
|
-
|
2489
|
-
|
2490
|
-
|
2491
|
-
|
2492
|
-
|
2493
2621
|
#### [Get Metrics](https://developers.klaviyo.com/en/v2024-10-15/reference/get_metrics)
|
2494
2622
|
|
2495
2623
|
```ruby
|
@@ -2509,6 +2637,10 @@ KlaviyoAPI::Metrics.get_properties_for_metric(id, opts)
|
|
2509
2637
|
```ruby
|
2510
2638
|
KlaviyoAPI::Metrics.get_metric_metric_properties(id, opts)
|
2511
2639
|
```
|
2640
|
+
##### Method alias:
|
2641
|
+
```ruby
|
2642
|
+
KlaviyoAPI::Metrics.get_metric_properties(id, opts)
|
2643
|
+
```
|
2512
2644
|
|
2513
2645
|
|
2514
2646
|
|
@@ -2523,6 +2655,10 @@ KlaviyoAPI::Metrics.get_property_ids_for_metric(id)
|
|
2523
2655
|
```ruby
|
2524
2656
|
KlaviyoAPI::Metrics.get_metric_relationships_metric_properties(id)
|
2525
2657
|
```
|
2658
|
+
##### Method alias:
|
2659
|
+
```ruby
|
2660
|
+
KlaviyoAPI::Metrics.get_metric_relationships_properties(id)
|
2661
|
+
```
|
2526
2662
|
|
2527
2663
|
|
2528
2664
|
|
@@ -2546,6 +2682,24 @@ KlaviyoAPI::Metrics.create_metric_aggregate(body)
|
|
2546
2682
|
## Profiles
|
2547
2683
|
|
2548
2684
|
|
2685
|
+
#### [Bulk Import Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_import_profiles)
|
2686
|
+
|
2687
|
+
```ruby
|
2688
|
+
KlaviyoAPI::Profiles.bulk_import_profiles(body)
|
2689
|
+
```
|
2690
|
+
##### Method alias:
|
2691
|
+
```ruby
|
2692
|
+
KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
|
2693
|
+
```
|
2694
|
+
##### Method alias:
|
2695
|
+
```ruby
|
2696
|
+
KlaviyoAPI::Profiles.create_profile_bulk_import_job(body)
|
2697
|
+
```
|
2698
|
+
|
2699
|
+
|
2700
|
+
|
2701
|
+
|
2702
|
+
|
2549
2703
|
#### [Bulk Subscribe Profiles](https://developers.klaviyo.com/en/v2024-10-15/reference/bulk_subscribe_profiles)
|
2550
2704
|
|
2551
2705
|
```ruby
|
@@ -2755,6 +2909,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_import_errors(id, opts)
|
|
2755
2909
|
```
|
2756
2910
|
##### Method alias:
|
2757
2911
|
```ruby
|
2912
|
+
KlaviyoAPI::Profiles.get_import_errors_for_profile_bulk_import_job(id, opts)
|
2913
|
+
```
|
2914
|
+
##### Method alias:
|
2915
|
+
```ruby
|
2758
2916
|
KlaviyoAPI::Profiles.get_profile_bulk_import_job_import_errors(id, opts)
|
2759
2917
|
```
|
2760
2918
|
|
@@ -2773,6 +2931,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_lists(id, opts)
|
|
2773
2931
|
```
|
2774
2932
|
##### Method alias:
|
2775
2933
|
```ruby
|
2934
|
+
KlaviyoAPI::Profiles.get_lists_for_profile_bulk_import_job(id, opts)
|
2935
|
+
```
|
2936
|
+
##### Method alias:
|
2937
|
+
```ruby
|
2776
2938
|
KlaviyoAPI::Profiles.get_profile_bulk_import_job_lists(id, opts)
|
2777
2939
|
```
|
2778
2940
|
|
@@ -2791,6 +2953,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_lists(id)
|
|
2791
2953
|
```
|
2792
2954
|
##### Method alias:
|
2793
2955
|
```ruby
|
2956
|
+
KlaviyoAPI::Profiles.get_list_ids_for_profile_bulk_import_job(id)
|
2957
|
+
```
|
2958
|
+
##### Method alias:
|
2959
|
+
```ruby
|
2794
2960
|
KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_lists(id)
|
2795
2961
|
```
|
2796
2962
|
|
@@ -2849,6 +3015,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_relationships_profiles(id, opts
|
|
2849
3015
|
```ruby
|
2850
3016
|
KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_profiles(id, opts)
|
2851
3017
|
```
|
3018
|
+
##### Method alias:
|
3019
|
+
```ruby
|
3020
|
+
KlaviyoAPI::Profiles.get_profile_ids_for_profile_bulk_import_job(id, opts)
|
3021
|
+
```
|
2852
3022
|
|
2853
3023
|
|
2854
3024
|
|
@@ -2877,6 +3047,10 @@ KlaviyoAPI::Profiles.get_bulk_profile_import_job_profiles(id, opts)
|
|
2877
3047
|
```ruby
|
2878
3048
|
KlaviyoAPI::Profiles.get_profile_bulk_import_job_profiles(id, opts)
|
2879
3049
|
```
|
3050
|
+
##### Method alias:
|
3051
|
+
```ruby
|
3052
|
+
KlaviyoAPI::Profiles.get_profiles_for_profile_bulk_import_job(id, opts)
|
3053
|
+
```
|
2880
3054
|
|
2881
3055
|
|
2882
3056
|
|
@@ -2924,24 +3098,6 @@ KlaviyoAPI::Profiles.create_profile_merge(body)
|
|
2924
3098
|
|
2925
3099
|
|
2926
3100
|
|
2927
|
-
#### [Spawn Bulk Profile Import Job](https://developers.klaviyo.com/en/v2024-10-15/reference/spawn_bulk_profile_import_job)
|
2928
|
-
|
2929
|
-
```ruby
|
2930
|
-
KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
|
2931
|
-
```
|
2932
|
-
##### Method alias:
|
2933
|
-
```ruby
|
2934
|
-
KlaviyoAPI::Profiles.bulk_import_profiles(body)
|
2935
|
-
```
|
2936
|
-
##### Method alias:
|
2937
|
-
```ruby
|
2938
|
-
KlaviyoAPI::Profiles.create_profile_bulk_import_job(body)
|
2939
|
-
```
|
2940
|
-
|
2941
|
-
|
2942
|
-
|
2943
|
-
|
2944
|
-
|
2945
3101
|
#### [Update Profile](https://developers.klaviyo.com/en/v2024-10-15/reference/update_profile)
|
2946
3102
|
|
2947
3103
|
```ruby
|
@@ -2965,6 +3121,10 @@ KlaviyoAPI::Reporting.query_campaign_values(body, opts)
|
|
2965
3121
|
```ruby
|
2966
3122
|
KlaviyoAPI::Reporting.create_campaign_value_report(body, opts)
|
2967
3123
|
```
|
3124
|
+
##### Method alias:
|
3125
|
+
```ruby
|
3126
|
+
KlaviyoAPI::Reporting.create_campaign_values_report(body, opts)
|
3127
|
+
```
|
2968
3128
|
|
2969
3129
|
|
2970
3130
|
|
@@ -2979,6 +3139,10 @@ KlaviyoAPI::Reporting.query_flow_series(body, opts)
|
|
2979
3139
|
```ruby
|
2980
3140
|
KlaviyoAPI::Reporting.create_flow_sery_report(body, opts)
|
2981
3141
|
```
|
3142
|
+
##### Method alias:
|
3143
|
+
```ruby
|
3144
|
+
KlaviyoAPI::Reporting.create_flow_series_report(body, opts)
|
3145
|
+
```
|
2982
3146
|
|
2983
3147
|
|
2984
3148
|
|
@@ -2993,6 +3157,10 @@ KlaviyoAPI::Reporting.query_flow_values(body, opts)
|
|
2993
3157
|
```ruby
|
2994
3158
|
KlaviyoAPI::Reporting.create_flow_value_report(body, opts)
|
2995
3159
|
```
|
3160
|
+
##### Method alias:
|
3161
|
+
```ruby
|
3162
|
+
KlaviyoAPI::Reporting.create_flow_values_report(body, opts)
|
3163
|
+
```
|
2996
3164
|
|
2997
3165
|
|
2998
3166
|
|
@@ -3007,6 +3175,10 @@ KlaviyoAPI::Reporting.query_form_series(body)
|
|
3007
3175
|
```ruby
|
3008
3176
|
KlaviyoAPI::Reporting.create_form_sery_report(body)
|
3009
3177
|
```
|
3178
|
+
##### Method alias:
|
3179
|
+
```ruby
|
3180
|
+
KlaviyoAPI::Reporting.create_form_series_report(body)
|
3181
|
+
```
|
3010
3182
|
|
3011
3183
|
|
3012
3184
|
|
@@ -3021,6 +3193,10 @@ KlaviyoAPI::Reporting.query_form_values(body)
|
|
3021
3193
|
```ruby
|
3022
3194
|
KlaviyoAPI::Reporting.create_form_value_report(body)
|
3023
3195
|
```
|
3196
|
+
##### Method alias:
|
3197
|
+
```ruby
|
3198
|
+
KlaviyoAPI::Reporting.create_form_values_report(body)
|
3199
|
+
```
|
3024
3200
|
|
3025
3201
|
|
3026
3202
|
|
@@ -3035,6 +3211,10 @@ KlaviyoAPI::Reporting.query_segment_series(body)
|
|
3035
3211
|
```ruby
|
3036
3212
|
KlaviyoAPI::Reporting.create_segment_sery_report(body)
|
3037
3213
|
```
|
3214
|
+
##### Method alias:
|
3215
|
+
```ruby
|
3216
|
+
KlaviyoAPI::Reporting.create_segment_series_report(body)
|
3217
|
+
```
|
3038
3218
|
|
3039
3219
|
|
3040
3220
|
|
@@ -3049,6 +3229,10 @@ KlaviyoAPI::Reporting.query_segment_values(body)
|
|
3049
3229
|
```ruby
|
3050
3230
|
KlaviyoAPI::Reporting.create_segment_value_report(body)
|
3051
3231
|
```
|
3232
|
+
##### Method alias:
|
3233
|
+
```ruby
|
3234
|
+
KlaviyoAPI::Reporting.create_segment_values_report(body)
|
3235
|
+
```
|
3052
3236
|
|
3053
3237
|
|
3054
3238
|
|
@@ -3102,58 +3286,74 @@ KlaviyoAPI::Segments.delete_segment(id)
|
|
3102
3286
|
|
3103
3287
|
|
3104
3288
|
|
3105
|
-
#### [Get
|
3289
|
+
#### [Get Flows Triggered by Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_flows_triggered_by_segment)
|
3106
3290
|
|
3107
3291
|
```ruby
|
3108
|
-
KlaviyoAPI::Segments.
|
3292
|
+
KlaviyoAPI::Segments.get_flows_triggered_by_segment(id, opts)
|
3109
3293
|
```
|
3110
3294
|
##### Method alias:
|
3111
3295
|
```ruby
|
3112
|
-
KlaviyoAPI::Segments.
|
3296
|
+
KlaviyoAPI::Segments.get_flow_triggers_for_segment(id, opts)
|
3297
|
+
```
|
3298
|
+
##### Method alias:
|
3299
|
+
```ruby
|
3300
|
+
KlaviyoAPI::Segments.get_segment_flow_triggers(id, opts)
|
3113
3301
|
```
|
3114
3302
|
|
3115
3303
|
|
3116
3304
|
|
3117
3305
|
|
3118
3306
|
|
3119
|
-
#### [Get
|
3307
|
+
#### [Get IDs for Flows Triggered by Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_ids_for_flows_triggered_by_segment)
|
3120
3308
|
|
3121
3309
|
```ruby
|
3122
|
-
KlaviyoAPI::Segments.
|
3310
|
+
KlaviyoAPI::Segments.get_ids_for_flows_triggered_by_segment(id)
|
3123
3311
|
```
|
3124
3312
|
##### Method alias:
|
3125
3313
|
```ruby
|
3126
|
-
KlaviyoAPI::Segments.
|
3314
|
+
KlaviyoAPI::Segments.get_flow_trigger_ids_for_segment(id)
|
3315
|
+
```
|
3316
|
+
##### Method alias:
|
3317
|
+
```ruby
|
3318
|
+
KlaviyoAPI::Segments.get_segment_relationships_flow_triggers(id)
|
3127
3319
|
```
|
3128
3320
|
|
3129
3321
|
|
3130
3322
|
|
3131
3323
|
|
3132
3324
|
|
3133
|
-
#### [Get Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/
|
3325
|
+
#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profile_ids_for_segment)
|
3134
3326
|
|
3135
3327
|
```ruby
|
3136
|
-
KlaviyoAPI::Segments.
|
3328
|
+
KlaviyoAPI::Segments.get_profile_ids_for_segment(id, opts)
|
3329
|
+
```
|
3330
|
+
##### Method alias:
|
3331
|
+
```ruby
|
3332
|
+
KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
|
3137
3333
|
```
|
3138
3334
|
|
3139
3335
|
|
3140
3336
|
|
3141
3337
|
|
3142
3338
|
|
3143
|
-
#### [Get
|
3339
|
+
#### [Get Profiles for Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_profiles_for_segment)
|
3144
3340
|
|
3145
3341
|
```ruby
|
3146
|
-
KlaviyoAPI::Segments.
|
3342
|
+
KlaviyoAPI::Segments.get_profiles_for_segment(id, opts)
|
3343
|
+
```
|
3344
|
+
##### Method alias:
|
3345
|
+
```ruby
|
3346
|
+
KlaviyoAPI::Segments.get_segment_profiles(id, opts)
|
3147
3347
|
```
|
3148
3348
|
|
3149
3349
|
|
3150
3350
|
|
3151
3351
|
|
3152
3352
|
|
3153
|
-
#### [Get Segment
|
3353
|
+
#### [Get Segment](https://developers.klaviyo.com/en/v2024-10-15/reference/get_segment)
|
3154
3354
|
|
3155
3355
|
```ruby
|
3156
|
-
KlaviyoAPI::Segments.
|
3356
|
+
KlaviyoAPI::Segments.get_segment(id, opts)
|
3157
3357
|
```
|
3158
3358
|
|
3159
3359
|
|
@@ -3337,6 +3537,10 @@ KlaviyoAPI::Tags.get_tag_group_for_tag(id, opts)
|
|
3337
3537
|
```ruby
|
3338
3538
|
KlaviyoAPI::Tags.get_tag_tag_group(id, opts)
|
3339
3539
|
```
|
3540
|
+
##### Method alias:
|
3541
|
+
```ruby
|
3542
|
+
KlaviyoAPI::Tags.get_group_for_tag(id, opts)
|
3543
|
+
```
|
3340
3544
|
|
3341
3545
|
|
3342
3546
|
|
@@ -3351,6 +3555,14 @@ KlaviyoAPI::Tags.get_tag_group_id_for_tag(id)
|
|
3351
3555
|
```ruby
|
3352
3556
|
KlaviyoAPI::Tags.get_tag_relationships_tag_group(id)
|
3353
3557
|
```
|
3558
|
+
##### Method alias:
|
3559
|
+
```ruby
|
3560
|
+
KlaviyoAPI::Tags.get_group_id_for_tag(id)
|
3561
|
+
```
|
3562
|
+
##### Method alias:
|
3563
|
+
```ruby
|
3564
|
+
KlaviyoAPI::Tags.get_tag_relationships_group(id)
|
3565
|
+
```
|
3354
3566
|
|
3355
3567
|
|
3356
3568
|
|
@@ -3413,6 +3625,10 @@ KlaviyoAPI::Tags.remove_tag_from_campaigns(id, body)
|
|
3413
3625
|
```ruby
|
3414
3626
|
KlaviyoAPI::Tags.delete_tag_relationships_campaigns(id, body)
|
3415
3627
|
```
|
3628
|
+
##### Method alias:
|
3629
|
+
```ruby
|
3630
|
+
KlaviyoAPI::Tags.remove_campaigns_from_tag(id, body)
|
3631
|
+
```
|
3416
3632
|
|
3417
3633
|
|
3418
3634
|
|
@@ -3427,6 +3643,10 @@ KlaviyoAPI::Tags.remove_tag_from_flows(id, body)
|
|
3427
3643
|
```ruby
|
3428
3644
|
KlaviyoAPI::Tags.delete_tag_relationships_flows(id, body)
|
3429
3645
|
```
|
3646
|
+
##### Method alias:
|
3647
|
+
```ruby
|
3648
|
+
KlaviyoAPI::Tags.remove_flows_from_tag(id, body)
|
3649
|
+
```
|
3430
3650
|
|
3431
3651
|
|
3432
3652
|
|
@@ -3441,6 +3661,10 @@ KlaviyoAPI::Tags.remove_tag_from_lists(id, body)
|
|
3441
3661
|
```ruby
|
3442
3662
|
KlaviyoAPI::Tags.delete_tag_relationships_lists(id, body)
|
3443
3663
|
```
|
3664
|
+
##### Method alias:
|
3665
|
+
```ruby
|
3666
|
+
KlaviyoAPI::Tags.remove_lists_from_tag(id, body)
|
3667
|
+
```
|
3444
3668
|
|
3445
3669
|
|
3446
3670
|
|
@@ -3455,6 +3679,10 @@ KlaviyoAPI::Tags.remove_tag_from_segments(id, body)
|
|
3455
3679
|
```ruby
|
3456
3680
|
KlaviyoAPI::Tags.delete_tag_relationships_segments(id, body)
|
3457
3681
|
```
|
3682
|
+
##### Method alias:
|
3683
|
+
```ruby
|
3684
|
+
KlaviyoAPI::Tags.remove_segments_from_tag(id, body)
|
3685
|
+
```
|
3458
3686
|
|
3459
3687
|
|
3460
3688
|
|
@@ -3467,11 +3695,15 @@ KlaviyoAPI::Tags.tag_campaigns(id, body)
|
|
3467
3695
|
```
|
3468
3696
|
##### Method alias:
|
3469
3697
|
```ruby
|
3470
|
-
KlaviyoAPI::Tags.
|
3698
|
+
KlaviyoAPI::Tags.create_tag_relationships_campaign(id, body)
|
3471
3699
|
```
|
3472
3700
|
##### Method alias:
|
3473
3701
|
```ruby
|
3474
|
-
KlaviyoAPI::Tags.
|
3702
|
+
KlaviyoAPI::Tags.add_campaigns_to_tag(id, body)
|
3703
|
+
```
|
3704
|
+
##### Method alias:
|
3705
|
+
```ruby
|
3706
|
+
KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
|
3475
3707
|
```
|
3476
3708
|
|
3477
3709
|
|
@@ -3485,11 +3717,15 @@ KlaviyoAPI::Tags.tag_flows(id, body)
|
|
3485
3717
|
```
|
3486
3718
|
##### Method alias:
|
3487
3719
|
```ruby
|
3488
|
-
KlaviyoAPI::Tags.
|
3720
|
+
KlaviyoAPI::Tags.create_tag_relationships_flow(id, body)
|
3489
3721
|
```
|
3490
3722
|
##### Method alias:
|
3491
3723
|
```ruby
|
3492
|
-
KlaviyoAPI::Tags.
|
3724
|
+
KlaviyoAPI::Tags.add_flows_to_tag(id, body)
|
3725
|
+
```
|
3726
|
+
##### Method alias:
|
3727
|
+
```ruby
|
3728
|
+
KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
|
3493
3729
|
```
|
3494
3730
|
|
3495
3731
|
|
@@ -3503,11 +3739,15 @@ KlaviyoAPI::Tags.tag_lists(id, body)
|
|
3503
3739
|
```
|
3504
3740
|
##### Method alias:
|
3505
3741
|
```ruby
|
3506
|
-
KlaviyoAPI::Tags.
|
3742
|
+
KlaviyoAPI::Tags.create_tag_relationships_list(id, body)
|
3507
3743
|
```
|
3508
3744
|
##### Method alias:
|
3509
3745
|
```ruby
|
3510
|
-
KlaviyoAPI::Tags.
|
3746
|
+
KlaviyoAPI::Tags.add_lists_to_tag(id, body)
|
3747
|
+
```
|
3748
|
+
##### Method alias:
|
3749
|
+
```ruby
|
3750
|
+
KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
|
3511
3751
|
```
|
3512
3752
|
|
3513
3753
|
|
@@ -3521,11 +3761,15 @@ KlaviyoAPI::Tags.tag_segments(id, body)
|
|
3521
3761
|
```
|
3522
3762
|
##### Method alias:
|
3523
3763
|
```ruby
|
3524
|
-
KlaviyoAPI::Tags.
|
3764
|
+
KlaviyoAPI::Tags.create_tag_relationships_segment(id, body)
|
3525
3765
|
```
|
3526
3766
|
##### Method alias:
|
3527
3767
|
```ruby
|
3528
|
-
KlaviyoAPI::Tags.
|
3768
|
+
KlaviyoAPI::Tags.add_segments_to_tag(id, body)
|
3769
|
+
```
|
3770
|
+
##### Method alias:
|
3771
|
+
```ruby
|
3772
|
+
KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
|
3529
3773
|
```
|
3530
3774
|
|
3531
3775
|
|