klaviyo-api-sdk 17.0.0 → 18.0.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 +22 -0
- data/README.md +932 -414
- data/klaviyo-api-sdk.gemspec +1 -1
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +12 -12
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +215 -155
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +585 -381
- data/lib/klaviyo-api-sdk/api/client_api.rb +100 -0
- data/lib/klaviyo-api-sdk/api/conversations_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +187 -108
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +2755 -83
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +3 -3
- data/lib/klaviyo-api-sdk/api/events_api.rb +72 -58
- data/lib/klaviyo-api-sdk/api/flows_api.rb +238 -152
- data/lib/klaviyo-api-sdk/api/forms_api.rb +81 -60
- data/lib/klaviyo-api-sdk/api/images_api.rb +48 -27
- data/lib/klaviyo-api-sdk/api/lists_api.rb +113 -88
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +184 -156
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +445 -226
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +76 -27
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +38 -31
- data/lib/klaviyo-api-sdk/api/segments_api.rb +107 -82
- data/lib/klaviyo-api-sdk/api/tags_api.rb +164 -128
- data/lib/klaviyo-api-sdk/api/templates_api.rb +113 -60
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +24 -17
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +41 -27
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +73 -31
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/action_output_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/action_output_condition_filter.rb +78 -195
- data/lib/klaviyo-api-sdk/models/action_output_split_action_data.rb +2 -6
- data/lib/klaviyo-api-sdk/models/{flow_push_notification_additional_filters.rb → action_output_split_action_data_action_output_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{action_output_condition_condition_group.rb → action_output_split_action_data_action_output_filter_condition_groups_inner.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/api_schema_property.rb +301 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb +15 -2
- data/lib/klaviyo-api-sdk/models/base_style_properties.rb +15 -5
- data/lib/klaviyo-api-sdk/models/button_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/button_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/button_styles.rb +25 -3
- data/lib/klaviyo-api-sdk/models/{action_output_condition_filter2.rb → button_styles_height.rb} +3 -7
- data/lib/klaviyo-api-sdk/models/cart_content.rb +277 -0
- data/lib/klaviyo-api-sdk/models/cart_content_properties.rb +236 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +5 -0
- data/lib/klaviyo-api-sdk/models/constant_property_mapping.rb +287 -0
- data/lib/klaviyo-api-sdk/models/{price_drop_condition_filter2.rb → constant_property_mapping_value.rb} +6 -16
- data/lib/klaviyo-api-sdk/models/content_experiment_action.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{send_push_notification_action_content_experiment_action_data.rb → content_experiment_action_data.rb} +6 -5
- data/lib/klaviyo-api-sdk/models/{send_push_notification_action_current_experiment.rb → content_experiment_action_data_current_experiment.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/{low_inventory_condition_filter2.rb → content_experiment_action_data_main_action.rb} +3 -16
- data/lib/klaviyo-api-sdk/models/countdown_timer_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/coupon_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/custom_css.rb +231 -0
- data/lib/klaviyo-api-sdk/models/custom_html.rb +292 -0
- data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +263 -0
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +450 -0
- data/lib/klaviyo-api-sdk/models/custom_object_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/custom_object_relationship_source.rb +328 -0
- data/lib/klaviyo-api-sdk/models/date_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/display_options.rb +24 -4
- data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/email_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +13 -9
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +13 -9
- data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object_attributes.rb +292 -0
- data/lib/klaviyo-api-sdk/models/embedded_object_schema_resource_object_attributes_source_mapping.rb +224 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +15 -2
- data/lib/klaviyo-api-sdk/models/events_bulk_create_query_resource_object_attributes.rb +14 -1
- data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter_condition_groups_inner_conditions_inner.rb +5 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_triggers_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_email.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +14 -4
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +15 -2
- data/lib/klaviyo-api-sdk/models/form_create_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/html_text_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen.rb +305 -0
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen_properties.rb +220 -0
- data/lib/klaviyo-api-sdk/models/image_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/image_block_cropping_properties.rb +0 -35
- data/lib/klaviyo-api-sdk/models/image_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/low_inventory_trigger.rb +2 -6
- data/lib/klaviyo-api-sdk/models/{low_inventory_condition_filter.rb → low_inventory_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{low_inventory_condition_condition_group.rb → low_inventory_trigger_trigger_filter_condition_groups_inner.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/metric_property_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter.rb +87 -195
- data/lib/klaviyo-api-sdk/models/metric_trigger.rb +2 -1
- data/lib/klaviyo-api-sdk/models/{flow_email_additional_filters.rb → metric_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{flow_email_additional_filters_condition_groups_inner.rb → metric_trigger_trigger_filter_condition_groups_inner.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/mobile_push_content_create.rb +18 -5
- data/lib/klaviyo-api-sdk/models/mobile_push_content_update.rb +18 -5
- data/lib/klaviyo-api-sdk/models/mobile_push_options_on_open.rb +2 -1
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter_condition_groups_inner_conditions_inner.rb +5 -0
- data/lib/klaviyo-api-sdk/models/object_record_bulk_delete_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{flow_push_notification_additional_filters_condition_groups_inner.rb → object_record_delete_job_create_query_resource_object_relationships.rb} +13 -15
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_create_query_resource_object_relationships_object_records.rb +220 -0
- data/lib/klaviyo-api-sdk/models/object_record_delete_job_rels_records_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/object_record_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_attributes.rb +322 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships_object_type.rb +218 -0
- data/lib/klaviyo-api-sdk/models/object_schema_create_query_resource_object_relationships_object_type_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/object_schema_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/object_schema_partial_update_query_resource_object_attributes.rb +302 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_create_meta.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{metric_property_condition_condition_group.rb → object_schema_relationship_create_query.rb} +14 -14
- data/lib/klaviyo-api-sdk/models/{flow_sms_additional_filters_condition_groups_inner.rb → object_schema_relationship_create_query_data_inner.rb} +37 -15
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_meta.rb +224 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_query.rb +225 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_delete_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_partial_update_query_data.rb +247 -0
- data/lib/klaviyo-api-sdk/models/object_schema_relationship_update_meta.rb +246 -0
- data/lib/klaviyo-api-sdk/models/object_type_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/object_type_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/object_type_create_query_resource_object_attributes.rb +307 -0
- data/lib/klaviyo-api-sdk/models/object_type_create_query_resource_object_attributes_object_schema.rb +224 -0
- data/lib/klaviyo-api-sdk/models/object_type_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_meta.rb +13 -4
- data/lib/klaviyo-api-sdk/models/open_tracking_subscription_parameters.rb +258 -0
- data/lib/klaviyo-api-sdk/models/open_tracking_unsubscription_parameters.rb +258 -0
- data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/patch_identifiers.rb +227 -0
- data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/price_drop_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/price_drop_trigger.rb +2 -6
- data/lib/klaviyo-api-sdk/models/{flow_sms_additional_filters.rb → price_drop_trigger_trigger_filter.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{price_drop_condition_condition_group.rb → price_drop_trigger_trigger_filter_condition_groups_inner.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +19 -9
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_email_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{profile_has_not_received_push_message_condition_timeframe_filter.rb → profile_has_not_received_email_message_condition_timeframe_filter.rb} +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_push_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_sms_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_meta.rb +13 -4
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_object_schema_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_create_query.rb +225 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_create_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_delete_query.rb +225 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_delete_query_data_inner.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/profile_object_schema_relationship_partial_update_query_data.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_relationship_source.rb +330 -0
- data/lib/klaviyo-api-sdk/models/property_filter.rb +237 -0
- data/lib/klaviyo-api-sdk/models/property_source.rb +254 -0
- data/lib/klaviyo-api-sdk/models/push_action_button.rb +1 -5
- data/lib/klaviyo-api-sdk/models/push_action_button_definition.rb +261 -0
- data/lib/klaviyo-api-sdk/models/push_on_open_web_url.rb +268 -0
- data/lib/klaviyo-api-sdk/models/quote_style.rb +21 -1
- data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/redirect_properties.rb +2 -5
- data/lib/klaviyo-api-sdk/models/related_id_path.rb +273 -0
- data/lib/klaviyo-api-sdk/models/review_block_styles.rb +13 -13
- data/lib/klaviyo-api-sdk/models/review_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/reviewer_name_style.rb +21 -1
- data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/signup_counter_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/simple_property_mapping.rb +287 -0
- data/lib/klaviyo-api-sdk/models/simple_relationship_mapping.rb +287 -0
- data/lib/klaviyo-api-sdk/models/simple_relationship_mapping_source.rb +105 -0
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_link_text_style.rb +319 -0
- data/lib/klaviyo-api-sdk/models/sms_disclosure_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_styles.rb +1 -1
- data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_create_query_resource_object_attributes_property_mappings_inner.rb +104 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/source_mapping_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/string_phone_operator_string_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/table_fallback_image_sub_block.rb +0 -13
- data/lib/klaviyo-api-sdk/models/table_image_sub_block.rb +0 -13
- data/lib/klaviyo-api-sdk/models/template_definition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/text_properties.rb +11 -1
- data/lib/klaviyo-api-sdk/models/version.rb +39 -4
- data/lib/klaviyo-api-sdk/models/version_properties.rb +14 -4
- data/lib/klaviyo-api-sdk/models/version_styles.rb +15 -6
- data/lib/klaviyo-api-sdk/models/version_triggers_inner.rb +1 -0
- data/lib/klaviyo-api-sdk.rb +86 -23
- data/lib/klaviyo-api-sdk.rb.bak +87 -24
- metadata +88 -25
- data/lib/klaviyo-api-sdk/models/custom_object_property_condition_filter.rb +0 -117
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
- data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +0 -116
- data/lib/klaviyo-api-sdk/models/metric_property_condition_filter2.rb +0 -117
- data/lib/klaviyo-api-sdk/models/price_drop_condition_filter.rb +0 -225
data/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# Klaviyo Ruby SDK
|
|
2
2
|
|
|
3
|
-
- SDK version:
|
|
4
|
-
- API revision: 2026-
|
|
3
|
+
- SDK version: 18.0.0
|
|
4
|
+
- API revision: 2026-07-15
|
|
5
5
|
|
|
6
6
|
## Helpful Resources
|
|
7
7
|
|
|
8
|
-
- [API Reference](https://developers.klaviyo.com/en/v2026-
|
|
9
|
-
- [API Guides](https://developers.klaviyo.com/en/v2026-
|
|
8
|
+
- [API Reference](https://developers.klaviyo.com/en/v2026-07-15/reference)
|
|
9
|
+
- [API Guides](https://developers.klaviyo.com/en/v2026-07-15/docs)
|
|
10
10
|
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)
|
|
11
11
|
|
|
12
12
|
## Design & Approach
|
|
@@ -31,6 +31,10 @@ This SDK is organized into the following resources:
|
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
|
|
34
|
+
- Client
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
34
38
|
- Conversations
|
|
35
39
|
|
|
36
40
|
|
|
@@ -122,13 +126,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
|
122
126
|
Then install the gem locally:
|
|
123
127
|
|
|
124
128
|
```shell
|
|
125
|
-
gem install ./klaviyo-api-sdk-
|
|
129
|
+
gem install ./klaviyo-api-sdk-18.0.0.gem
|
|
126
130
|
```
|
|
127
131
|
|
|
128
132
|
|
|
129
133
|
Finally add this to the Gemfile:
|
|
130
134
|
|
|
131
|
-
gem 'klaviyo-api-sdk', '~>
|
|
135
|
+
gem 'klaviyo-api-sdk', '~> 18.0.0'
|
|
132
136
|
|
|
133
137
|
To install directly from rubygems:
|
|
134
138
|
|
|
@@ -522,7 +526,7 @@ response = KlaviyoAPI::Events.get_events(opts)
|
|
|
522
526
|
## Comprehensive list of Operations & Parameters
|
|
523
527
|
|
|
524
528
|
_**NOTE:**_
|
|
525
|
-
- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2026-
|
|
529
|
+
- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2026-07-15/reference/get_events).
|
|
526
530
|
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
|
527
531
|
- Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.
|
|
528
532
|
|
|
@@ -534,7 +538,7 @@ _**NOTE:**_
|
|
|
534
538
|
## Accounts
|
|
535
539
|
|
|
536
540
|
|
|
537
|
-
#### [Get Account](https://developers.klaviyo.com/en/v2026-
|
|
541
|
+
#### [Get Account](https://developers.klaviyo.com/en/v2026-07-15/reference/get_account)
|
|
538
542
|
|
|
539
543
|
```ruby
|
|
540
544
|
KlaviyoAPI::Accounts.get_account(id, opts)
|
|
@@ -544,7 +548,7 @@ KlaviyoAPI::Accounts.get_account(id, opts)
|
|
|
544
548
|
|
|
545
549
|
|
|
546
550
|
|
|
547
|
-
#### [Get Accounts](https://developers.klaviyo.com/en/v2026-
|
|
551
|
+
#### [Get Accounts](https://developers.klaviyo.com/en/v2026-07-15/reference/get_accounts)
|
|
548
552
|
|
|
549
553
|
```ruby
|
|
550
554
|
KlaviyoAPI::Accounts.get_accounts(opts)
|
|
@@ -558,21 +562,21 @@ KlaviyoAPI::Accounts.get_accounts(opts)
|
|
|
558
562
|
## Campaigns
|
|
559
563
|
|
|
560
564
|
|
|
561
|
-
#### [Assign Template to Campaign Message](https://developers.klaviyo.com/en/v2026-
|
|
565
|
+
#### [Assign Template to Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/assign_template_to_campaign_message)
|
|
562
566
|
|
|
563
567
|
```ruby
|
|
564
|
-
KlaviyoAPI::Campaigns.assign_template_to_campaign_message(body)
|
|
568
|
+
KlaviyoAPI::Campaigns.assign_template_to_campaign_message(body, opts)
|
|
565
569
|
```
|
|
566
570
|
##### Method alias:
|
|
567
571
|
```ruby
|
|
568
|
-
KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
|
|
572
|
+
KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body, opts)
|
|
569
573
|
```
|
|
570
574
|
|
|
571
575
|
|
|
572
576
|
|
|
573
577
|
|
|
574
578
|
|
|
575
|
-
#### [Cancel Campaign Send](https://developers.klaviyo.com/en/v2026-
|
|
579
|
+
#### [Cancel Campaign Send](https://developers.klaviyo.com/en/v2026-07-15/reference/cancel_campaign_send)
|
|
576
580
|
|
|
577
581
|
```ruby
|
|
578
582
|
KlaviyoAPI::Campaigns.cancel_campaign_send(id, body)
|
|
@@ -586,31 +590,31 @@ KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
|
|
|
586
590
|
|
|
587
591
|
|
|
588
592
|
|
|
589
|
-
#### [Create Campaign](https://developers.klaviyo.com/en/v2026-
|
|
593
|
+
#### [Create Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/create_campaign)
|
|
590
594
|
|
|
591
595
|
```ruby
|
|
592
|
-
KlaviyoAPI::Campaigns.create_campaign(body)
|
|
596
|
+
KlaviyoAPI::Campaigns.create_campaign(body, opts)
|
|
593
597
|
```
|
|
594
598
|
|
|
595
599
|
|
|
596
600
|
|
|
597
601
|
|
|
598
602
|
|
|
599
|
-
#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2026-
|
|
603
|
+
#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2026-07-15/reference/create_campaign_clone)
|
|
600
604
|
|
|
601
605
|
```ruby
|
|
602
|
-
KlaviyoAPI::Campaigns.create_campaign_clone(body)
|
|
606
|
+
KlaviyoAPI::Campaigns.create_campaign_clone(body, opts)
|
|
603
607
|
```
|
|
604
608
|
##### Method alias:
|
|
605
609
|
```ruby
|
|
606
|
-
KlaviyoAPI::Campaigns.clone_campaign(body)
|
|
610
|
+
KlaviyoAPI::Campaigns.clone_campaign(body, opts)
|
|
607
611
|
```
|
|
608
612
|
|
|
609
613
|
|
|
610
614
|
|
|
611
615
|
|
|
612
616
|
|
|
613
|
-
#### [Delete Campaign](https://developers.klaviyo.com/en/v2026-
|
|
617
|
+
#### [Delete Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_campaign)
|
|
614
618
|
|
|
615
619
|
```ruby
|
|
616
620
|
KlaviyoAPI::Campaigns.delete_campaign(id)
|
|
@@ -620,7 +624,7 @@ KlaviyoAPI::Campaigns.delete_campaign(id)
|
|
|
620
624
|
|
|
621
625
|
|
|
622
626
|
|
|
623
|
-
#### [Get Campaign](https://developers.klaviyo.com/en/v2026-
|
|
627
|
+
#### [Get Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign)
|
|
624
628
|
|
|
625
629
|
```ruby
|
|
626
630
|
KlaviyoAPI::Campaigns.get_campaign(id, opts)
|
|
@@ -630,7 +634,7 @@ KlaviyoAPI::Campaigns.get_campaign(id, opts)
|
|
|
630
634
|
|
|
631
635
|
|
|
632
636
|
|
|
633
|
-
#### [Get Campaign for Campaign Message](https://developers.klaviyo.com/en/v2026-
|
|
637
|
+
#### [Get Campaign for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_for_campaign_message)
|
|
634
638
|
|
|
635
639
|
```ruby
|
|
636
640
|
KlaviyoAPI::Campaigns.get_campaign_for_campaign_message(id, opts)
|
|
@@ -644,7 +648,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_campaign(id, opts)
|
|
|
644
648
|
|
|
645
649
|
|
|
646
650
|
|
|
647
|
-
#### [Get Campaign ID for Campaign Message](https://developers.klaviyo.com/en/v2026-
|
|
651
|
+
#### [Get Campaign ID for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_id_for_campaign_message)
|
|
648
652
|
|
|
649
653
|
```ruby
|
|
650
654
|
KlaviyoAPI::Campaigns.get_campaign_id_for_campaign_message(id)
|
|
@@ -658,7 +662,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_relationships_campaign(id)
|
|
|
658
662
|
|
|
659
663
|
|
|
660
664
|
|
|
661
|
-
#### [Get Campaign Message](https://developers.klaviyo.com/en/v2026-
|
|
665
|
+
#### [Get Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_message)
|
|
662
666
|
|
|
663
667
|
```ruby
|
|
664
668
|
KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
|
|
@@ -668,7 +672,7 @@ KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
|
|
|
668
672
|
|
|
669
673
|
|
|
670
674
|
|
|
671
|
-
#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2026-
|
|
675
|
+
#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_recipient_estimation)
|
|
672
676
|
|
|
673
677
|
```ruby
|
|
674
678
|
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
|
|
@@ -678,7 +682,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
|
|
|
678
682
|
|
|
679
683
|
|
|
680
684
|
|
|
681
|
-
#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2026-
|
|
685
|
+
#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_recipient_estimation_job)
|
|
682
686
|
|
|
683
687
|
```ruby
|
|
684
688
|
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
|
|
@@ -688,7 +692,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
|
|
|
688
692
|
|
|
689
693
|
|
|
690
694
|
|
|
691
|
-
#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2026-
|
|
695
|
+
#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_send_job)
|
|
692
696
|
|
|
693
697
|
```ruby
|
|
694
698
|
KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
|
@@ -698,7 +702,7 @@ KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
|
|
698
702
|
|
|
699
703
|
|
|
700
704
|
|
|
701
|
-
#### [Get Campaigns](https://developers.klaviyo.com/en/v2026-
|
|
705
|
+
#### [Get Campaigns](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaigns)
|
|
702
706
|
|
|
703
707
|
```ruby
|
|
704
708
|
KlaviyoAPI::Campaigns.get_campaigns(filter, opts)
|
|
@@ -708,7 +712,7 @@ KlaviyoAPI::Campaigns.get_campaigns(filter, opts)
|
|
|
708
712
|
|
|
709
713
|
|
|
710
714
|
|
|
711
|
-
#### [Get Image for Campaign Message](https://developers.klaviyo.com/en/v2026-
|
|
715
|
+
#### [Get Image for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_image_for_campaign_message)
|
|
712
716
|
|
|
713
717
|
```ruby
|
|
714
718
|
KlaviyoAPI::Campaigns.get_image_for_campaign_message(id, opts)
|
|
@@ -722,7 +726,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_image(id, opts)
|
|
|
722
726
|
|
|
723
727
|
|
|
724
728
|
|
|
725
|
-
#### [Get Image ID for Campaign Message](https://developers.klaviyo.com/en/v2026-
|
|
729
|
+
#### [Get Image ID for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_image_id_for_campaign_message)
|
|
726
730
|
|
|
727
731
|
```ruby
|
|
728
732
|
KlaviyoAPI::Campaigns.get_image_id_for_campaign_message(id)
|
|
@@ -736,7 +740,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_relationships_image(id)
|
|
|
736
740
|
|
|
737
741
|
|
|
738
742
|
|
|
739
|
-
#### [Get Message IDs for Campaign](https://developers.klaviyo.com/en/v2026-
|
|
743
|
+
#### [Get Message IDs for Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/get_message_ids_for_campaign)
|
|
740
744
|
|
|
741
745
|
```ruby
|
|
742
746
|
KlaviyoAPI::Campaigns.get_message_ids_for_campaign(id)
|
|
@@ -754,7 +758,7 @@ KlaviyoAPI::Campaigns.get_campaign_relationships_messages(id)
|
|
|
754
758
|
|
|
755
759
|
|
|
756
760
|
|
|
757
|
-
#### [Get Messages for Campaign](https://developers.klaviyo.com/en/v2026-
|
|
761
|
+
#### [Get Messages for Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/get_messages_for_campaign)
|
|
758
762
|
|
|
759
763
|
```ruby
|
|
760
764
|
KlaviyoAPI::Campaigns.get_messages_for_campaign(id, opts)
|
|
@@ -772,7 +776,7 @@ KlaviyoAPI::Campaigns.get_campaign_messages(id, opts)
|
|
|
772
776
|
|
|
773
777
|
|
|
774
778
|
|
|
775
|
-
#### [Get Tag IDs for Campaign](https://developers.klaviyo.com/en/v2026-
|
|
779
|
+
#### [Get Tag IDs for Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_ids_for_campaign)
|
|
776
780
|
|
|
777
781
|
```ruby
|
|
778
782
|
KlaviyoAPI::Campaigns.get_tag_ids_for_campaign(id)
|
|
@@ -786,7 +790,7 @@ KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
|
|
|
786
790
|
|
|
787
791
|
|
|
788
792
|
|
|
789
|
-
#### [Get Tags for Campaign](https://developers.klaviyo.com/en/v2026-
|
|
793
|
+
#### [Get Tags for Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tags_for_campaign)
|
|
790
794
|
|
|
791
795
|
```ruby
|
|
792
796
|
KlaviyoAPI::Campaigns.get_tags_for_campaign(id, opts)
|
|
@@ -800,7 +804,7 @@ KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
|
|
|
800
804
|
|
|
801
805
|
|
|
802
806
|
|
|
803
|
-
#### [Get Template for Campaign Message](https://developers.klaviyo.com/en/v2026-
|
|
807
|
+
#### [Get Template for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_template_for_campaign_message)
|
|
804
808
|
|
|
805
809
|
```ruby
|
|
806
810
|
KlaviyoAPI::Campaigns.get_template_for_campaign_message(id, opts)
|
|
@@ -814,7 +818,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_template(id, opts)
|
|
|
814
818
|
|
|
815
819
|
|
|
816
820
|
|
|
817
|
-
#### [Get Template ID for Campaign Message](https://developers.klaviyo.com/en/v2026-
|
|
821
|
+
#### [Get Template ID for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_template_id_for_campaign_message)
|
|
818
822
|
|
|
819
823
|
```ruby
|
|
820
824
|
KlaviyoAPI::Campaigns.get_template_id_for_campaign_message(id)
|
|
@@ -828,55 +832,55 @@ KlaviyoAPI::Campaigns.get_campaign_message_relationships_template(id)
|
|
|
828
832
|
|
|
829
833
|
|
|
830
834
|
|
|
831
|
-
#### [Refresh Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2026-
|
|
835
|
+
#### [Refresh Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2026-07-15/reference/refresh_campaign_recipient_estimation)
|
|
832
836
|
|
|
833
837
|
```ruby
|
|
834
|
-
KlaviyoAPI::Campaigns.refresh_campaign_recipient_estimation(body)
|
|
838
|
+
KlaviyoAPI::Campaigns.refresh_campaign_recipient_estimation(body, opts)
|
|
835
839
|
```
|
|
836
840
|
##### Method alias:
|
|
837
841
|
```ruby
|
|
838
|
-
KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
|
|
842
|
+
KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body, opts)
|
|
839
843
|
```
|
|
840
844
|
|
|
841
845
|
|
|
842
846
|
|
|
843
847
|
|
|
844
848
|
|
|
845
|
-
#### [Send Campaign](https://developers.klaviyo.com/en/v2026-
|
|
849
|
+
#### [Send Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/send_campaign)
|
|
846
850
|
|
|
847
851
|
```ruby
|
|
848
|
-
KlaviyoAPI::Campaigns.send_campaign(body)
|
|
852
|
+
KlaviyoAPI::Campaigns.send_campaign(body, opts)
|
|
849
853
|
```
|
|
850
854
|
##### Method alias:
|
|
851
855
|
```ruby
|
|
852
|
-
KlaviyoAPI::Campaigns.create_campaign_send_job(body)
|
|
856
|
+
KlaviyoAPI::Campaigns.create_campaign_send_job(body, opts)
|
|
853
857
|
```
|
|
854
858
|
|
|
855
859
|
|
|
856
860
|
|
|
857
861
|
|
|
858
862
|
|
|
859
|
-
#### [Update Campaign](https://developers.klaviyo.com/en/v2026-
|
|
863
|
+
#### [Update Campaign](https://developers.klaviyo.com/en/v2026-07-15/reference/update_campaign)
|
|
860
864
|
|
|
861
865
|
```ruby
|
|
862
|
-
KlaviyoAPI::Campaigns.update_campaign(id, body)
|
|
866
|
+
KlaviyoAPI::Campaigns.update_campaign(id, body, opts)
|
|
863
867
|
```
|
|
864
868
|
|
|
865
869
|
|
|
866
870
|
|
|
867
871
|
|
|
868
872
|
|
|
869
|
-
#### [Update Campaign Message](https://developers.klaviyo.com/en/v2026-
|
|
873
|
+
#### [Update Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/update_campaign_message)
|
|
870
874
|
|
|
871
875
|
```ruby
|
|
872
|
-
KlaviyoAPI::Campaigns.update_campaign_message(id, body)
|
|
876
|
+
KlaviyoAPI::Campaigns.update_campaign_message(id, body, opts)
|
|
873
877
|
```
|
|
874
878
|
|
|
875
879
|
|
|
876
880
|
|
|
877
881
|
|
|
878
882
|
|
|
879
|
-
#### [Update Image for Campaign Message](https://developers.klaviyo.com/en/v2026-
|
|
883
|
+
#### [Update Image for Campaign Message](https://developers.klaviyo.com/en/v2026-07-15/reference/update_image_for_campaign_message)
|
|
880
884
|
|
|
881
885
|
```ruby
|
|
882
886
|
KlaviyoAPI::Campaigns.update_image_for_campaign_message(id, body)
|
|
@@ -894,7 +898,7 @@ KlaviyoAPI::Campaigns.update_campaign_message_relationships_image(id, body)
|
|
|
894
898
|
## Catalogs
|
|
895
899
|
|
|
896
900
|
|
|
897
|
-
#### [Add Categories to Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
901
|
+
#### [Add Categories to Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/add_categories_to_catalog_item)
|
|
898
902
|
|
|
899
903
|
```ruby
|
|
900
904
|
KlaviyoAPI::Catalogs.add_categories_to_catalog_item(id, body)
|
|
@@ -916,7 +920,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
|
|
|
916
920
|
|
|
917
921
|
|
|
918
922
|
|
|
919
|
-
#### [Add Items to Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
923
|
+
#### [Add Items to Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/add_items_to_catalog_category)
|
|
920
924
|
|
|
921
925
|
```ruby
|
|
922
926
|
KlaviyoAPI::Catalogs.add_items_to_catalog_category(id, body)
|
|
@@ -934,169 +938,169 @@ KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
|
|
|
934
938
|
|
|
935
939
|
|
|
936
940
|
|
|
937
|
-
#### [Bulk Create Catalog Categories](https://developers.klaviyo.com/en/v2026-
|
|
941
|
+
#### [Bulk Create Catalog Categories](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_create_catalog_categories)
|
|
938
942
|
|
|
939
943
|
```ruby
|
|
940
|
-
KlaviyoAPI::Catalogs.bulk_create_catalog_categories(body)
|
|
944
|
+
KlaviyoAPI::Catalogs.bulk_create_catalog_categories(body, opts)
|
|
941
945
|
```
|
|
942
946
|
##### Method alias:
|
|
943
947
|
```ruby
|
|
944
|
-
KlaviyoAPI::Catalogs.spawn_create_categories_job(body)
|
|
948
|
+
KlaviyoAPI::Catalogs.spawn_create_categories_job(body, opts)
|
|
945
949
|
```
|
|
946
950
|
##### Method alias:
|
|
947
951
|
```ruby
|
|
948
|
-
KlaviyoAPI::Catalogs.create_catalog_category_bulk_create_job(body)
|
|
952
|
+
KlaviyoAPI::Catalogs.create_catalog_category_bulk_create_job(body, opts)
|
|
949
953
|
```
|
|
950
954
|
|
|
951
955
|
|
|
952
956
|
|
|
953
957
|
|
|
954
958
|
|
|
955
|
-
#### [Bulk Create Catalog Items](https://developers.klaviyo.com/en/v2026-
|
|
959
|
+
#### [Bulk Create Catalog Items](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_create_catalog_items)
|
|
956
960
|
|
|
957
961
|
```ruby
|
|
958
|
-
KlaviyoAPI::Catalogs.bulk_create_catalog_items(body)
|
|
962
|
+
KlaviyoAPI::Catalogs.bulk_create_catalog_items(body, opts)
|
|
959
963
|
```
|
|
960
964
|
##### Method alias:
|
|
961
965
|
```ruby
|
|
962
|
-
KlaviyoAPI::Catalogs.spawn_create_items_job(body)
|
|
966
|
+
KlaviyoAPI::Catalogs.spawn_create_items_job(body, opts)
|
|
963
967
|
```
|
|
964
968
|
##### Method alias:
|
|
965
969
|
```ruby
|
|
966
|
-
KlaviyoAPI::Catalogs.create_catalog_item_bulk_create_job(body)
|
|
970
|
+
KlaviyoAPI::Catalogs.create_catalog_item_bulk_create_job(body, opts)
|
|
967
971
|
```
|
|
968
972
|
|
|
969
973
|
|
|
970
974
|
|
|
971
975
|
|
|
972
976
|
|
|
973
|
-
#### [Bulk Create Catalog Variants](https://developers.klaviyo.com/en/v2026-
|
|
977
|
+
#### [Bulk Create Catalog Variants](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_create_catalog_variants)
|
|
974
978
|
|
|
975
979
|
```ruby
|
|
976
|
-
KlaviyoAPI::Catalogs.bulk_create_catalog_variants(body)
|
|
980
|
+
KlaviyoAPI::Catalogs.bulk_create_catalog_variants(body, opts)
|
|
977
981
|
```
|
|
978
982
|
##### Method alias:
|
|
979
983
|
```ruby
|
|
980
|
-
KlaviyoAPI::Catalogs.spawn_create_variants_job(body)
|
|
984
|
+
KlaviyoAPI::Catalogs.spawn_create_variants_job(body, opts)
|
|
981
985
|
```
|
|
982
986
|
##### Method alias:
|
|
983
987
|
```ruby
|
|
984
|
-
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_create_job(body)
|
|
988
|
+
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_create_job(body, opts)
|
|
985
989
|
```
|
|
986
990
|
|
|
987
991
|
|
|
988
992
|
|
|
989
993
|
|
|
990
994
|
|
|
991
|
-
#### [Bulk Delete Catalog Categories](https://developers.klaviyo.com/en/v2026-
|
|
995
|
+
#### [Bulk Delete Catalog Categories](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_delete_catalog_categories)
|
|
992
996
|
|
|
993
997
|
```ruby
|
|
994
|
-
KlaviyoAPI::Catalogs.bulk_delete_catalog_categories(body)
|
|
998
|
+
KlaviyoAPI::Catalogs.bulk_delete_catalog_categories(body, opts)
|
|
995
999
|
```
|
|
996
1000
|
##### Method alias:
|
|
997
1001
|
```ruby
|
|
998
|
-
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body)
|
|
1002
|
+
KlaviyoAPI::Catalogs.spawn_delete_categories_job(body, opts)
|
|
999
1003
|
```
|
|
1000
1004
|
##### Method alias:
|
|
1001
1005
|
```ruby
|
|
1002
|
-
KlaviyoAPI::Catalogs.create_catalog_category_bulk_delete_job(body)
|
|
1006
|
+
KlaviyoAPI::Catalogs.create_catalog_category_bulk_delete_job(body, opts)
|
|
1003
1007
|
```
|
|
1004
1008
|
|
|
1005
1009
|
|
|
1006
1010
|
|
|
1007
1011
|
|
|
1008
1012
|
|
|
1009
|
-
#### [Bulk Delete Catalog Items](https://developers.klaviyo.com/en/v2026-
|
|
1013
|
+
#### [Bulk Delete Catalog Items](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_delete_catalog_items)
|
|
1010
1014
|
|
|
1011
1015
|
```ruby
|
|
1012
|
-
KlaviyoAPI::Catalogs.bulk_delete_catalog_items(body)
|
|
1016
|
+
KlaviyoAPI::Catalogs.bulk_delete_catalog_items(body, opts)
|
|
1013
1017
|
```
|
|
1014
1018
|
##### Method alias:
|
|
1015
1019
|
```ruby
|
|
1016
|
-
KlaviyoAPI::Catalogs.spawn_delete_items_job(body)
|
|
1020
|
+
KlaviyoAPI::Catalogs.spawn_delete_items_job(body, opts)
|
|
1017
1021
|
```
|
|
1018
1022
|
##### Method alias:
|
|
1019
1023
|
```ruby
|
|
1020
|
-
KlaviyoAPI::Catalogs.create_catalog_item_bulk_delete_job(body)
|
|
1024
|
+
KlaviyoAPI::Catalogs.create_catalog_item_bulk_delete_job(body, opts)
|
|
1021
1025
|
```
|
|
1022
1026
|
|
|
1023
1027
|
|
|
1024
1028
|
|
|
1025
1029
|
|
|
1026
1030
|
|
|
1027
|
-
#### [Bulk Delete Catalog Variants](https://developers.klaviyo.com/en/v2026-
|
|
1031
|
+
#### [Bulk Delete Catalog Variants](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_delete_catalog_variants)
|
|
1028
1032
|
|
|
1029
1033
|
```ruby
|
|
1030
|
-
KlaviyoAPI::Catalogs.bulk_delete_catalog_variants(body)
|
|
1034
|
+
KlaviyoAPI::Catalogs.bulk_delete_catalog_variants(body, opts)
|
|
1031
1035
|
```
|
|
1032
1036
|
##### Method alias:
|
|
1033
1037
|
```ruby
|
|
1034
|
-
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body)
|
|
1038
|
+
KlaviyoAPI::Catalogs.spawn_delete_variants_job(body, opts)
|
|
1035
1039
|
```
|
|
1036
1040
|
##### Method alias:
|
|
1037
1041
|
```ruby
|
|
1038
|
-
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_delete_job(body)
|
|
1042
|
+
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_delete_job(body, opts)
|
|
1039
1043
|
```
|
|
1040
1044
|
|
|
1041
1045
|
|
|
1042
1046
|
|
|
1043
1047
|
|
|
1044
1048
|
|
|
1045
|
-
#### [Bulk Update Catalog Categories](https://developers.klaviyo.com/en/v2026-
|
|
1049
|
+
#### [Bulk Update Catalog Categories](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_update_catalog_categories)
|
|
1046
1050
|
|
|
1047
1051
|
```ruby
|
|
1048
|
-
KlaviyoAPI::Catalogs.bulk_update_catalog_categories(body)
|
|
1052
|
+
KlaviyoAPI::Catalogs.bulk_update_catalog_categories(body, opts)
|
|
1049
1053
|
```
|
|
1050
1054
|
##### Method alias:
|
|
1051
1055
|
```ruby
|
|
1052
|
-
KlaviyoAPI::Catalogs.spawn_update_categories_job(body)
|
|
1056
|
+
KlaviyoAPI::Catalogs.spawn_update_categories_job(body, opts)
|
|
1053
1057
|
```
|
|
1054
1058
|
##### Method alias:
|
|
1055
1059
|
```ruby
|
|
1056
|
-
KlaviyoAPI::Catalogs.create_catalog_category_bulk_update_job(body)
|
|
1060
|
+
KlaviyoAPI::Catalogs.create_catalog_category_bulk_update_job(body, opts)
|
|
1057
1061
|
```
|
|
1058
1062
|
|
|
1059
1063
|
|
|
1060
1064
|
|
|
1061
1065
|
|
|
1062
1066
|
|
|
1063
|
-
#### [Bulk Update Catalog Items](https://developers.klaviyo.com/en/v2026-
|
|
1067
|
+
#### [Bulk Update Catalog Items](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_update_catalog_items)
|
|
1064
1068
|
|
|
1065
1069
|
```ruby
|
|
1066
|
-
KlaviyoAPI::Catalogs.bulk_update_catalog_items(body)
|
|
1070
|
+
KlaviyoAPI::Catalogs.bulk_update_catalog_items(body, opts)
|
|
1067
1071
|
```
|
|
1068
1072
|
##### Method alias:
|
|
1069
1073
|
```ruby
|
|
1070
|
-
KlaviyoAPI::Catalogs.spawn_update_items_job(body)
|
|
1074
|
+
KlaviyoAPI::Catalogs.spawn_update_items_job(body, opts)
|
|
1071
1075
|
```
|
|
1072
1076
|
##### Method alias:
|
|
1073
1077
|
```ruby
|
|
1074
|
-
KlaviyoAPI::Catalogs.create_catalog_item_bulk_update_job(body)
|
|
1078
|
+
KlaviyoAPI::Catalogs.create_catalog_item_bulk_update_job(body, opts)
|
|
1075
1079
|
```
|
|
1076
1080
|
|
|
1077
1081
|
|
|
1078
1082
|
|
|
1079
1083
|
|
|
1080
1084
|
|
|
1081
|
-
#### [Bulk Update Catalog Variants](https://developers.klaviyo.com/en/v2026-
|
|
1085
|
+
#### [Bulk Update Catalog Variants](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_update_catalog_variants)
|
|
1082
1086
|
|
|
1083
1087
|
```ruby
|
|
1084
|
-
KlaviyoAPI::Catalogs.bulk_update_catalog_variants(body)
|
|
1088
|
+
KlaviyoAPI::Catalogs.bulk_update_catalog_variants(body, opts)
|
|
1085
1089
|
```
|
|
1086
1090
|
##### Method alias:
|
|
1087
1091
|
```ruby
|
|
1088
|
-
KlaviyoAPI::Catalogs.spawn_update_variants_job(body)
|
|
1092
|
+
KlaviyoAPI::Catalogs.spawn_update_variants_job(body, opts)
|
|
1089
1093
|
```
|
|
1090
1094
|
##### Method alias:
|
|
1091
1095
|
```ruby
|
|
1092
|
-
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_update_job(body)
|
|
1096
|
+
KlaviyoAPI::Catalogs.create_catalog_variant_bulk_update_job(body, opts)
|
|
1093
1097
|
```
|
|
1094
1098
|
|
|
1095
1099
|
|
|
1096
1100
|
|
|
1097
1101
|
|
|
1098
1102
|
|
|
1099
|
-
#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2026-
|
|
1103
|
+
#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2026-07-15/reference/create_back_in_stock_subscription)
|
|
1100
1104
|
|
|
1101
1105
|
```ruby
|
|
1102
1106
|
KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
|
|
@@ -1106,37 +1110,37 @@ KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
|
|
|
1106
1110
|
|
|
1107
1111
|
|
|
1108
1112
|
|
|
1109
|
-
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
1113
|
+
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/create_catalog_category)
|
|
1110
1114
|
|
|
1111
1115
|
```ruby
|
|
1112
|
-
KlaviyoAPI::Catalogs.create_catalog_category(body)
|
|
1116
|
+
KlaviyoAPI::Catalogs.create_catalog_category(body, opts)
|
|
1113
1117
|
```
|
|
1114
1118
|
|
|
1115
1119
|
|
|
1116
1120
|
|
|
1117
1121
|
|
|
1118
1122
|
|
|
1119
|
-
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1123
|
+
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/create_catalog_item)
|
|
1120
1124
|
|
|
1121
1125
|
```ruby
|
|
1122
|
-
KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
1126
|
+
KlaviyoAPI::Catalogs.create_catalog_item(body, opts)
|
|
1123
1127
|
```
|
|
1124
1128
|
|
|
1125
1129
|
|
|
1126
1130
|
|
|
1127
1131
|
|
|
1128
1132
|
|
|
1129
|
-
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2026-
|
|
1133
|
+
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2026-07-15/reference/create_catalog_variant)
|
|
1130
1134
|
|
|
1131
1135
|
```ruby
|
|
1132
|
-
KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
|
1136
|
+
KlaviyoAPI::Catalogs.create_catalog_variant(body, opts)
|
|
1133
1137
|
```
|
|
1134
1138
|
|
|
1135
1139
|
|
|
1136
1140
|
|
|
1137
1141
|
|
|
1138
1142
|
|
|
1139
|
-
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
1143
|
+
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_catalog_category)
|
|
1140
1144
|
|
|
1141
1145
|
```ruby
|
|
1142
1146
|
KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
|
@@ -1146,7 +1150,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
|
|
1146
1150
|
|
|
1147
1151
|
|
|
1148
1152
|
|
|
1149
|
-
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1153
|
+
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_catalog_item)
|
|
1150
1154
|
|
|
1151
1155
|
```ruby
|
|
1152
1156
|
KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
|
@@ -1156,7 +1160,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
|
|
1156
1160
|
|
|
1157
1161
|
|
|
1158
1162
|
|
|
1159
|
-
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2026-
|
|
1163
|
+
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_catalog_variant)
|
|
1160
1164
|
|
|
1161
1165
|
```ruby
|
|
1162
1166
|
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
|
@@ -1166,7 +1170,7 @@ KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
|
|
1166
1170
|
|
|
1167
1171
|
|
|
1168
1172
|
|
|
1169
|
-
#### [Get Bulk Create Catalog Items Job](https://developers.klaviyo.com/en/v2026-
|
|
1173
|
+
#### [Get Bulk Create Catalog Items Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_catalog_items_job)
|
|
1170
1174
|
|
|
1171
1175
|
```ruby
|
|
1172
1176
|
KlaviyoAPI::Catalogs.get_bulk_create_catalog_items_job(job_id, opts)
|
|
@@ -1184,7 +1188,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_job(job_id, opts)
|
|
|
1184
1188
|
|
|
1185
1189
|
|
|
1186
1190
|
|
|
1187
|
-
#### [Get Bulk Create Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1191
|
+
#### [Get Bulk Create Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_catalog_items_jobs)
|
|
1188
1192
|
|
|
1189
1193
|
```ruby
|
|
1190
1194
|
KlaviyoAPI::Catalogs.get_bulk_create_catalog_items_jobs(opts)
|
|
@@ -1202,7 +1206,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_jobs(opts)
|
|
|
1202
1206
|
|
|
1203
1207
|
|
|
1204
1208
|
|
|
1205
|
-
#### [Get Bulk Create Categories Job](https://developers.klaviyo.com/en/v2026-
|
|
1209
|
+
#### [Get Bulk Create Categories Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_categories_job)
|
|
1206
1210
|
|
|
1207
1211
|
```ruby
|
|
1208
1212
|
KlaviyoAPI::Catalogs.get_bulk_create_categories_job(job_id, opts)
|
|
@@ -1220,7 +1224,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_job(job_id, opts)
|
|
|
1220
1224
|
|
|
1221
1225
|
|
|
1222
1226
|
|
|
1223
|
-
#### [Get Bulk Create Categories Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1227
|
+
#### [Get Bulk Create Categories Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_categories_jobs)
|
|
1224
1228
|
|
|
1225
1229
|
```ruby
|
|
1226
1230
|
KlaviyoAPI::Catalogs.get_bulk_create_categories_jobs(opts)
|
|
@@ -1238,7 +1242,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_jobs(opts)
|
|
|
1238
1242
|
|
|
1239
1243
|
|
|
1240
1244
|
|
|
1241
|
-
#### [Get Bulk Create Variants Job](https://developers.klaviyo.com/en/v2026-
|
|
1245
|
+
#### [Get Bulk Create Variants Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_variants_job)
|
|
1242
1246
|
|
|
1243
1247
|
```ruby
|
|
1244
1248
|
KlaviyoAPI::Catalogs.get_bulk_create_variants_job(job_id, opts)
|
|
@@ -1256,7 +1260,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_job(job_id, opts)
|
|
|
1256
1260
|
|
|
1257
1261
|
|
|
1258
1262
|
|
|
1259
|
-
#### [Get Bulk Create Variants Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1263
|
+
#### [Get Bulk Create Variants Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_variants_jobs)
|
|
1260
1264
|
|
|
1261
1265
|
```ruby
|
|
1262
1266
|
KlaviyoAPI::Catalogs.get_bulk_create_variants_jobs(opts)
|
|
@@ -1274,7 +1278,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_jobs(opts)
|
|
|
1274
1278
|
|
|
1275
1279
|
|
|
1276
1280
|
|
|
1277
|
-
#### [Get Bulk Delete Catalog Items Job](https://developers.klaviyo.com/en/v2026-
|
|
1281
|
+
#### [Get Bulk Delete Catalog Items Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_delete_catalog_items_job)
|
|
1278
1282
|
|
|
1279
1283
|
```ruby
|
|
1280
1284
|
KlaviyoAPI::Catalogs.get_bulk_delete_catalog_items_job(job_id, opts)
|
|
@@ -1292,7 +1296,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_job(job_id, opts)
|
|
|
1292
1296
|
|
|
1293
1297
|
|
|
1294
1298
|
|
|
1295
|
-
#### [Get Bulk Delete Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1299
|
+
#### [Get Bulk Delete Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_delete_catalog_items_jobs)
|
|
1296
1300
|
|
|
1297
1301
|
```ruby
|
|
1298
1302
|
KlaviyoAPI::Catalogs.get_bulk_delete_catalog_items_jobs(opts)
|
|
@@ -1310,7 +1314,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_jobs(opts)
|
|
|
1310
1314
|
|
|
1311
1315
|
|
|
1312
1316
|
|
|
1313
|
-
#### [Get Bulk Delete Categories Job](https://developers.klaviyo.com/en/v2026-
|
|
1317
|
+
#### [Get Bulk Delete Categories Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_delete_categories_job)
|
|
1314
1318
|
|
|
1315
1319
|
```ruby
|
|
1316
1320
|
KlaviyoAPI::Catalogs.get_bulk_delete_categories_job(job_id, opts)
|
|
@@ -1328,7 +1332,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_job(job_id, opts)
|
|
|
1328
1332
|
|
|
1329
1333
|
|
|
1330
1334
|
|
|
1331
|
-
#### [Get Bulk Delete Categories Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1335
|
+
#### [Get Bulk Delete Categories Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_delete_categories_jobs)
|
|
1332
1336
|
|
|
1333
1337
|
```ruby
|
|
1334
1338
|
KlaviyoAPI::Catalogs.get_bulk_delete_categories_jobs(opts)
|
|
@@ -1346,7 +1350,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_jobs(opts)
|
|
|
1346
1350
|
|
|
1347
1351
|
|
|
1348
1352
|
|
|
1349
|
-
#### [Get Bulk Delete Variants Job](https://developers.klaviyo.com/en/v2026-
|
|
1353
|
+
#### [Get Bulk Delete Variants Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_delete_variants_job)
|
|
1350
1354
|
|
|
1351
1355
|
```ruby
|
|
1352
1356
|
KlaviyoAPI::Catalogs.get_bulk_delete_variants_job(job_id, opts)
|
|
@@ -1364,7 +1368,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_job(job_id, opts)
|
|
|
1364
1368
|
|
|
1365
1369
|
|
|
1366
1370
|
|
|
1367
|
-
#### [Get Bulk Delete Variants Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1371
|
+
#### [Get Bulk Delete Variants Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_delete_variants_jobs)
|
|
1368
1372
|
|
|
1369
1373
|
```ruby
|
|
1370
1374
|
KlaviyoAPI::Catalogs.get_bulk_delete_variants_jobs(opts)
|
|
@@ -1382,7 +1386,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_jobs(opts)
|
|
|
1382
1386
|
|
|
1383
1387
|
|
|
1384
1388
|
|
|
1385
|
-
#### [Get Bulk Update Catalog Items Job](https://developers.klaviyo.com/en/v2026-
|
|
1389
|
+
#### [Get Bulk Update Catalog Items Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_update_catalog_items_job)
|
|
1386
1390
|
|
|
1387
1391
|
```ruby
|
|
1388
1392
|
KlaviyoAPI::Catalogs.get_bulk_update_catalog_items_job(job_id, opts)
|
|
@@ -1400,7 +1404,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_job(job_id, opts)
|
|
|
1400
1404
|
|
|
1401
1405
|
|
|
1402
1406
|
|
|
1403
|
-
#### [Get Bulk Update Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1407
|
+
#### [Get Bulk Update Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_update_catalog_items_jobs)
|
|
1404
1408
|
|
|
1405
1409
|
```ruby
|
|
1406
1410
|
KlaviyoAPI::Catalogs.get_bulk_update_catalog_items_jobs(opts)
|
|
@@ -1418,7 +1422,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_jobs(opts)
|
|
|
1418
1422
|
|
|
1419
1423
|
|
|
1420
1424
|
|
|
1421
|
-
#### [Get Bulk Update Categories Job](https://developers.klaviyo.com/en/v2026-
|
|
1425
|
+
#### [Get Bulk Update Categories Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_update_categories_job)
|
|
1422
1426
|
|
|
1423
1427
|
```ruby
|
|
1424
1428
|
KlaviyoAPI::Catalogs.get_bulk_update_categories_job(job_id, opts)
|
|
@@ -1436,7 +1440,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_job(job_id, opts)
|
|
|
1436
1440
|
|
|
1437
1441
|
|
|
1438
1442
|
|
|
1439
|
-
#### [Get Bulk Update Categories Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1443
|
+
#### [Get Bulk Update Categories Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_update_categories_jobs)
|
|
1440
1444
|
|
|
1441
1445
|
```ruby
|
|
1442
1446
|
KlaviyoAPI::Catalogs.get_bulk_update_categories_jobs(opts)
|
|
@@ -1454,7 +1458,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_jobs(opts)
|
|
|
1454
1458
|
|
|
1455
1459
|
|
|
1456
1460
|
|
|
1457
|
-
#### [Get Bulk Update Variants Job](https://developers.klaviyo.com/en/v2026-
|
|
1461
|
+
#### [Get Bulk Update Variants Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_update_variants_job)
|
|
1458
1462
|
|
|
1459
1463
|
```ruby
|
|
1460
1464
|
KlaviyoAPI::Catalogs.get_bulk_update_variants_job(job_id, opts)
|
|
@@ -1472,7 +1476,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_job(job_id, opts)
|
|
|
1472
1476
|
|
|
1473
1477
|
|
|
1474
1478
|
|
|
1475
|
-
#### [Get Bulk Update Variants Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1479
|
+
#### [Get Bulk Update Variants Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_update_variants_jobs)
|
|
1476
1480
|
|
|
1477
1481
|
```ruby
|
|
1478
1482
|
KlaviyoAPI::Catalogs.get_bulk_update_variants_jobs(opts)
|
|
@@ -1490,7 +1494,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_jobs(opts)
|
|
|
1490
1494
|
|
|
1491
1495
|
|
|
1492
1496
|
|
|
1493
|
-
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2026-
|
|
1497
|
+
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2026-07-15/reference/get_catalog_categories)
|
|
1494
1498
|
|
|
1495
1499
|
```ruby
|
|
1496
1500
|
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
|
@@ -1500,7 +1504,7 @@ KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
|
|
1500
1504
|
|
|
1501
1505
|
|
|
1502
1506
|
|
|
1503
|
-
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
1507
|
+
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/get_catalog_category)
|
|
1504
1508
|
|
|
1505
1509
|
```ruby
|
|
1506
1510
|
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
|
@@ -1510,7 +1514,7 @@ KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
|
|
1510
1514
|
|
|
1511
1515
|
|
|
1512
1516
|
|
|
1513
|
-
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1517
|
+
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/get_catalog_item)
|
|
1514
1518
|
|
|
1515
1519
|
```ruby
|
|
1516
1520
|
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
|
@@ -1520,7 +1524,7 @@ KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
|
|
1520
1524
|
|
|
1521
1525
|
|
|
1522
1526
|
|
|
1523
|
-
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2026-
|
|
1527
|
+
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2026-07-15/reference/get_catalog_items)
|
|
1524
1528
|
|
|
1525
1529
|
```ruby
|
|
1526
1530
|
KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
|
@@ -1530,7 +1534,7 @@ KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
|
|
1530
1534
|
|
|
1531
1535
|
|
|
1532
1536
|
|
|
1533
|
-
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2026-
|
|
1537
|
+
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2026-07-15/reference/get_catalog_variant)
|
|
1534
1538
|
|
|
1535
1539
|
```ruby
|
|
1536
1540
|
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
|
@@ -1540,7 +1544,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
|
|
1540
1544
|
|
|
1541
1545
|
|
|
1542
1546
|
|
|
1543
|
-
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2026-
|
|
1547
|
+
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2026-07-15/reference/get_catalog_variants)
|
|
1544
1548
|
|
|
1545
1549
|
```ruby
|
|
1546
1550
|
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
|
@@ -1550,7 +1554,7 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
|
|
1550
1554
|
|
|
1551
1555
|
|
|
1552
1556
|
|
|
1553
|
-
#### [Get Categories for Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1557
|
+
#### [Get Categories for Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/get_categories_for_catalog_item)
|
|
1554
1558
|
|
|
1555
1559
|
```ruby
|
|
1556
1560
|
KlaviyoAPI::Catalogs.get_categories_for_catalog_item(id, opts)
|
|
@@ -1564,7 +1568,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts)
|
|
|
1564
1568
|
|
|
1565
1569
|
|
|
1566
1570
|
|
|
1567
|
-
#### [Get Category IDs for Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1571
|
+
#### [Get Category IDs for Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/get_category_ids_for_catalog_item)
|
|
1568
1572
|
|
|
1569
1573
|
```ruby
|
|
1570
1574
|
KlaviyoAPI::Catalogs.get_category_ids_for_catalog_item(id, opts)
|
|
@@ -1578,7 +1582,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
|
|
|
1578
1582
|
|
|
1579
1583
|
|
|
1580
1584
|
|
|
1581
|
-
#### [Get Item IDs for Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
1585
|
+
#### [Get Item IDs for Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/get_item_ids_for_catalog_category)
|
|
1582
1586
|
|
|
1583
1587
|
```ruby
|
|
1584
1588
|
KlaviyoAPI::Catalogs.get_item_ids_for_catalog_category(id, opts)
|
|
@@ -1592,7 +1596,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
|
|
|
1592
1596
|
|
|
1593
1597
|
|
|
1594
1598
|
|
|
1595
|
-
#### [Get Items for Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
1599
|
+
#### [Get Items for Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/get_items_for_catalog_category)
|
|
1596
1600
|
|
|
1597
1601
|
```ruby
|
|
1598
1602
|
KlaviyoAPI::Catalogs.get_items_for_catalog_category(id, opts)
|
|
@@ -1606,7 +1610,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts)
|
|
|
1606
1610
|
|
|
1607
1611
|
|
|
1608
1612
|
|
|
1609
|
-
#### [Get Variant IDs for Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1613
|
+
#### [Get Variant IDs for Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/get_variant_ids_for_catalog_item)
|
|
1610
1614
|
|
|
1611
1615
|
```ruby
|
|
1612
1616
|
KlaviyoAPI::Catalogs.get_variant_ids_for_catalog_item(id, opts)
|
|
@@ -1620,7 +1624,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships_variants(id, opts)
|
|
|
1620
1624
|
|
|
1621
1625
|
|
|
1622
1626
|
|
|
1623
|
-
#### [Get Variants for Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1627
|
+
#### [Get Variants for Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/get_variants_for_catalog_item)
|
|
1624
1628
|
|
|
1625
1629
|
```ruby
|
|
1626
1630
|
KlaviyoAPI::Catalogs.get_variants_for_catalog_item(id, opts)
|
|
@@ -1634,7 +1638,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts)
|
|
|
1634
1638
|
|
|
1635
1639
|
|
|
1636
1640
|
|
|
1637
|
-
#### [Remove Categories from Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1641
|
+
#### [Remove Categories from Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_categories_from_catalog_item)
|
|
1638
1642
|
|
|
1639
1643
|
```ruby
|
|
1640
1644
|
KlaviyoAPI::Catalogs.remove_categories_from_catalog_item(id, body)
|
|
@@ -1648,7 +1652,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
|
|
|
1648
1652
|
|
|
1649
1653
|
|
|
1650
1654
|
|
|
1651
|
-
#### [Remove Items from Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
1655
|
+
#### [Remove Items from Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_items_from_catalog_category)
|
|
1652
1656
|
|
|
1653
1657
|
```ruby
|
|
1654
1658
|
KlaviyoAPI::Catalogs.remove_items_from_catalog_category(id, body)
|
|
@@ -1662,37 +1666,37 @@ KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
|
|
|
1662
1666
|
|
|
1663
1667
|
|
|
1664
1668
|
|
|
1665
|
-
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
1669
|
+
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/update_catalog_category)
|
|
1666
1670
|
|
|
1667
1671
|
```ruby
|
|
1668
|
-
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
|
1672
|
+
KlaviyoAPI::Catalogs.update_catalog_category(id, body, opts)
|
|
1669
1673
|
```
|
|
1670
1674
|
|
|
1671
1675
|
|
|
1672
1676
|
|
|
1673
1677
|
|
|
1674
1678
|
|
|
1675
|
-
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1679
|
+
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/update_catalog_item)
|
|
1676
1680
|
|
|
1677
1681
|
```ruby
|
|
1678
|
-
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
|
1682
|
+
KlaviyoAPI::Catalogs.update_catalog_item(id, body, opts)
|
|
1679
1683
|
```
|
|
1680
1684
|
|
|
1681
1685
|
|
|
1682
1686
|
|
|
1683
1687
|
|
|
1684
1688
|
|
|
1685
|
-
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2026-
|
|
1689
|
+
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2026-07-15/reference/update_catalog_variant)
|
|
1686
1690
|
|
|
1687
1691
|
```ruby
|
|
1688
|
-
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
|
1692
|
+
KlaviyoAPI::Catalogs.update_catalog_variant(id, body, opts)
|
|
1689
1693
|
```
|
|
1690
1694
|
|
|
1691
1695
|
|
|
1692
1696
|
|
|
1693
1697
|
|
|
1694
1698
|
|
|
1695
|
-
#### [Update Categories for Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1699
|
+
#### [Update Categories for Catalog Item](https://developers.klaviyo.com/en/v2026-07-15/reference/update_categories_for_catalog_item)
|
|
1696
1700
|
|
|
1697
1701
|
```ruby
|
|
1698
1702
|
KlaviyoAPI::Catalogs.update_categories_for_catalog_item(id, body)
|
|
@@ -1706,7 +1710,7 @@ KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
|
|
|
1706
1710
|
|
|
1707
1711
|
|
|
1708
1712
|
|
|
1709
|
-
#### [Update Items for Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
1713
|
+
#### [Update Items for Catalog Category](https://developers.klaviyo.com/en/v2026-07-15/reference/update_items_for_catalog_category)
|
|
1710
1714
|
|
|
1711
1715
|
```ruby
|
|
1712
1716
|
KlaviyoAPI::Catalogs.update_items_for_catalog_category(id, body)
|
|
@@ -1721,10 +1725,24 @@ KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
|
|
|
1721
1725
|
|
|
1722
1726
|
|
|
1723
1727
|
|
|
1728
|
+
## Client
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
#### [Get Client IP Allowlist](https://developers.klaviyo.com/en/v2026-07-15/reference/get_client_ip_allowlist)
|
|
1732
|
+
|
|
1733
|
+
```ruby
|
|
1734
|
+
KlaviyoAPI::Client.get_client_ip_allowlist(id, company_id, opts)
|
|
1735
|
+
```
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
|
|
1724
1742
|
## Conversations
|
|
1725
1743
|
|
|
1726
1744
|
|
|
1727
|
-
#### [Create Conversation Message](https://developers.klaviyo.com/en/v2026-
|
|
1745
|
+
#### [Create Conversation Message](https://developers.klaviyo.com/en/v2026-07-15/reference/create_conversation_message)
|
|
1728
1746
|
|
|
1729
1747
|
```ruby
|
|
1730
1748
|
KlaviyoAPI::Conversations.create_conversation_message(body)
|
|
@@ -1738,45 +1756,45 @@ KlaviyoAPI::Conversations.create_conversation_message(body)
|
|
|
1738
1756
|
## Coupons
|
|
1739
1757
|
|
|
1740
1758
|
|
|
1741
|
-
#### [Bulk Create Coupon Codes](https://developers.klaviyo.com/en/v2026-
|
|
1759
|
+
#### [Bulk Create Coupon Codes](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_create_coupon_codes)
|
|
1742
1760
|
|
|
1743
1761
|
```ruby
|
|
1744
|
-
KlaviyoAPI::Coupons.bulk_create_coupon_codes(body)
|
|
1762
|
+
KlaviyoAPI::Coupons.bulk_create_coupon_codes(body, opts)
|
|
1745
1763
|
```
|
|
1746
1764
|
##### Method alias:
|
|
1747
1765
|
```ruby
|
|
1748
|
-
KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body)
|
|
1766
|
+
KlaviyoAPI::Coupons.spawn_coupon_code_bulk_create_job(body, opts)
|
|
1749
1767
|
```
|
|
1750
1768
|
##### Method alias:
|
|
1751
1769
|
```ruby
|
|
1752
|
-
KlaviyoAPI::Coupons.create_coupon_code_bulk_create_job(body)
|
|
1770
|
+
KlaviyoAPI::Coupons.create_coupon_code_bulk_create_job(body, opts)
|
|
1753
1771
|
```
|
|
1754
1772
|
|
|
1755
1773
|
|
|
1756
1774
|
|
|
1757
1775
|
|
|
1758
1776
|
|
|
1759
|
-
#### [Create Coupon](https://developers.klaviyo.com/en/v2026-
|
|
1777
|
+
#### [Create Coupon](https://developers.klaviyo.com/en/v2026-07-15/reference/create_coupon)
|
|
1760
1778
|
|
|
1761
1779
|
```ruby
|
|
1762
|
-
KlaviyoAPI::Coupons.create_coupon(body)
|
|
1780
|
+
KlaviyoAPI::Coupons.create_coupon(body, opts)
|
|
1763
1781
|
```
|
|
1764
1782
|
|
|
1765
1783
|
|
|
1766
1784
|
|
|
1767
1785
|
|
|
1768
1786
|
|
|
1769
|
-
#### [Create Coupon Code](https://developers.klaviyo.com/en/v2026-
|
|
1787
|
+
#### [Create Coupon Code](https://developers.klaviyo.com/en/v2026-07-15/reference/create_coupon_code)
|
|
1770
1788
|
|
|
1771
1789
|
```ruby
|
|
1772
|
-
KlaviyoAPI::Coupons.create_coupon_code(body)
|
|
1790
|
+
KlaviyoAPI::Coupons.create_coupon_code(body, opts)
|
|
1773
1791
|
```
|
|
1774
1792
|
|
|
1775
1793
|
|
|
1776
1794
|
|
|
1777
1795
|
|
|
1778
1796
|
|
|
1779
|
-
#### [Delete Coupon](https://developers.klaviyo.com/en/v2026-
|
|
1797
|
+
#### [Delete Coupon](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_coupon)
|
|
1780
1798
|
|
|
1781
1799
|
```ruby
|
|
1782
1800
|
KlaviyoAPI::Coupons.delete_coupon(id)
|
|
@@ -1786,7 +1804,7 @@ KlaviyoAPI::Coupons.delete_coupon(id)
|
|
|
1786
1804
|
|
|
1787
1805
|
|
|
1788
1806
|
|
|
1789
|
-
#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2026-
|
|
1807
|
+
#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_coupon_code)
|
|
1790
1808
|
|
|
1791
1809
|
```ruby
|
|
1792
1810
|
KlaviyoAPI::Coupons.delete_coupon_code(id)
|
|
@@ -1796,7 +1814,7 @@ KlaviyoAPI::Coupons.delete_coupon_code(id)
|
|
|
1796
1814
|
|
|
1797
1815
|
|
|
1798
1816
|
|
|
1799
|
-
#### [Get Bulk Create Coupon Code Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1817
|
+
#### [Get Bulk Create Coupon Code Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_coupon_code_jobs)
|
|
1800
1818
|
|
|
1801
1819
|
```ruby
|
|
1802
1820
|
KlaviyoAPI::Coupons.get_bulk_create_coupon_code_jobs(opts)
|
|
@@ -1810,7 +1828,7 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_jobs(opts)
|
|
|
1810
1828
|
|
|
1811
1829
|
|
|
1812
1830
|
|
|
1813
|
-
#### [Get Bulk Create Coupon Codes Job](https://developers.klaviyo.com/en/v2026-
|
|
1831
|
+
#### [Get Bulk Create Coupon Codes Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_create_coupon_codes_job)
|
|
1814
1832
|
|
|
1815
1833
|
```ruby
|
|
1816
1834
|
KlaviyoAPI::Coupons.get_bulk_create_coupon_codes_job(job_id, opts)
|
|
@@ -1824,7 +1842,7 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts)
|
|
|
1824
1842
|
|
|
1825
1843
|
|
|
1826
1844
|
|
|
1827
|
-
#### [Get Coupon](https://developers.klaviyo.com/en/v2026-
|
|
1845
|
+
#### [Get Coupon](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon)
|
|
1828
1846
|
|
|
1829
1847
|
```ruby
|
|
1830
1848
|
KlaviyoAPI::Coupons.get_coupon(id, opts)
|
|
@@ -1834,7 +1852,7 @@ KlaviyoAPI::Coupons.get_coupon(id, opts)
|
|
|
1834
1852
|
|
|
1835
1853
|
|
|
1836
1854
|
|
|
1837
|
-
#### [Get Coupon Code](https://developers.klaviyo.com/en/v2026-
|
|
1855
|
+
#### [Get Coupon Code](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon_code)
|
|
1838
1856
|
|
|
1839
1857
|
```ruby
|
|
1840
1858
|
KlaviyoAPI::Coupons.get_coupon_code(id, opts)
|
|
@@ -1844,7 +1862,7 @@ KlaviyoAPI::Coupons.get_coupon_code(id, opts)
|
|
|
1844
1862
|
|
|
1845
1863
|
|
|
1846
1864
|
|
|
1847
|
-
#### [Get Coupon Code IDs for Coupon](https://developers.klaviyo.com/en/v2026-
|
|
1865
|
+
#### [Get Coupon Code IDs for Coupon](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon_code_ids_for_coupon)
|
|
1848
1866
|
|
|
1849
1867
|
```ruby
|
|
1850
1868
|
KlaviyoAPI::Coupons.get_coupon_code_ids_for_coupon(id, opts)
|
|
@@ -1866,7 +1884,7 @@ KlaviyoAPI::Coupons.get_coupon_relationships_codes(id, opts)
|
|
|
1866
1884
|
|
|
1867
1885
|
|
|
1868
1886
|
|
|
1869
|
-
#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2026-
|
|
1887
|
+
#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon_codes)
|
|
1870
1888
|
|
|
1871
1889
|
```ruby
|
|
1872
1890
|
KlaviyoAPI::Coupons.get_coupon_codes(filter, opts)
|
|
@@ -1876,7 +1894,7 @@ KlaviyoAPI::Coupons.get_coupon_codes(filter, opts)
|
|
|
1876
1894
|
|
|
1877
1895
|
|
|
1878
1896
|
|
|
1879
|
-
#### [Get Coupon Codes for Coupon](https://developers.klaviyo.com/en/v2026-
|
|
1897
|
+
#### [Get Coupon Codes for Coupon](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon_codes_for_coupon)
|
|
1880
1898
|
|
|
1881
1899
|
```ruby
|
|
1882
1900
|
KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
|
|
@@ -1894,7 +1912,7 @@ KlaviyoAPI::Coupons.get_codes_for_coupon(id, opts)
|
|
|
1894
1912
|
|
|
1895
1913
|
|
|
1896
1914
|
|
|
1897
|
-
#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2026-
|
|
1915
|
+
#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon_for_coupon_code)
|
|
1898
1916
|
|
|
1899
1917
|
```ruby
|
|
1900
1918
|
KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts)
|
|
@@ -1908,7 +1926,7 @@ KlaviyoAPI::Coupons.get_coupon_code_coupon(id, opts)
|
|
|
1908
1926
|
|
|
1909
1927
|
|
|
1910
1928
|
|
|
1911
|
-
#### [Get Coupon ID for Coupon Code](https://developers.klaviyo.com/en/v2026-
|
|
1929
|
+
#### [Get Coupon ID for Coupon Code](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupon_id_for_coupon_code)
|
|
1912
1930
|
|
|
1913
1931
|
```ruby
|
|
1914
1932
|
KlaviyoAPI::Coupons.get_coupon_id_for_coupon_code(id)
|
|
@@ -1922,7 +1940,7 @@ KlaviyoAPI::Coupons.get_coupon_relationships_coupon_codes(id)
|
|
|
1922
1940
|
|
|
1923
1941
|
|
|
1924
1942
|
|
|
1925
|
-
#### [Get Coupons](https://developers.klaviyo.com/en/v2026-
|
|
1943
|
+
#### [Get Coupons](https://developers.klaviyo.com/en/v2026-07-15/reference/get_coupons)
|
|
1926
1944
|
|
|
1927
1945
|
```ruby
|
|
1928
1946
|
KlaviyoAPI::Coupons.get_coupons(opts)
|
|
@@ -1932,20 +1950,20 @@ KlaviyoAPI::Coupons.get_coupons(opts)
|
|
|
1932
1950
|
|
|
1933
1951
|
|
|
1934
1952
|
|
|
1935
|
-
#### [Update Coupon](https://developers.klaviyo.com/en/v2026-
|
|
1953
|
+
#### [Update Coupon](https://developers.klaviyo.com/en/v2026-07-15/reference/update_coupon)
|
|
1936
1954
|
|
|
1937
1955
|
```ruby
|
|
1938
|
-
KlaviyoAPI::Coupons.update_coupon(id, body)
|
|
1956
|
+
KlaviyoAPI::Coupons.update_coupon(id, body, opts)
|
|
1939
1957
|
```
|
|
1940
1958
|
|
|
1941
1959
|
|
|
1942
1960
|
|
|
1943
1961
|
|
|
1944
1962
|
|
|
1945
|
-
#### [Update Coupon Code](https://developers.klaviyo.com/en/v2026-
|
|
1963
|
+
#### [Update Coupon Code](https://developers.klaviyo.com/en/v2026-07-15/reference/update_coupon_code)
|
|
1946
1964
|
|
|
1947
1965
|
```ruby
|
|
1948
|
-
KlaviyoAPI::Coupons.update_coupon_code(id, body)
|
|
1966
|
+
KlaviyoAPI::Coupons.update_coupon_code(id, body, opts)
|
|
1949
1967
|
```
|
|
1950
1968
|
|
|
1951
1969
|
|
|
@@ -1956,7 +1974,7 @@ KlaviyoAPI::Coupons.update_coupon_code(id, body)
|
|
|
1956
1974
|
## Custom Objects
|
|
1957
1975
|
|
|
1958
1976
|
|
|
1959
|
-
#### [Bulk Create Data Source Records](https://developers.klaviyo.com/en/v2026-
|
|
1977
|
+
#### [Bulk Create Data Source Records](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_create_data_source_records)
|
|
1960
1978
|
|
|
1961
1979
|
```ruby
|
|
1962
1980
|
KlaviyoAPI::CustomObjects.bulk_create_data_source_records(body)
|
|
@@ -1970,17 +1988,31 @@ KlaviyoAPI::CustomObjects.create_data_source_record_bulk_create_job(body)
|
|
|
1970
1988
|
|
|
1971
1989
|
|
|
1972
1990
|
|
|
1973
|
-
#### [
|
|
1991
|
+
#### [Bulk Delete Object Records](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_delete_object_records)
|
|
1992
|
+
|
|
1993
|
+
```ruby
|
|
1994
|
+
KlaviyoAPI::CustomObjects.bulk_delete_object_records(body)
|
|
1995
|
+
```
|
|
1996
|
+
##### Method alias:
|
|
1997
|
+
```ruby
|
|
1998
|
+
KlaviyoAPI::CustomObjects.create_object_record_bulk_delete_job(body)
|
|
1999
|
+
```
|
|
2000
|
+
|
|
2001
|
+
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
|
|
2005
|
+
#### [Create Data Source](https://developers.klaviyo.com/en/v2026-07-15/reference/create_data_source)
|
|
1974
2006
|
|
|
1975
2007
|
```ruby
|
|
1976
|
-
KlaviyoAPI::CustomObjects.create_data_source(body)
|
|
2008
|
+
KlaviyoAPI::CustomObjects.create_data_source(body, opts)
|
|
1977
2009
|
```
|
|
1978
2010
|
|
|
1979
2011
|
|
|
1980
2012
|
|
|
1981
2013
|
|
|
1982
2014
|
|
|
1983
|
-
#### [Create Data Source Record](https://developers.klaviyo.com/en/v2026-
|
|
2015
|
+
#### [Create Data Source Record](https://developers.klaviyo.com/en/v2026-07-15/reference/create_data_source_record)
|
|
1984
2016
|
|
|
1985
2017
|
```ruby
|
|
1986
2018
|
KlaviyoAPI::CustomObjects.create_data_source_record(body)
|
|
@@ -1994,7 +2026,63 @@ KlaviyoAPI::CustomObjects.create_data_source_record_create_job(body)
|
|
|
1994
2026
|
|
|
1995
2027
|
|
|
1996
2028
|
|
|
1997
|
-
#### [
|
|
2029
|
+
#### [Create Object Schema](https://developers.klaviyo.com/en/v2026-07-15/reference/create_object_schema)
|
|
2030
|
+
|
|
2031
|
+
```ruby
|
|
2032
|
+
KlaviyoAPI::CustomObjects.create_object_schema(body, opts)
|
|
2033
|
+
```
|
|
2034
|
+
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
#### [Create Object Schema Relationship](https://developers.klaviyo.com/en/v2026-07-15/reference/create_object_schema_relationship)
|
|
2040
|
+
|
|
2041
|
+
```ruby
|
|
2042
|
+
KlaviyoAPI::CustomObjects.create_object_schema_relationship(id, body)
|
|
2043
|
+
```
|
|
2044
|
+
##### Method alias:
|
|
2045
|
+
```ruby
|
|
2046
|
+
KlaviyoAPI::CustomObjects.add_schemas_to_object_schema(id, body)
|
|
2047
|
+
```
|
|
2048
|
+
##### Method alias:
|
|
2049
|
+
```ruby
|
|
2050
|
+
KlaviyoAPI::CustomObjects.create_object_schema_relationships_schemas(id, body)
|
|
2051
|
+
```
|
|
2052
|
+
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
|
|
2057
|
+
#### [Create Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/create_object_type)
|
|
2058
|
+
|
|
2059
|
+
```ruby
|
|
2060
|
+
KlaviyoAPI::CustomObjects.create_object_type(body, opts)
|
|
2061
|
+
```
|
|
2062
|
+
|
|
2063
|
+
|
|
2064
|
+
|
|
2065
|
+
|
|
2066
|
+
|
|
2067
|
+
#### [Create Profile Schema Relationship](https://developers.klaviyo.com/en/v2026-07-15/reference/create_profile_schema_relationship)
|
|
2068
|
+
|
|
2069
|
+
```ruby
|
|
2070
|
+
KlaviyoAPI::CustomObjects.create_profile_schema_relationship(id, body)
|
|
2071
|
+
```
|
|
2072
|
+
##### Method alias:
|
|
2073
|
+
```ruby
|
|
2074
|
+
KlaviyoAPI::CustomObjects.add_profile_object_schemas_to_object_schema(id, body)
|
|
2075
|
+
```
|
|
2076
|
+
##### Method alias:
|
|
2077
|
+
```ruby
|
|
2078
|
+
KlaviyoAPI::CustomObjects.create_object_schema_relationships_profile_object_schemas(id, body)
|
|
2079
|
+
```
|
|
2080
|
+
|
|
2081
|
+
|
|
2082
|
+
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
#### [Delete Data Source](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_data_source)
|
|
1998
2086
|
|
|
1999
2087
|
```ruby
|
|
2000
2088
|
KlaviyoAPI::CustomObjects.delete_data_source(id)
|
|
@@ -2004,7 +2092,81 @@ KlaviyoAPI::CustomObjects.delete_data_source(id)
|
|
|
2004
2092
|
|
|
2005
2093
|
|
|
2006
2094
|
|
|
2007
|
-
#### [
|
|
2095
|
+
#### [Delete Object Schema Relationship](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_object_schema_relationship)
|
|
2096
|
+
|
|
2097
|
+
```ruby
|
|
2098
|
+
KlaviyoAPI::CustomObjects.delete_object_schema_relationship(id, body)
|
|
2099
|
+
```
|
|
2100
|
+
##### Method alias:
|
|
2101
|
+
```ruby
|
|
2102
|
+
KlaviyoAPI::CustomObjects.delete_object_schema_relationships_schemas(id, body)
|
|
2103
|
+
```
|
|
2104
|
+
##### Method alias:
|
|
2105
|
+
```ruby
|
|
2106
|
+
KlaviyoAPI::CustomObjects.remove_schemas_from_object_schema(id, body)
|
|
2107
|
+
```
|
|
2108
|
+
|
|
2109
|
+
|
|
2110
|
+
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
#### [Delete Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_object_type)
|
|
2114
|
+
|
|
2115
|
+
```ruby
|
|
2116
|
+
KlaviyoAPI::CustomObjects.delete_object_type(id)
|
|
2117
|
+
```
|
|
2118
|
+
|
|
2119
|
+
|
|
2120
|
+
|
|
2121
|
+
|
|
2122
|
+
|
|
2123
|
+
#### [Delete Profile Schema Relationship](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_profile_schema_relationship)
|
|
2124
|
+
|
|
2125
|
+
```ruby
|
|
2126
|
+
KlaviyoAPI::CustomObjects.delete_profile_schema_relationship(id, body)
|
|
2127
|
+
```
|
|
2128
|
+
##### Method alias:
|
|
2129
|
+
```ruby
|
|
2130
|
+
KlaviyoAPI::CustomObjects.delete_object_schema_relationships_profile_object_schemas(id, body)
|
|
2131
|
+
```
|
|
2132
|
+
##### Method alias:
|
|
2133
|
+
```ruby
|
|
2134
|
+
KlaviyoAPI::CustomObjects.remove_profile_object_schemas_from_object_schema(id, body)
|
|
2135
|
+
```
|
|
2136
|
+
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
|
|
2141
|
+
#### [Get Current Schema for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_current_schema_for_object_type)
|
|
2142
|
+
|
|
2143
|
+
```ruby
|
|
2144
|
+
KlaviyoAPI::CustomObjects.get_current_schema_for_object_type(id, opts)
|
|
2145
|
+
```
|
|
2146
|
+
##### Method alias:
|
|
2147
|
+
```ruby
|
|
2148
|
+
KlaviyoAPI::CustomObjects.get_object_type_current_schema(id, opts)
|
|
2149
|
+
```
|
|
2150
|
+
|
|
2151
|
+
|
|
2152
|
+
|
|
2153
|
+
|
|
2154
|
+
|
|
2155
|
+
#### [Get Current Schema ID for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_current_schema_id_for_object_type)
|
|
2156
|
+
|
|
2157
|
+
```ruby
|
|
2158
|
+
KlaviyoAPI::CustomObjects.get_current_schema_id_for_object_type(id)
|
|
2159
|
+
```
|
|
2160
|
+
##### Method alias:
|
|
2161
|
+
```ruby
|
|
2162
|
+
KlaviyoAPI::CustomObjects.get_object_type_relationships_current_schema(id)
|
|
2163
|
+
```
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
|
|
2167
|
+
|
|
2168
|
+
|
|
2169
|
+
#### [Get Data Source](https://developers.klaviyo.com/en/v2026-07-15/reference/get_data_source)
|
|
2008
2170
|
|
|
2009
2171
|
```ruby
|
|
2010
2172
|
KlaviyoAPI::CustomObjects.get_data_source(id, opts)
|
|
@@ -2014,7 +2176,7 @@ KlaviyoAPI::CustomObjects.get_data_source(id, opts)
|
|
|
2014
2176
|
|
|
2015
2177
|
|
|
2016
2178
|
|
|
2017
|
-
#### [Get Data Sources](https://developers.klaviyo.com/en/v2026-
|
|
2179
|
+
#### [Get Data Sources](https://developers.klaviyo.com/en/v2026-07-15/reference/get_data_sources)
|
|
2018
2180
|
|
|
2019
2181
|
```ruby
|
|
2020
2182
|
KlaviyoAPI::CustomObjects.get_data_sources(opts)
|
|
@@ -2024,11 +2186,329 @@ KlaviyoAPI::CustomObjects.get_data_sources(opts)
|
|
|
2024
2186
|
|
|
2025
2187
|
|
|
2026
2188
|
|
|
2189
|
+
#### [Get Draft Schema for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_draft_schema_for_object_type)
|
|
2190
|
+
|
|
2191
|
+
```ruby
|
|
2192
|
+
KlaviyoAPI::CustomObjects.get_draft_schema_for_object_type(id, opts)
|
|
2193
|
+
```
|
|
2194
|
+
##### Method alias:
|
|
2195
|
+
```ruby
|
|
2196
|
+
KlaviyoAPI::CustomObjects.get_object_type_draft_schema(id, opts)
|
|
2197
|
+
```
|
|
2198
|
+
|
|
2199
|
+
|
|
2200
|
+
|
|
2201
|
+
|
|
2202
|
+
|
|
2203
|
+
#### [Get Draft Schema ID for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_draft_schema_id_for_object_type)
|
|
2204
|
+
|
|
2205
|
+
```ruby
|
|
2206
|
+
KlaviyoAPI::CustomObjects.get_draft_schema_id_for_object_type(id)
|
|
2207
|
+
```
|
|
2208
|
+
##### Method alias:
|
|
2209
|
+
```ruby
|
|
2210
|
+
KlaviyoAPI::CustomObjects.get_object_type_relationships_draft_schema(id)
|
|
2211
|
+
```
|
|
2212
|
+
|
|
2213
|
+
|
|
2214
|
+
|
|
2215
|
+
|
|
2216
|
+
|
|
2217
|
+
#### [Get Ingestion Log IDs for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_ingestion_log_ids_for_object_type)
|
|
2218
|
+
|
|
2219
|
+
```ruby
|
|
2220
|
+
KlaviyoAPI::CustomObjects.get_ingestion_log_ids_for_object_type(id, opts)
|
|
2221
|
+
```
|
|
2222
|
+
##### Method alias:
|
|
2223
|
+
```ruby
|
|
2224
|
+
KlaviyoAPI::CustomObjects.get_object_type_relationships_ingestion_logs(id, opts)
|
|
2225
|
+
```
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
|
|
2229
|
+
|
|
2230
|
+
|
|
2231
|
+
#### [Get Ingestion Logs for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_ingestion_logs_for_object_type)
|
|
2232
|
+
|
|
2233
|
+
```ruby
|
|
2234
|
+
KlaviyoAPI::CustomObjects.get_ingestion_logs_for_object_type(id, opts)
|
|
2235
|
+
```
|
|
2236
|
+
##### Method alias:
|
|
2237
|
+
```ruby
|
|
2238
|
+
KlaviyoAPI::CustomObjects.get_object_type_ingestion_logs(id, opts)
|
|
2239
|
+
```
|
|
2240
|
+
|
|
2241
|
+
|
|
2242
|
+
|
|
2243
|
+
|
|
2244
|
+
|
|
2245
|
+
#### [Get Object Record](https://developers.klaviyo.com/en/v2026-07-15/reference/get_object_record)
|
|
2246
|
+
|
|
2247
|
+
```ruby
|
|
2248
|
+
KlaviyoAPI::CustomObjects.get_object_record(id, opts)
|
|
2249
|
+
```
|
|
2250
|
+
|
|
2251
|
+
|
|
2252
|
+
|
|
2253
|
+
|
|
2254
|
+
|
|
2255
|
+
#### [Get Object Schema](https://developers.klaviyo.com/en/v2026-07-15/reference/get_object_schema)
|
|
2256
|
+
|
|
2257
|
+
```ruby
|
|
2258
|
+
KlaviyoAPI::CustomObjects.get_object_schema(id, opts)
|
|
2259
|
+
```
|
|
2260
|
+
|
|
2261
|
+
|
|
2262
|
+
|
|
2263
|
+
|
|
2264
|
+
|
|
2265
|
+
#### [Get Object Schema Relationships](https://developers.klaviyo.com/en/v2026-07-15/reference/get_object_schema_relationships)
|
|
2266
|
+
|
|
2267
|
+
```ruby
|
|
2268
|
+
KlaviyoAPI::CustomObjects.get_object_schema_relationships(id)
|
|
2269
|
+
```
|
|
2270
|
+
##### Method alias:
|
|
2271
|
+
```ruby
|
|
2272
|
+
KlaviyoAPI::CustomObjects.get_object_schema_relationships_schemas(id)
|
|
2273
|
+
```
|
|
2274
|
+
##### Method alias:
|
|
2275
|
+
```ruby
|
|
2276
|
+
KlaviyoAPI::CustomObjects.get_schema_ids_for_object_schema(id)
|
|
2277
|
+
```
|
|
2278
|
+
|
|
2279
|
+
|
|
2280
|
+
|
|
2281
|
+
|
|
2282
|
+
|
|
2283
|
+
#### [Get Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_object_type)
|
|
2284
|
+
|
|
2285
|
+
```ruby
|
|
2286
|
+
KlaviyoAPI::CustomObjects.get_object_type(id, opts)
|
|
2287
|
+
```
|
|
2288
|
+
|
|
2289
|
+
|
|
2290
|
+
|
|
2291
|
+
|
|
2292
|
+
|
|
2293
|
+
#### [Get Object Type Relationships](https://developers.klaviyo.com/en/v2026-07-15/reference/get_object_type_relationships)
|
|
2294
|
+
|
|
2295
|
+
```ruby
|
|
2296
|
+
KlaviyoAPI::CustomObjects.get_object_type_relationships(id)
|
|
2297
|
+
```
|
|
2298
|
+
##### Method alias:
|
|
2299
|
+
```ruby
|
|
2300
|
+
KlaviyoAPI::CustomObjects.get_object_type_relationships_types(id)
|
|
2301
|
+
```
|
|
2302
|
+
##### Method alias:
|
|
2303
|
+
```ruby
|
|
2304
|
+
KlaviyoAPI::CustomObjects.get_type_ids_for_object_type(id)
|
|
2305
|
+
```
|
|
2306
|
+
|
|
2307
|
+
|
|
2308
|
+
|
|
2309
|
+
|
|
2310
|
+
|
|
2311
|
+
#### [Get Object Types](https://developers.klaviyo.com/en/v2026-07-15/reference/get_object_types)
|
|
2312
|
+
|
|
2313
|
+
```ruby
|
|
2314
|
+
KlaviyoAPI::CustomObjects.get_object_types(opts)
|
|
2315
|
+
```
|
|
2316
|
+
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
|
|
2320
|
+
|
|
2321
|
+
#### [Get Profile Schema Relationships](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_schema_relationships)
|
|
2322
|
+
|
|
2323
|
+
```ruby
|
|
2324
|
+
KlaviyoAPI::CustomObjects.get_profile_schema_relationships(id)
|
|
2325
|
+
```
|
|
2326
|
+
##### Method alias:
|
|
2327
|
+
```ruby
|
|
2328
|
+
KlaviyoAPI::CustomObjects.get_object_schema_relationships_profile_object_schemas(id)
|
|
2329
|
+
```
|
|
2330
|
+
##### Method alias:
|
|
2331
|
+
```ruby
|
|
2332
|
+
KlaviyoAPI::CustomObjects.get_profile_object_schema_ids_for_object_schema(id)
|
|
2333
|
+
```
|
|
2334
|
+
|
|
2335
|
+
|
|
2336
|
+
|
|
2337
|
+
|
|
2338
|
+
|
|
2339
|
+
#### [Get Profile Type Relationships](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_type_relationships)
|
|
2340
|
+
|
|
2341
|
+
```ruby
|
|
2342
|
+
KlaviyoAPI::CustomObjects.get_profile_type_relationships(id)
|
|
2343
|
+
```
|
|
2344
|
+
##### Method alias:
|
|
2345
|
+
```ruby
|
|
2346
|
+
KlaviyoAPI::CustomObjects.get_object_type_relationships_profile_object_types(id)
|
|
2347
|
+
```
|
|
2348
|
+
##### Method alias:
|
|
2349
|
+
```ruby
|
|
2350
|
+
KlaviyoAPI::CustomObjects.get_profile_object_type_ids_for_object_type(id)
|
|
2351
|
+
```
|
|
2352
|
+
|
|
2353
|
+
|
|
2354
|
+
|
|
2355
|
+
|
|
2356
|
+
|
|
2357
|
+
#### [Get Record IDs for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_record_ids_for_object_type)
|
|
2358
|
+
|
|
2359
|
+
```ruby
|
|
2360
|
+
KlaviyoAPI::CustomObjects.get_record_ids_for_object_type(id, opts)
|
|
2361
|
+
```
|
|
2362
|
+
##### Method alias:
|
|
2363
|
+
```ruby
|
|
2364
|
+
KlaviyoAPI::CustomObjects.get_object_type_relationships_records(id, opts)
|
|
2365
|
+
```
|
|
2366
|
+
|
|
2367
|
+
|
|
2368
|
+
|
|
2369
|
+
|
|
2370
|
+
|
|
2371
|
+
#### [Get Records for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_records_for_object_type)
|
|
2372
|
+
|
|
2373
|
+
```ruby
|
|
2374
|
+
KlaviyoAPI::CustomObjects.get_records_for_object_type(id, opts)
|
|
2375
|
+
```
|
|
2376
|
+
##### Method alias:
|
|
2377
|
+
```ruby
|
|
2378
|
+
KlaviyoAPI::CustomObjects.get_object_type_records(id, opts)
|
|
2379
|
+
```
|
|
2380
|
+
|
|
2381
|
+
|
|
2382
|
+
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
#### [Get Schema Version IDs for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_schema_version_ids_for_object_type)
|
|
2386
|
+
|
|
2387
|
+
```ruby
|
|
2388
|
+
KlaviyoAPI::CustomObjects.get_schema_version_ids_for_object_type(id)
|
|
2389
|
+
```
|
|
2390
|
+
##### Method alias:
|
|
2391
|
+
```ruby
|
|
2392
|
+
KlaviyoAPI::CustomObjects.get_object_type_relationships_schema_versions(id)
|
|
2393
|
+
```
|
|
2394
|
+
|
|
2395
|
+
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
|
|
2399
|
+
#### [Get Schema Versions for Object Type](https://developers.klaviyo.com/en/v2026-07-15/reference/get_schema_versions_for_object_type)
|
|
2400
|
+
|
|
2401
|
+
```ruby
|
|
2402
|
+
KlaviyoAPI::CustomObjects.get_schema_versions_for_object_type(id, opts)
|
|
2403
|
+
```
|
|
2404
|
+
##### Method alias:
|
|
2405
|
+
```ruby
|
|
2406
|
+
KlaviyoAPI::CustomObjects.get_object_type_schema_versions(id, opts)
|
|
2407
|
+
```
|
|
2408
|
+
|
|
2409
|
+
|
|
2410
|
+
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
#### [Get Source Mapping](https://developers.klaviyo.com/en/v2026-07-15/reference/get_source_mapping)
|
|
2414
|
+
|
|
2415
|
+
```ruby
|
|
2416
|
+
KlaviyoAPI::CustomObjects.get_source_mapping(id, opts)
|
|
2417
|
+
```
|
|
2418
|
+
|
|
2419
|
+
|
|
2420
|
+
|
|
2421
|
+
|
|
2422
|
+
|
|
2423
|
+
#### [Get Source Mapping for Object Schema](https://developers.klaviyo.com/en/v2026-07-15/reference/get_source_mapping_for_object_schema)
|
|
2424
|
+
|
|
2425
|
+
```ruby
|
|
2426
|
+
KlaviyoAPI::CustomObjects.get_source_mapping_for_object_schema(id, opts)
|
|
2427
|
+
```
|
|
2428
|
+
##### Method alias:
|
|
2429
|
+
```ruby
|
|
2430
|
+
KlaviyoAPI::CustomObjects.get_object_schema_source_mapping(id, opts)
|
|
2431
|
+
```
|
|
2432
|
+
|
|
2433
|
+
|
|
2434
|
+
|
|
2435
|
+
|
|
2436
|
+
|
|
2437
|
+
#### [Get Source Mapping ID for Object Schema](https://developers.klaviyo.com/en/v2026-07-15/reference/get_source_mapping_id_for_object_schema)
|
|
2438
|
+
|
|
2439
|
+
```ruby
|
|
2440
|
+
KlaviyoAPI::CustomObjects.get_source_mapping_id_for_object_schema(id)
|
|
2441
|
+
```
|
|
2442
|
+
##### Method alias:
|
|
2443
|
+
```ruby
|
|
2444
|
+
KlaviyoAPI::CustomObjects.get_object_schema_relationships_source_mapping(id)
|
|
2445
|
+
```
|
|
2446
|
+
|
|
2447
|
+
|
|
2448
|
+
|
|
2449
|
+
|
|
2450
|
+
|
|
2451
|
+
#### [Update Object Schema](https://developers.klaviyo.com/en/v2026-07-15/reference/update_object_schema)
|
|
2452
|
+
|
|
2453
|
+
```ruby
|
|
2454
|
+
KlaviyoAPI::CustomObjects.update_object_schema(id, body, opts)
|
|
2455
|
+
```
|
|
2456
|
+
|
|
2457
|
+
|
|
2458
|
+
|
|
2459
|
+
|
|
2460
|
+
|
|
2461
|
+
#### [Update Object Schema Relationship](https://developers.klaviyo.com/en/v2026-07-15/reference/update_object_schema_relationship)
|
|
2462
|
+
|
|
2463
|
+
```ruby
|
|
2464
|
+
KlaviyoAPI::CustomObjects.update_object_schema_relationship(id, body)
|
|
2465
|
+
```
|
|
2466
|
+
##### Method alias:
|
|
2467
|
+
```ruby
|
|
2468
|
+
KlaviyoAPI::CustomObjects.update_object_schema_relationships_schemas(id, body)
|
|
2469
|
+
```
|
|
2470
|
+
##### Method alias:
|
|
2471
|
+
```ruby
|
|
2472
|
+
KlaviyoAPI::CustomObjects.update_schemas_for_object_schema(id, body)
|
|
2473
|
+
```
|
|
2474
|
+
|
|
2475
|
+
|
|
2476
|
+
|
|
2477
|
+
|
|
2478
|
+
|
|
2479
|
+
#### [Update Profile Schema Relationship](https://developers.klaviyo.com/en/v2026-07-15/reference/update_profile_schema_relationship)
|
|
2480
|
+
|
|
2481
|
+
```ruby
|
|
2482
|
+
KlaviyoAPI::CustomObjects.update_profile_schema_relationship(id, body)
|
|
2483
|
+
```
|
|
2484
|
+
##### Method alias:
|
|
2485
|
+
```ruby
|
|
2486
|
+
KlaviyoAPI::CustomObjects.update_object_schema_relationships_profile_object_schemas(id, body)
|
|
2487
|
+
```
|
|
2488
|
+
##### Method alias:
|
|
2489
|
+
```ruby
|
|
2490
|
+
KlaviyoAPI::CustomObjects.update_profile_object_schemas_for_object_schema(id, body)
|
|
2491
|
+
```
|
|
2492
|
+
|
|
2493
|
+
|
|
2494
|
+
|
|
2495
|
+
|
|
2496
|
+
|
|
2497
|
+
#### [Update Source Mapping](https://developers.klaviyo.com/en/v2026-07-15/reference/update_source_mapping)
|
|
2498
|
+
|
|
2499
|
+
```ruby
|
|
2500
|
+
KlaviyoAPI::CustomObjects.update_source_mapping(id, body, opts)
|
|
2501
|
+
```
|
|
2502
|
+
|
|
2503
|
+
|
|
2504
|
+
|
|
2505
|
+
|
|
2506
|
+
|
|
2027
2507
|
|
|
2028
2508
|
## Data Privacy
|
|
2029
2509
|
|
|
2030
2510
|
|
|
2031
|
-
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2026-
|
|
2511
|
+
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2026-07-15/reference/request_profile_deletion)
|
|
2032
2512
|
|
|
2033
2513
|
```ruby
|
|
2034
2514
|
KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
|
|
@@ -2046,7 +2526,7 @@ KlaviyoAPI::DataPrivacy.create_data_privacy_deletion_job(body)
|
|
|
2046
2526
|
## Events
|
|
2047
2527
|
|
|
2048
2528
|
|
|
2049
|
-
#### [Bulk Create Events](https://developers.klaviyo.com/en/v2026-
|
|
2529
|
+
#### [Bulk Create Events](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_create_events)
|
|
2050
2530
|
|
|
2051
2531
|
```ruby
|
|
2052
2532
|
KlaviyoAPI::Events.bulk_create_events(body)
|
|
@@ -2060,7 +2540,7 @@ KlaviyoAPI::Events.create_event_bulk_create_job(body)
|
|
|
2060
2540
|
|
|
2061
2541
|
|
|
2062
2542
|
|
|
2063
|
-
#### [Create Event](https://developers.klaviyo.com/en/v2026-
|
|
2543
|
+
#### [Create Event](https://developers.klaviyo.com/en/v2026-07-15/reference/create_event)
|
|
2064
2544
|
|
|
2065
2545
|
```ruby
|
|
2066
2546
|
KlaviyoAPI::Events.create_event(body)
|
|
@@ -2070,7 +2550,7 @@ KlaviyoAPI::Events.create_event(body)
|
|
|
2070
2550
|
|
|
2071
2551
|
|
|
2072
2552
|
|
|
2073
|
-
#### [Get Event](https://developers.klaviyo.com/en/v2026-
|
|
2553
|
+
#### [Get Event](https://developers.klaviyo.com/en/v2026-07-15/reference/get_event)
|
|
2074
2554
|
|
|
2075
2555
|
```ruby
|
|
2076
2556
|
KlaviyoAPI::Events.get_event(id, opts)
|
|
@@ -2080,7 +2560,7 @@ KlaviyoAPI::Events.get_event(id, opts)
|
|
|
2080
2560
|
|
|
2081
2561
|
|
|
2082
2562
|
|
|
2083
|
-
#### [Get Events](https://developers.klaviyo.com/en/v2026-
|
|
2563
|
+
#### [Get Events](https://developers.klaviyo.com/en/v2026-07-15/reference/get_events)
|
|
2084
2564
|
|
|
2085
2565
|
```ruby
|
|
2086
2566
|
KlaviyoAPI::Events.get_events(opts)
|
|
@@ -2090,7 +2570,7 @@ KlaviyoAPI::Events.get_events(opts)
|
|
|
2090
2570
|
|
|
2091
2571
|
|
|
2092
2572
|
|
|
2093
|
-
#### [Get Metric for Event](https://developers.klaviyo.com/en/v2026-
|
|
2573
|
+
#### [Get Metric for Event](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_for_event)
|
|
2094
2574
|
|
|
2095
2575
|
```ruby
|
|
2096
2576
|
KlaviyoAPI::Events.get_metric_for_event(id, opts)
|
|
@@ -2104,7 +2584,7 @@ KlaviyoAPI::Events.get_event_metric(id, opts)
|
|
|
2104
2584
|
|
|
2105
2585
|
|
|
2106
2586
|
|
|
2107
|
-
#### [Get Metric ID for Event](https://developers.klaviyo.com/en/v2026-
|
|
2587
|
+
#### [Get Metric ID for Event](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_id_for_event)
|
|
2108
2588
|
|
|
2109
2589
|
```ruby
|
|
2110
2590
|
KlaviyoAPI::Events.get_metric_id_for_event(id)
|
|
@@ -2118,7 +2598,7 @@ KlaviyoAPI::Events.get_event_relationships_metric(id)
|
|
|
2118
2598
|
|
|
2119
2599
|
|
|
2120
2600
|
|
|
2121
|
-
#### [Get Profile for Event](https://developers.klaviyo.com/en/v2026-
|
|
2601
|
+
#### [Get Profile for Event](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_for_event)
|
|
2122
2602
|
|
|
2123
2603
|
```ruby
|
|
2124
2604
|
KlaviyoAPI::Events.get_profile_for_event(id, opts)
|
|
@@ -2132,7 +2612,7 @@ KlaviyoAPI::Events.get_event_profile(id, opts)
|
|
|
2132
2612
|
|
|
2133
2613
|
|
|
2134
2614
|
|
|
2135
|
-
#### [Get Profile ID for Event](https://developers.klaviyo.com/en/v2026-
|
|
2615
|
+
#### [Get Profile ID for Event](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_id_for_event)
|
|
2136
2616
|
|
|
2137
2617
|
```ruby
|
|
2138
2618
|
KlaviyoAPI::Events.get_profile_id_for_event(id)
|
|
@@ -2150,7 +2630,7 @@ KlaviyoAPI::Events.get_event_relationships_profile(id)
|
|
|
2150
2630
|
## Flows
|
|
2151
2631
|
|
|
2152
2632
|
|
|
2153
|
-
#### [Create Flow](https://developers.klaviyo.com/en/v2026-
|
|
2633
|
+
#### [Create Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/create_flow)
|
|
2154
2634
|
|
|
2155
2635
|
```ruby
|
|
2156
2636
|
KlaviyoAPI::Flows.create_flow(body, opts)
|
|
@@ -2160,7 +2640,7 @@ KlaviyoAPI::Flows.create_flow(body, opts)
|
|
|
2160
2640
|
|
|
2161
2641
|
|
|
2162
2642
|
|
|
2163
|
-
#### [Delete Flow](https://developers.klaviyo.com/en/v2026-
|
|
2643
|
+
#### [Delete Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_flow)
|
|
2164
2644
|
|
|
2165
2645
|
```ruby
|
|
2166
2646
|
KlaviyoAPI::Flows.delete_flow(id)
|
|
@@ -2170,7 +2650,17 @@ KlaviyoAPI::Flows.delete_flow(id)
|
|
|
2170
2650
|
|
|
2171
2651
|
|
|
2172
2652
|
|
|
2173
|
-
#### [
|
|
2653
|
+
#### [Delete Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_flow_action)
|
|
2654
|
+
|
|
2655
|
+
```ruby
|
|
2656
|
+
KlaviyoAPI::Flows.delete_flow_action(id)
|
|
2657
|
+
```
|
|
2658
|
+
|
|
2659
|
+
|
|
2660
|
+
|
|
2661
|
+
|
|
2662
|
+
|
|
2663
|
+
#### [Get Action for Flow Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_action_for_flow_message)
|
|
2174
2664
|
|
|
2175
2665
|
```ruby
|
|
2176
2666
|
KlaviyoAPI::Flows.get_action_for_flow_message(id, opts)
|
|
@@ -2184,7 +2674,7 @@ KlaviyoAPI::Flows.get_flow_message_action(id, opts)
|
|
|
2184
2674
|
|
|
2185
2675
|
|
|
2186
2676
|
|
|
2187
|
-
#### [Get Action ID for Flow Message](https://developers.klaviyo.com/en/v2026-
|
|
2677
|
+
#### [Get Action ID for Flow Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_action_id_for_flow_message)
|
|
2188
2678
|
|
|
2189
2679
|
```ruby
|
|
2190
2680
|
KlaviyoAPI::Flows.get_action_id_for_flow_message(id)
|
|
@@ -2198,7 +2688,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
|
|
|
2198
2688
|
|
|
2199
2689
|
|
|
2200
2690
|
|
|
2201
|
-
#### [Get Action IDs for Flow](https://developers.klaviyo.com/en/v2026-
|
|
2691
|
+
#### [Get Action IDs for Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/get_action_ids_for_flow)
|
|
2202
2692
|
|
|
2203
2693
|
```ruby
|
|
2204
2694
|
KlaviyoAPI::Flows.get_action_ids_for_flow(id, opts)
|
|
@@ -2216,7 +2706,7 @@ KlaviyoAPI::Flows.get_flow_relationships_actions(id, opts)
|
|
|
2216
2706
|
|
|
2217
2707
|
|
|
2218
2708
|
|
|
2219
|
-
#### [Get Actions for Flow](https://developers.klaviyo.com/en/v2026-
|
|
2709
|
+
#### [Get Actions for Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/get_actions_for_flow)
|
|
2220
2710
|
|
|
2221
2711
|
```ruby
|
|
2222
2712
|
KlaviyoAPI::Flows.get_actions_for_flow(id, opts)
|
|
@@ -2234,7 +2724,7 @@ KlaviyoAPI::Flows.get_flow_actions(id, opts)
|
|
|
2234
2724
|
|
|
2235
2725
|
|
|
2236
2726
|
|
|
2237
|
-
#### [Get Flow](https://developers.klaviyo.com/en/v2026-
|
|
2727
|
+
#### [Get Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow)
|
|
2238
2728
|
|
|
2239
2729
|
```ruby
|
|
2240
2730
|
KlaviyoAPI::Flows.get_flow(id, opts)
|
|
@@ -2244,7 +2734,7 @@ KlaviyoAPI::Flows.get_flow(id, opts)
|
|
|
2244
2734
|
|
|
2245
2735
|
|
|
2246
2736
|
|
|
2247
|
-
#### [Get Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
2737
|
+
#### [Get Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow_action)
|
|
2248
2738
|
|
|
2249
2739
|
```ruby
|
|
2250
2740
|
KlaviyoAPI::Flows.get_flow_action(id, opts)
|
|
@@ -2254,7 +2744,7 @@ KlaviyoAPI::Flows.get_flow_action(id, opts)
|
|
|
2254
2744
|
|
|
2255
2745
|
|
|
2256
2746
|
|
|
2257
|
-
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
2747
|
+
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow_action_messages)
|
|
2258
2748
|
|
|
2259
2749
|
```ruby
|
|
2260
2750
|
KlaviyoAPI::Flows.get_flow_action_messages(id, opts)
|
|
@@ -2268,7 +2758,7 @@ KlaviyoAPI::Flows.get_messages_for_flow_action(id, opts)
|
|
|
2268
2758
|
|
|
2269
2759
|
|
|
2270
2760
|
|
|
2271
|
-
#### [Get Flow for Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
2761
|
+
#### [Get Flow for Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow_for_flow_action)
|
|
2272
2762
|
|
|
2273
2763
|
```ruby
|
|
2274
2764
|
KlaviyoAPI::Flows.get_flow_for_flow_action(id, opts)
|
|
@@ -2282,7 +2772,7 @@ KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
|
|
|
2282
2772
|
|
|
2283
2773
|
|
|
2284
2774
|
|
|
2285
|
-
#### [Get Flow ID for Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
2775
|
+
#### [Get Flow ID for Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow_id_for_flow_action)
|
|
2286
2776
|
|
|
2287
2777
|
```ruby
|
|
2288
2778
|
KlaviyoAPI::Flows.get_flow_id_for_flow_action(id)
|
|
@@ -2296,7 +2786,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
|
|
|
2296
2786
|
|
|
2297
2787
|
|
|
2298
2788
|
|
|
2299
|
-
#### [Get Flow Message](https://developers.klaviyo.com/en/v2026-
|
|
2789
|
+
#### [Get Flow Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow_message)
|
|
2300
2790
|
|
|
2301
2791
|
```ruby
|
|
2302
2792
|
KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
@@ -2306,7 +2796,7 @@ KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
|
2306
2796
|
|
|
2307
2797
|
|
|
2308
2798
|
|
|
2309
|
-
#### [Get Flows](https://developers.klaviyo.com/en/v2026-
|
|
2799
|
+
#### [Get Flows](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flows)
|
|
2310
2800
|
|
|
2311
2801
|
```ruby
|
|
2312
2802
|
KlaviyoAPI::Flows.get_flows(opts)
|
|
@@ -2316,7 +2806,7 @@ KlaviyoAPI::Flows.get_flows(opts)
|
|
|
2316
2806
|
|
|
2317
2807
|
|
|
2318
2808
|
|
|
2319
|
-
#### [Get Message IDs for Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
2809
|
+
#### [Get Message IDs for Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/get_message_ids_for_flow_action)
|
|
2320
2810
|
|
|
2321
2811
|
```ruby
|
|
2322
2812
|
KlaviyoAPI::Flows.get_message_ids_for_flow_action(id, opts)
|
|
@@ -2330,7 +2820,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
|
|
|
2330
2820
|
|
|
2331
2821
|
|
|
2332
2822
|
|
|
2333
|
-
#### [Get Tag IDs for Flow](https://developers.klaviyo.com/en/v2026-
|
|
2823
|
+
#### [Get Tag IDs for Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_ids_for_flow)
|
|
2334
2824
|
|
|
2335
2825
|
```ruby
|
|
2336
2826
|
KlaviyoAPI::Flows.get_tag_ids_for_flow(id)
|
|
@@ -2344,7 +2834,7 @@ KlaviyoAPI::Flows.get_flow_relationships_tags(id)
|
|
|
2344
2834
|
|
|
2345
2835
|
|
|
2346
2836
|
|
|
2347
|
-
#### [Get Tags for Flow](https://developers.klaviyo.com/en/v2026-
|
|
2837
|
+
#### [Get Tags for Flow](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tags_for_flow)
|
|
2348
2838
|
|
|
2349
2839
|
```ruby
|
|
2350
2840
|
KlaviyoAPI::Flows.get_tags_for_flow(id, opts)
|
|
@@ -2358,7 +2848,7 @@ KlaviyoAPI::Flows.get_flow_tags(id, opts)
|
|
|
2358
2848
|
|
|
2359
2849
|
|
|
2360
2850
|
|
|
2361
|
-
#### [Get Template for Flow Message](https://developers.klaviyo.com/en/v2026-
|
|
2851
|
+
#### [Get Template for Flow Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_template_for_flow_message)
|
|
2362
2852
|
|
|
2363
2853
|
```ruby
|
|
2364
2854
|
KlaviyoAPI::Flows.get_template_for_flow_message(id, opts)
|
|
@@ -2372,7 +2862,7 @@ KlaviyoAPI::Flows.get_flow_message_template(id, opts)
|
|
|
2372
2862
|
|
|
2373
2863
|
|
|
2374
2864
|
|
|
2375
|
-
#### [Get Template ID for Flow Message](https://developers.klaviyo.com/en/v2026-
|
|
2865
|
+
#### [Get Template ID for Flow Message](https://developers.klaviyo.com/en/v2026-07-15/reference/get_template_id_for_flow_message)
|
|
2376
2866
|
|
|
2377
2867
|
```ruby
|
|
2378
2868
|
KlaviyoAPI::Flows.get_template_id_for_flow_message(id)
|
|
@@ -2386,20 +2876,20 @@ KlaviyoAPI::Flows.get_flow_message_relationships_template(id)
|
|
|
2386
2876
|
|
|
2387
2877
|
|
|
2388
2878
|
|
|
2389
|
-
#### [Update Flow Status](https://developers.klaviyo.com/en/v2026-
|
|
2879
|
+
#### [Update Flow Status](https://developers.klaviyo.com/en/v2026-07-15/reference/update_flow)
|
|
2390
2880
|
|
|
2391
2881
|
```ruby
|
|
2392
|
-
KlaviyoAPI::Flows.update_flow(id, body)
|
|
2882
|
+
KlaviyoAPI::Flows.update_flow(id, body, opts)
|
|
2393
2883
|
```
|
|
2394
2884
|
|
|
2395
2885
|
|
|
2396
2886
|
|
|
2397
2887
|
|
|
2398
2888
|
|
|
2399
|
-
#### [Update Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
2889
|
+
#### [Update Flow Action](https://developers.klaviyo.com/en/v2026-07-15/reference/update_flow_action)
|
|
2400
2890
|
|
|
2401
2891
|
```ruby
|
|
2402
|
-
KlaviyoAPI::Flows.update_flow_action(id, body)
|
|
2892
|
+
KlaviyoAPI::Flows.update_flow_action(id, body, opts)
|
|
2403
2893
|
```
|
|
2404
2894
|
|
|
2405
2895
|
|
|
@@ -2410,17 +2900,17 @@ KlaviyoAPI::Flows.update_flow_action(id, body)
|
|
|
2410
2900
|
## Forms
|
|
2411
2901
|
|
|
2412
2902
|
|
|
2413
|
-
#### [Create Form](https://developers.klaviyo.com/en/v2026-
|
|
2903
|
+
#### [Create Form](https://developers.klaviyo.com/en/v2026-07-15/reference/create_form)
|
|
2414
2904
|
|
|
2415
2905
|
```ruby
|
|
2416
|
-
KlaviyoAPI::Forms.create_form(body)
|
|
2906
|
+
KlaviyoAPI::Forms.create_form(body, opts)
|
|
2417
2907
|
```
|
|
2418
2908
|
|
|
2419
2909
|
|
|
2420
2910
|
|
|
2421
2911
|
|
|
2422
2912
|
|
|
2423
|
-
#### [Delete Form](https://developers.klaviyo.com/en/v2026-
|
|
2913
|
+
#### [Delete Form](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_form)
|
|
2424
2914
|
|
|
2425
2915
|
```ruby
|
|
2426
2916
|
KlaviyoAPI::Forms.delete_form(id)
|
|
@@ -2430,7 +2920,7 @@ KlaviyoAPI::Forms.delete_form(id)
|
|
|
2430
2920
|
|
|
2431
2921
|
|
|
2432
2922
|
|
|
2433
|
-
#### [Get Form](https://developers.klaviyo.com/en/v2026-
|
|
2923
|
+
#### [Get Form](https://developers.klaviyo.com/en/v2026-07-15/reference/get_form)
|
|
2434
2924
|
|
|
2435
2925
|
```ruby
|
|
2436
2926
|
KlaviyoAPI::Forms.get_form(id, opts)
|
|
@@ -2440,7 +2930,7 @@ KlaviyoAPI::Forms.get_form(id, opts)
|
|
|
2440
2930
|
|
|
2441
2931
|
|
|
2442
2932
|
|
|
2443
|
-
#### [Get Form for Form Version](https://developers.klaviyo.com/en/v2026-
|
|
2933
|
+
#### [Get Form for Form Version](https://developers.klaviyo.com/en/v2026-07-15/reference/get_form_for_form_version)
|
|
2444
2934
|
|
|
2445
2935
|
```ruby
|
|
2446
2936
|
KlaviyoAPI::Forms.get_form_for_form_version(id, opts)
|
|
@@ -2454,7 +2944,7 @@ KlaviyoAPI::Forms.get_form_version_form(id, opts)
|
|
|
2454
2944
|
|
|
2455
2945
|
|
|
2456
2946
|
|
|
2457
|
-
#### [Get Form ID for Form Version](https://developers.klaviyo.com/en/v2026-
|
|
2947
|
+
#### [Get Form ID for Form Version](https://developers.klaviyo.com/en/v2026-07-15/reference/get_form_id_for_form_version)
|
|
2458
2948
|
|
|
2459
2949
|
```ruby
|
|
2460
2950
|
KlaviyoAPI::Forms.get_form_id_for_form_version(id)
|
|
@@ -2468,7 +2958,7 @@ KlaviyoAPI::Forms.get_form_version_relationships_form(id)
|
|
|
2468
2958
|
|
|
2469
2959
|
|
|
2470
2960
|
|
|
2471
|
-
#### [Get Form Version](https://developers.klaviyo.com/en/v2026-
|
|
2961
|
+
#### [Get Form Version](https://developers.klaviyo.com/en/v2026-07-15/reference/get_form_version)
|
|
2472
2962
|
|
|
2473
2963
|
```ruby
|
|
2474
2964
|
KlaviyoAPI::Forms.get_form_version(id, opts)
|
|
@@ -2478,7 +2968,7 @@ KlaviyoAPI::Forms.get_form_version(id, opts)
|
|
|
2478
2968
|
|
|
2479
2969
|
|
|
2480
2970
|
|
|
2481
|
-
#### [Get Forms](https://developers.klaviyo.com/en/v2026-
|
|
2971
|
+
#### [Get Forms](https://developers.klaviyo.com/en/v2026-07-15/reference/get_forms)
|
|
2482
2972
|
|
|
2483
2973
|
```ruby
|
|
2484
2974
|
KlaviyoAPI::Forms.get_forms(opts)
|
|
@@ -2488,7 +2978,7 @@ KlaviyoAPI::Forms.get_forms(opts)
|
|
|
2488
2978
|
|
|
2489
2979
|
|
|
2490
2980
|
|
|
2491
|
-
#### [Get Version IDs for Form](https://developers.klaviyo.com/en/v2026-
|
|
2981
|
+
#### [Get Version IDs for Form](https://developers.klaviyo.com/en/v2026-07-15/reference/get_version_ids_for_form)
|
|
2492
2982
|
|
|
2493
2983
|
```ruby
|
|
2494
2984
|
KlaviyoAPI::Forms.get_version_ids_for_form(id, opts)
|
|
@@ -2506,7 +2996,7 @@ KlaviyoAPI::Forms.get_form_relationships_versions(id, opts)
|
|
|
2506
2996
|
|
|
2507
2997
|
|
|
2508
2998
|
|
|
2509
|
-
#### [Get Versions for Form](https://developers.klaviyo.com/en/v2026-
|
|
2999
|
+
#### [Get Versions for Form](https://developers.klaviyo.com/en/v2026-07-15/reference/get_versions_for_form)
|
|
2510
3000
|
|
|
2511
3001
|
```ruby
|
|
2512
3002
|
KlaviyoAPI::Forms.get_versions_for_form(id, opts)
|
|
@@ -2528,7 +3018,7 @@ KlaviyoAPI::Forms.get_form_versions(id, opts)
|
|
|
2528
3018
|
## Images
|
|
2529
3019
|
|
|
2530
3020
|
|
|
2531
|
-
#### [Get Image](https://developers.klaviyo.com/en/v2026-
|
|
3021
|
+
#### [Get Image](https://developers.klaviyo.com/en/v2026-07-15/reference/get_image)
|
|
2532
3022
|
|
|
2533
3023
|
```ruby
|
|
2534
3024
|
KlaviyoAPI::Images.get_image(id, opts)
|
|
@@ -2538,7 +3028,7 @@ KlaviyoAPI::Images.get_image(id, opts)
|
|
|
2538
3028
|
|
|
2539
3029
|
|
|
2540
3030
|
|
|
2541
|
-
#### [Get Images](https://developers.klaviyo.com/en/v2026-
|
|
3031
|
+
#### [Get Images](https://developers.klaviyo.com/en/v2026-07-15/reference/get_images)
|
|
2542
3032
|
|
|
2543
3033
|
```ruby
|
|
2544
3034
|
KlaviyoAPI::Images.get_images(opts)
|
|
@@ -2548,17 +3038,17 @@ KlaviyoAPI::Images.get_images(opts)
|
|
|
2548
3038
|
|
|
2549
3039
|
|
|
2550
3040
|
|
|
2551
|
-
#### [Update Image](https://developers.klaviyo.com/en/v2026-
|
|
3041
|
+
#### [Update Image](https://developers.klaviyo.com/en/v2026-07-15/reference/update_image)
|
|
2552
3042
|
|
|
2553
3043
|
```ruby
|
|
2554
|
-
KlaviyoAPI::Images.update_image(id, body)
|
|
3044
|
+
KlaviyoAPI::Images.update_image(id, body, opts)
|
|
2555
3045
|
```
|
|
2556
3046
|
|
|
2557
3047
|
|
|
2558
3048
|
|
|
2559
3049
|
|
|
2560
3050
|
|
|
2561
|
-
#### [Upload Image From File](https://developers.klaviyo.com/en/v2026-
|
|
3051
|
+
#### [Upload Image From File](https://developers.klaviyo.com/en/v2026-07-15/reference/upload_image_from_file)
|
|
2562
3052
|
|
|
2563
3053
|
```ruby
|
|
2564
3054
|
KlaviyoAPI::Images.upload_image_from_file(file, opts)
|
|
@@ -2572,14 +3062,14 @@ KlaviyoAPI::Images.create_image_upload(file, opts)
|
|
|
2572
3062
|
|
|
2573
3063
|
|
|
2574
3064
|
|
|
2575
|
-
#### [Upload Image From URL](https://developers.klaviyo.com/en/v2026-
|
|
3065
|
+
#### [Upload Image From URL](https://developers.klaviyo.com/en/v2026-07-15/reference/upload_image_from_url)
|
|
2576
3066
|
|
|
2577
3067
|
```ruby
|
|
2578
|
-
KlaviyoAPI::Images.upload_image_from_url(body)
|
|
3068
|
+
KlaviyoAPI::Images.upload_image_from_url(body, opts)
|
|
2579
3069
|
```
|
|
2580
3070
|
##### Method alias:
|
|
2581
3071
|
```ruby
|
|
2582
|
-
KlaviyoAPI::Images.create_image(body)
|
|
3072
|
+
KlaviyoAPI::Images.create_image(body, opts)
|
|
2583
3073
|
```
|
|
2584
3074
|
|
|
2585
3075
|
|
|
@@ -2590,7 +3080,7 @@ KlaviyoAPI::Images.create_image(body)
|
|
|
2590
3080
|
## Lists
|
|
2591
3081
|
|
|
2592
3082
|
|
|
2593
|
-
#### [Add Profiles to List](https://developers.klaviyo.com/en/v2026-
|
|
3083
|
+
#### [Add Profiles to List](https://developers.klaviyo.com/en/v2026-07-15/reference/add_profiles_to_list)
|
|
2594
3084
|
|
|
2595
3085
|
```ruby
|
|
2596
3086
|
KlaviyoAPI::Lists.add_profiles_to_list(id, body)
|
|
@@ -2612,17 +3102,17 @@ KlaviyoAPI::Lists.create_list_relationships_profiles(id, body)
|
|
|
2612
3102
|
|
|
2613
3103
|
|
|
2614
3104
|
|
|
2615
|
-
#### [Create List](https://developers.klaviyo.com/en/v2026-
|
|
3105
|
+
#### [Create List](https://developers.klaviyo.com/en/v2026-07-15/reference/create_list)
|
|
2616
3106
|
|
|
2617
3107
|
```ruby
|
|
2618
|
-
KlaviyoAPI::Lists.create_list(body)
|
|
3108
|
+
KlaviyoAPI::Lists.create_list(body, opts)
|
|
2619
3109
|
```
|
|
2620
3110
|
|
|
2621
3111
|
|
|
2622
3112
|
|
|
2623
3113
|
|
|
2624
3114
|
|
|
2625
|
-
#### [Delete List](https://developers.klaviyo.com/en/v2026-
|
|
3115
|
+
#### [Delete List](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_list)
|
|
2626
3116
|
|
|
2627
3117
|
```ruby
|
|
2628
3118
|
KlaviyoAPI::Lists.delete_list(id)
|
|
@@ -2632,7 +3122,7 @@ KlaviyoAPI::Lists.delete_list(id)
|
|
|
2632
3122
|
|
|
2633
3123
|
|
|
2634
3124
|
|
|
2635
|
-
#### [Get Flows Triggered by List](https://developers.klaviyo.com/en/v2026-
|
|
3125
|
+
#### [Get Flows Triggered by List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flows_triggered_by_list)
|
|
2636
3126
|
|
|
2637
3127
|
```ruby
|
|
2638
3128
|
KlaviyoAPI::Lists.get_flows_triggered_by_list(id, opts)
|
|
@@ -2650,7 +3140,7 @@ KlaviyoAPI::Lists.get_list_flow_triggers(id, opts)
|
|
|
2650
3140
|
|
|
2651
3141
|
|
|
2652
3142
|
|
|
2653
|
-
#### [Get IDs for Flows Triggered by List](https://developers.klaviyo.com/en/v2026-
|
|
3143
|
+
#### [Get IDs for Flows Triggered by List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_ids_for_flows_triggered_by_list)
|
|
2654
3144
|
|
|
2655
3145
|
```ruby
|
|
2656
3146
|
KlaviyoAPI::Lists.get_ids_for_flows_triggered_by_list(id)
|
|
@@ -2668,7 +3158,7 @@ KlaviyoAPI::Lists.get_list_relationships_flow_triggers(id)
|
|
|
2668
3158
|
|
|
2669
3159
|
|
|
2670
3160
|
|
|
2671
|
-
#### [Get List](https://developers.klaviyo.com/en/v2026-
|
|
3161
|
+
#### [Get List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_list)
|
|
2672
3162
|
|
|
2673
3163
|
```ruby
|
|
2674
3164
|
KlaviyoAPI::Lists.get_list(id, opts)
|
|
@@ -2678,7 +3168,7 @@ KlaviyoAPI::Lists.get_list(id, opts)
|
|
|
2678
3168
|
|
|
2679
3169
|
|
|
2680
3170
|
|
|
2681
|
-
#### [Get Lists](https://developers.klaviyo.com/en/v2026-
|
|
3171
|
+
#### [Get Lists](https://developers.klaviyo.com/en/v2026-07-15/reference/get_lists)
|
|
2682
3172
|
|
|
2683
3173
|
```ruby
|
|
2684
3174
|
KlaviyoAPI::Lists.get_lists(opts)
|
|
@@ -2688,7 +3178,7 @@ KlaviyoAPI::Lists.get_lists(opts)
|
|
|
2688
3178
|
|
|
2689
3179
|
|
|
2690
3180
|
|
|
2691
|
-
#### [Get Profile IDs for List](https://developers.klaviyo.com/en/v2026-
|
|
3181
|
+
#### [Get Profile IDs for List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_ids_for_list)
|
|
2692
3182
|
|
|
2693
3183
|
```ruby
|
|
2694
3184
|
KlaviyoAPI::Lists.get_profile_ids_for_list(id, opts)
|
|
@@ -2702,7 +3192,7 @@ KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
|
|
|
2702
3192
|
|
|
2703
3193
|
|
|
2704
3194
|
|
|
2705
|
-
#### [Get Profiles for List](https://developers.klaviyo.com/en/v2026-
|
|
3195
|
+
#### [Get Profiles for List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profiles_for_list)
|
|
2706
3196
|
|
|
2707
3197
|
```ruby
|
|
2708
3198
|
KlaviyoAPI::Lists.get_profiles_for_list(id, opts)
|
|
@@ -2716,7 +3206,7 @@ KlaviyoAPI::Lists.get_list_profiles(id, opts)
|
|
|
2716
3206
|
|
|
2717
3207
|
|
|
2718
3208
|
|
|
2719
|
-
#### [Get Tag IDs for List](https://developers.klaviyo.com/en/v2026-
|
|
3209
|
+
#### [Get Tag IDs for List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_ids_for_list)
|
|
2720
3210
|
|
|
2721
3211
|
```ruby
|
|
2722
3212
|
KlaviyoAPI::Lists.get_tag_ids_for_list(id)
|
|
@@ -2730,7 +3220,7 @@ KlaviyoAPI::Lists.get_list_relationships_tags(id)
|
|
|
2730
3220
|
|
|
2731
3221
|
|
|
2732
3222
|
|
|
2733
|
-
#### [Get Tags for List](https://developers.klaviyo.com/en/v2026-
|
|
3223
|
+
#### [Get Tags for List](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tags_for_list)
|
|
2734
3224
|
|
|
2735
3225
|
```ruby
|
|
2736
3226
|
KlaviyoAPI::Lists.get_tags_for_list(id, opts)
|
|
@@ -2744,7 +3234,7 @@ KlaviyoAPI::Lists.get_list_tags(id, opts)
|
|
|
2744
3234
|
|
|
2745
3235
|
|
|
2746
3236
|
|
|
2747
|
-
#### [Remove Profiles from List](https://developers.klaviyo.com/en/v2026-
|
|
3237
|
+
#### [Remove Profiles from List](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_profiles_from_list)
|
|
2748
3238
|
|
|
2749
3239
|
```ruby
|
|
2750
3240
|
KlaviyoAPI::Lists.remove_profiles_from_list(id, body)
|
|
@@ -2762,10 +3252,10 @@ KlaviyoAPI::Lists.delete_list_relationships_profiles(id, body)
|
|
|
2762
3252
|
|
|
2763
3253
|
|
|
2764
3254
|
|
|
2765
|
-
#### [Update List](https://developers.klaviyo.com/en/v2026-
|
|
3255
|
+
#### [Update List](https://developers.klaviyo.com/en/v2026-07-15/reference/update_list)
|
|
2766
3256
|
|
|
2767
3257
|
```ruby
|
|
2768
|
-
KlaviyoAPI::Lists.update_list(id, body)
|
|
3258
|
+
KlaviyoAPI::Lists.update_list(id, body, opts)
|
|
2769
3259
|
```
|
|
2770
3260
|
|
|
2771
3261
|
|
|
@@ -2776,17 +3266,17 @@ KlaviyoAPI::Lists.update_list(id, body)
|
|
|
2776
3266
|
## Metrics
|
|
2777
3267
|
|
|
2778
3268
|
|
|
2779
|
-
#### [Create Custom Metric](https://developers.klaviyo.com/en/v2026-
|
|
3269
|
+
#### [Create Custom Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/create_custom_metric)
|
|
2780
3270
|
|
|
2781
3271
|
```ruby
|
|
2782
|
-
KlaviyoAPI::Metrics.create_custom_metric(body)
|
|
3272
|
+
KlaviyoAPI::Metrics.create_custom_metric(body, opts)
|
|
2783
3273
|
```
|
|
2784
3274
|
|
|
2785
3275
|
|
|
2786
3276
|
|
|
2787
3277
|
|
|
2788
3278
|
|
|
2789
|
-
#### [Delete Custom Metric](https://developers.klaviyo.com/en/v2026-
|
|
3279
|
+
#### [Delete Custom Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_custom_metric)
|
|
2790
3280
|
|
|
2791
3281
|
```ruby
|
|
2792
3282
|
KlaviyoAPI::Metrics.delete_custom_metric(id)
|
|
@@ -2796,7 +3286,7 @@ KlaviyoAPI::Metrics.delete_custom_metric(id)
|
|
|
2796
3286
|
|
|
2797
3287
|
|
|
2798
3288
|
|
|
2799
|
-
#### [Get Custom Metric](https://developers.klaviyo.com/en/v2026-
|
|
3289
|
+
#### [Get Custom Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_custom_metric)
|
|
2800
3290
|
|
|
2801
3291
|
```ruby
|
|
2802
3292
|
KlaviyoAPI::Metrics.get_custom_metric(id, opts)
|
|
@@ -2806,7 +3296,7 @@ KlaviyoAPI::Metrics.get_custom_metric(id, opts)
|
|
|
2806
3296
|
|
|
2807
3297
|
|
|
2808
3298
|
|
|
2809
|
-
#### [Get Custom Metric for Mapped Metric](https://developers.klaviyo.com/en/v2026-
|
|
3299
|
+
#### [Get Custom Metric for Mapped Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_custom_metric_for_mapped_metric)
|
|
2810
3300
|
|
|
2811
3301
|
```ruby
|
|
2812
3302
|
KlaviyoAPI::Metrics.get_custom_metric_for_mapped_metric(id, opts)
|
|
@@ -2820,7 +3310,7 @@ KlaviyoAPI::Metrics.get_mapped_metric_custom_metric(id, opts)
|
|
|
2820
3310
|
|
|
2821
3311
|
|
|
2822
3312
|
|
|
2823
|
-
#### [Get Custom Metric ID for Mapped Metric](https://developers.klaviyo.com/en/v2026-
|
|
3313
|
+
#### [Get Custom Metric ID for Mapped Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_custom_metric_id_for_mapped_metric)
|
|
2824
3314
|
|
|
2825
3315
|
```ruby
|
|
2826
3316
|
KlaviyoAPI::Metrics.get_custom_metric_id_for_mapped_metric(id)
|
|
@@ -2834,7 +3324,7 @@ KlaviyoAPI::Metrics.get_mapped_metric_relationships_custom_metric(id)
|
|
|
2834
3324
|
|
|
2835
3325
|
|
|
2836
3326
|
|
|
2837
|
-
#### [Get Custom Metrics](https://developers.klaviyo.com/en/v2026-
|
|
3327
|
+
#### [Get Custom Metrics](https://developers.klaviyo.com/en/v2026-07-15/reference/get_custom_metrics)
|
|
2838
3328
|
|
|
2839
3329
|
```ruby
|
|
2840
3330
|
KlaviyoAPI::Metrics.get_custom_metrics(opts)
|
|
@@ -2844,7 +3334,7 @@ KlaviyoAPI::Metrics.get_custom_metrics(opts)
|
|
|
2844
3334
|
|
|
2845
3335
|
|
|
2846
3336
|
|
|
2847
|
-
#### [Get Flows Triggered by Metric](https://developers.klaviyo.com/en/v2026-
|
|
3337
|
+
#### [Get Flows Triggered by Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flows_triggered_by_metric)
|
|
2848
3338
|
|
|
2849
3339
|
```ruby
|
|
2850
3340
|
KlaviyoAPI::Metrics.get_flows_triggered_by_metric(id, opts)
|
|
@@ -2862,7 +3352,7 @@ KlaviyoAPI::Metrics.get_metric_flow_triggers(id, opts)
|
|
|
2862
3352
|
|
|
2863
3353
|
|
|
2864
3354
|
|
|
2865
|
-
#### [Get IDs for Flows Triggered by Metric](https://developers.klaviyo.com/en/v2026-
|
|
3355
|
+
#### [Get IDs for Flows Triggered by Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_ids_for_flows_triggered_by_metric)
|
|
2866
3356
|
|
|
2867
3357
|
```ruby
|
|
2868
3358
|
KlaviyoAPI::Metrics.get_ids_for_flows_triggered_by_metric(id)
|
|
@@ -2880,7 +3370,7 @@ KlaviyoAPI::Metrics.get_metric_relationships_flow_triggers(id)
|
|
|
2880
3370
|
|
|
2881
3371
|
|
|
2882
3372
|
|
|
2883
|
-
#### [Get Mapped Metric](https://developers.klaviyo.com/en/v2026-
|
|
3373
|
+
#### [Get Mapped Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_mapped_metric)
|
|
2884
3374
|
|
|
2885
3375
|
```ruby
|
|
2886
3376
|
KlaviyoAPI::Metrics.get_mapped_metric(id, opts)
|
|
@@ -2890,7 +3380,7 @@ KlaviyoAPI::Metrics.get_mapped_metric(id, opts)
|
|
|
2890
3380
|
|
|
2891
3381
|
|
|
2892
3382
|
|
|
2893
|
-
#### [Get Mapped Metrics](https://developers.klaviyo.com/en/v2026-
|
|
3383
|
+
#### [Get Mapped Metrics](https://developers.klaviyo.com/en/v2026-07-15/reference/get_mapped_metrics)
|
|
2894
3384
|
|
|
2895
3385
|
```ruby
|
|
2896
3386
|
KlaviyoAPI::Metrics.get_mapped_metrics(opts)
|
|
@@ -2900,7 +3390,7 @@ KlaviyoAPI::Metrics.get_mapped_metrics(opts)
|
|
|
2900
3390
|
|
|
2901
3391
|
|
|
2902
3392
|
|
|
2903
|
-
#### [Get Metric](https://developers.klaviyo.com/en/v2026-
|
|
3393
|
+
#### [Get Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric)
|
|
2904
3394
|
|
|
2905
3395
|
```ruby
|
|
2906
3396
|
KlaviyoAPI::Metrics.get_metric(id, opts)
|
|
@@ -2910,7 +3400,7 @@ KlaviyoAPI::Metrics.get_metric(id, opts)
|
|
|
2910
3400
|
|
|
2911
3401
|
|
|
2912
3402
|
|
|
2913
|
-
#### [Get Metric for Mapped Metric](https://developers.klaviyo.com/en/v2026-
|
|
3403
|
+
#### [Get Metric for Mapped Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_for_mapped_metric)
|
|
2914
3404
|
|
|
2915
3405
|
```ruby
|
|
2916
3406
|
KlaviyoAPI::Metrics.get_metric_for_mapped_metric(id, opts)
|
|
@@ -2924,7 +3414,7 @@ KlaviyoAPI::Metrics.get_mapped_metric_metric(id, opts)
|
|
|
2924
3414
|
|
|
2925
3415
|
|
|
2926
3416
|
|
|
2927
|
-
#### [Get Metric for Metric Property](https://developers.klaviyo.com/en/v2026-
|
|
3417
|
+
#### [Get Metric for Metric Property](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_for_metric_property)
|
|
2928
3418
|
|
|
2929
3419
|
```ruby
|
|
2930
3420
|
KlaviyoAPI::Metrics.get_metric_for_metric_property(id, opts)
|
|
@@ -2938,7 +3428,7 @@ KlaviyoAPI::Metrics.get_metric_property_metric(id, opts)
|
|
|
2938
3428
|
|
|
2939
3429
|
|
|
2940
3430
|
|
|
2941
|
-
#### [Get Metric ID for Mapped Metric](https://developers.klaviyo.com/en/v2026-
|
|
3431
|
+
#### [Get Metric ID for Mapped Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_id_for_mapped_metric)
|
|
2942
3432
|
|
|
2943
3433
|
```ruby
|
|
2944
3434
|
KlaviyoAPI::Metrics.get_metric_id_for_mapped_metric(id)
|
|
@@ -2952,7 +3442,7 @@ KlaviyoAPI::Metrics.get_mapped_metric_relationships_metric(id)
|
|
|
2952
3442
|
|
|
2953
3443
|
|
|
2954
3444
|
|
|
2955
|
-
#### [Get Metric ID for Metric Property](https://developers.klaviyo.com/en/v2026-
|
|
3445
|
+
#### [Get Metric ID for Metric Property](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_id_for_metric_property)
|
|
2956
3446
|
|
|
2957
3447
|
```ruby
|
|
2958
3448
|
KlaviyoAPI::Metrics.get_metric_id_for_metric_property(id)
|
|
@@ -2966,7 +3456,7 @@ KlaviyoAPI::Metrics.get_metric_property_relationships_metric(id)
|
|
|
2966
3456
|
|
|
2967
3457
|
|
|
2968
3458
|
|
|
2969
|
-
#### [Get Metric IDs for Custom Metric](https://developers.klaviyo.com/en/v2026-
|
|
3459
|
+
#### [Get Metric IDs for Custom Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_ids_for_custom_metric)
|
|
2970
3460
|
|
|
2971
3461
|
```ruby
|
|
2972
3462
|
KlaviyoAPI::Metrics.get_metric_ids_for_custom_metric(id)
|
|
@@ -2980,7 +3470,7 @@ KlaviyoAPI::Metrics.get_custom_metric_relationships_metrics(id)
|
|
|
2980
3470
|
|
|
2981
3471
|
|
|
2982
3472
|
|
|
2983
|
-
#### [Get Metric Property](https://developers.klaviyo.com/en/v2026-
|
|
3473
|
+
#### [Get Metric Property](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metric_property)
|
|
2984
3474
|
|
|
2985
3475
|
```ruby
|
|
2986
3476
|
KlaviyoAPI::Metrics.get_metric_property(id, opts)
|
|
@@ -2990,7 +3480,7 @@ KlaviyoAPI::Metrics.get_metric_property(id, opts)
|
|
|
2990
3480
|
|
|
2991
3481
|
|
|
2992
3482
|
|
|
2993
|
-
#### [Get Metrics](https://developers.klaviyo.com/en/v2026-
|
|
3483
|
+
#### [Get Metrics](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metrics)
|
|
2994
3484
|
|
|
2995
3485
|
```ruby
|
|
2996
3486
|
KlaviyoAPI::Metrics.get_metrics(opts)
|
|
@@ -3000,7 +3490,7 @@ KlaviyoAPI::Metrics.get_metrics(opts)
|
|
|
3000
3490
|
|
|
3001
3491
|
|
|
3002
3492
|
|
|
3003
|
-
#### [Get Metrics for Custom Metric](https://developers.klaviyo.com/en/v2026-
|
|
3493
|
+
#### [Get Metrics for Custom Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_metrics_for_custom_metric)
|
|
3004
3494
|
|
|
3005
3495
|
```ruby
|
|
3006
3496
|
KlaviyoAPI::Metrics.get_metrics_for_custom_metric(id, opts)
|
|
@@ -3014,7 +3504,7 @@ KlaviyoAPI::Metrics.get_custom_metric_metrics(id, opts)
|
|
|
3014
3504
|
|
|
3015
3505
|
|
|
3016
3506
|
|
|
3017
|
-
#### [Get Properties for Metric](https://developers.klaviyo.com/en/v2026-
|
|
3507
|
+
#### [Get Properties for Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_properties_for_metric)
|
|
3018
3508
|
|
|
3019
3509
|
```ruby
|
|
3020
3510
|
KlaviyoAPI::Metrics.get_properties_for_metric(id, opts)
|
|
@@ -3032,7 +3522,7 @@ KlaviyoAPI::Metrics.get_metric_properties(id, opts)
|
|
|
3032
3522
|
|
|
3033
3523
|
|
|
3034
3524
|
|
|
3035
|
-
#### [Get Property IDs for Metric](https://developers.klaviyo.com/en/v2026-
|
|
3525
|
+
#### [Get Property IDs for Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/get_property_ids_for_metric)
|
|
3036
3526
|
|
|
3037
3527
|
```ruby
|
|
3038
3528
|
KlaviyoAPI::Metrics.get_property_ids_for_metric(id)
|
|
@@ -3050,34 +3540,34 @@ KlaviyoAPI::Metrics.get_metric_relationships_properties(id)
|
|
|
3050
3540
|
|
|
3051
3541
|
|
|
3052
3542
|
|
|
3053
|
-
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2026-
|
|
3543
|
+
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2026-07-15/reference/query_metric_aggregates)
|
|
3054
3544
|
|
|
3055
3545
|
```ruby
|
|
3056
|
-
KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
|
3546
|
+
KlaviyoAPI::Metrics.query_metric_aggregates(body, opts)
|
|
3057
3547
|
```
|
|
3058
3548
|
##### Method alias:
|
|
3059
3549
|
```ruby
|
|
3060
|
-
KlaviyoAPI::Metrics.create_metric_aggregate(body)
|
|
3550
|
+
KlaviyoAPI::Metrics.create_metric_aggregate(body, opts)
|
|
3061
3551
|
```
|
|
3062
3552
|
|
|
3063
3553
|
|
|
3064
3554
|
|
|
3065
3555
|
|
|
3066
3556
|
|
|
3067
|
-
#### [Update Custom Metric](https://developers.klaviyo.com/en/v2026-
|
|
3557
|
+
#### [Update Custom Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/update_custom_metric)
|
|
3068
3558
|
|
|
3069
3559
|
```ruby
|
|
3070
|
-
KlaviyoAPI::Metrics.update_custom_metric(id, body)
|
|
3560
|
+
KlaviyoAPI::Metrics.update_custom_metric(id, body, opts)
|
|
3071
3561
|
```
|
|
3072
3562
|
|
|
3073
3563
|
|
|
3074
3564
|
|
|
3075
3565
|
|
|
3076
3566
|
|
|
3077
|
-
#### [Update Mapped Metric](https://developers.klaviyo.com/en/v2026-
|
|
3567
|
+
#### [Update Mapped Metric](https://developers.klaviyo.com/en/v2026-07-15/reference/update_mapped_metric)
|
|
3078
3568
|
|
|
3079
3569
|
```ruby
|
|
3080
|
-
KlaviyoAPI::Metrics.update_mapped_metric(id, body)
|
|
3570
|
+
KlaviyoAPI::Metrics.update_mapped_metric(id, body, opts)
|
|
3081
3571
|
```
|
|
3082
3572
|
|
|
3083
3573
|
|
|
@@ -3088,25 +3578,25 @@ KlaviyoAPI::Metrics.update_mapped_metric(id, body)
|
|
|
3088
3578
|
## Profiles
|
|
3089
3579
|
|
|
3090
3580
|
|
|
3091
|
-
#### [Bulk Import Profiles](https://developers.klaviyo.com/en/v2026-
|
|
3581
|
+
#### [Bulk Import Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_import_profiles)
|
|
3092
3582
|
|
|
3093
3583
|
```ruby
|
|
3094
|
-
KlaviyoAPI::Profiles.bulk_import_profiles(body)
|
|
3584
|
+
KlaviyoAPI::Profiles.bulk_import_profiles(body, opts)
|
|
3095
3585
|
```
|
|
3096
3586
|
##### Method alias:
|
|
3097
3587
|
```ruby
|
|
3098
|
-
KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body)
|
|
3588
|
+
KlaviyoAPI::Profiles.spawn_bulk_profile_import_job(body, opts)
|
|
3099
3589
|
```
|
|
3100
3590
|
##### Method alias:
|
|
3101
3591
|
```ruby
|
|
3102
|
-
KlaviyoAPI::Profiles.create_profile_bulk_import_job(body)
|
|
3592
|
+
KlaviyoAPI::Profiles.create_profile_bulk_import_job(body, opts)
|
|
3103
3593
|
```
|
|
3104
3594
|
|
|
3105
3595
|
|
|
3106
3596
|
|
|
3107
3597
|
|
|
3108
3598
|
|
|
3109
|
-
#### [Bulk Subscribe Profiles](https://developers.klaviyo.com/en/v2026-
|
|
3599
|
+
#### [Bulk Subscribe Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_subscribe_profiles)
|
|
3110
3600
|
|
|
3111
3601
|
```ruby
|
|
3112
3602
|
KlaviyoAPI::Profiles.bulk_subscribe_profiles(body)
|
|
@@ -3124,25 +3614,25 @@ KlaviyoAPI::Profiles.create_profile_subscription_bulk_create_job(body)
|
|
|
3124
3614
|
|
|
3125
3615
|
|
|
3126
3616
|
|
|
3127
|
-
#### [Bulk Suppress Profiles](https://developers.klaviyo.com/en/v2026-
|
|
3617
|
+
#### [Bulk Suppress Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_suppress_profiles)
|
|
3128
3618
|
|
|
3129
3619
|
```ruby
|
|
3130
|
-
KlaviyoAPI::Profiles.bulk_suppress_profiles(body)
|
|
3620
|
+
KlaviyoAPI::Profiles.bulk_suppress_profiles(body, opts)
|
|
3131
3621
|
```
|
|
3132
3622
|
##### Method alias:
|
|
3133
3623
|
```ruby
|
|
3134
|
-
KlaviyoAPI::Profiles.suppress_profiles(body)
|
|
3624
|
+
KlaviyoAPI::Profiles.suppress_profiles(body, opts)
|
|
3135
3625
|
```
|
|
3136
3626
|
##### Method alias:
|
|
3137
3627
|
```ruby
|
|
3138
|
-
KlaviyoAPI::Profiles.create_profile_suppression_bulk_create_job(body)
|
|
3628
|
+
KlaviyoAPI::Profiles.create_profile_suppression_bulk_create_job(body, opts)
|
|
3139
3629
|
```
|
|
3140
3630
|
|
|
3141
3631
|
|
|
3142
3632
|
|
|
3143
3633
|
|
|
3144
3634
|
|
|
3145
|
-
#### [Bulk Unsubscribe Profiles](https://developers.klaviyo.com/en/v2026-
|
|
3635
|
+
#### [Bulk Unsubscribe Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_unsubscribe_profiles)
|
|
3146
3636
|
|
|
3147
3637
|
```ruby
|
|
3148
3638
|
KlaviyoAPI::Profiles.bulk_unsubscribe_profiles(body)
|
|
@@ -3160,25 +3650,25 @@ KlaviyoAPI::Profiles.create_profile_subscription_bulk_delete_job(body)
|
|
|
3160
3650
|
|
|
3161
3651
|
|
|
3162
3652
|
|
|
3163
|
-
#### [Bulk Unsuppress Profiles](https://developers.klaviyo.com/en/v2026-
|
|
3653
|
+
#### [Bulk Unsuppress Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/bulk_unsuppress_profiles)
|
|
3164
3654
|
|
|
3165
3655
|
```ruby
|
|
3166
|
-
KlaviyoAPI::Profiles.bulk_unsuppress_profiles(body)
|
|
3656
|
+
KlaviyoAPI::Profiles.bulk_unsuppress_profiles(body, opts)
|
|
3167
3657
|
```
|
|
3168
3658
|
##### Method alias:
|
|
3169
3659
|
```ruby
|
|
3170
|
-
KlaviyoAPI::Profiles.unsuppress_profiles(body)
|
|
3660
|
+
KlaviyoAPI::Profiles.unsuppress_profiles(body, opts)
|
|
3171
3661
|
```
|
|
3172
3662
|
##### Method alias:
|
|
3173
3663
|
```ruby
|
|
3174
|
-
KlaviyoAPI::Profiles.create_profile_suppression_bulk_delete_job(body)
|
|
3664
|
+
KlaviyoAPI::Profiles.create_profile_suppression_bulk_delete_job(body, opts)
|
|
3175
3665
|
```
|
|
3176
3666
|
|
|
3177
3667
|
|
|
3178
3668
|
|
|
3179
3669
|
|
|
3180
3670
|
|
|
3181
|
-
#### [Create or Update Profile](https://developers.klaviyo.com/en/v2026-
|
|
3671
|
+
#### [Create or Update Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/create_or_update_profile)
|
|
3182
3672
|
|
|
3183
3673
|
```ruby
|
|
3184
3674
|
KlaviyoAPI::Profiles.create_or_update_profile(body, opts)
|
|
@@ -3192,7 +3682,7 @@ KlaviyoAPI::Profiles.create_profile_import(body, opts)
|
|
|
3192
3682
|
|
|
3193
3683
|
|
|
3194
3684
|
|
|
3195
|
-
#### [Create Profile](https://developers.klaviyo.com/en/v2026-
|
|
3685
|
+
#### [Create Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/create_profile)
|
|
3196
3686
|
|
|
3197
3687
|
```ruby
|
|
3198
3688
|
KlaviyoAPI::Profiles.create_profile(body, opts)
|
|
@@ -3202,7 +3692,7 @@ KlaviyoAPI::Profiles.create_profile(body, opts)
|
|
|
3202
3692
|
|
|
3203
3693
|
|
|
3204
3694
|
|
|
3205
|
-
#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2026-
|
|
3695
|
+
#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2026-07-15/reference/create_push_token)
|
|
3206
3696
|
|
|
3207
3697
|
```ruby
|
|
3208
3698
|
KlaviyoAPI::Profiles.create_push_token(body)
|
|
@@ -3212,7 +3702,7 @@ KlaviyoAPI::Profiles.create_push_token(body)
|
|
|
3212
3702
|
|
|
3213
3703
|
|
|
3214
3704
|
|
|
3215
|
-
#### [Delete Push Token](https://developers.klaviyo.com/en/v2026-
|
|
3705
|
+
#### [Delete Push Token](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_push_token)
|
|
3216
3706
|
|
|
3217
3707
|
```ruby
|
|
3218
3708
|
KlaviyoAPI::Profiles.delete_push_token(id)
|
|
@@ -3222,7 +3712,7 @@ KlaviyoAPI::Profiles.delete_push_token(id)
|
|
|
3222
3712
|
|
|
3223
3713
|
|
|
3224
3714
|
|
|
3225
|
-
#### [Get Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
3715
|
+
#### [Get Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_import_profiles_job)
|
|
3226
3716
|
|
|
3227
3717
|
```ruby
|
|
3228
3718
|
KlaviyoAPI::Profiles.get_bulk_import_profiles_job(job_id, opts)
|
|
@@ -3240,7 +3730,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job(job_id, opts)
|
|
|
3240
3730
|
|
|
3241
3731
|
|
|
3242
3732
|
|
|
3243
|
-
#### [Get Bulk Import Profiles Jobs](https://developers.klaviyo.com/en/v2026-
|
|
3733
|
+
#### [Get Bulk Import Profiles Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_import_profiles_jobs)
|
|
3244
3734
|
|
|
3245
3735
|
```ruby
|
|
3246
3736
|
KlaviyoAPI::Profiles.get_bulk_import_profiles_jobs(opts)
|
|
@@ -3258,7 +3748,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_jobs(opts)
|
|
|
3258
3748
|
|
|
3259
3749
|
|
|
3260
3750
|
|
|
3261
|
-
#### [Get Bulk Suppress Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
3751
|
+
#### [Get Bulk Suppress Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_suppress_profiles_job)
|
|
3262
3752
|
|
|
3263
3753
|
```ruby
|
|
3264
3754
|
KlaviyoAPI::Profiles.get_bulk_suppress_profiles_job(job_id, opts)
|
|
@@ -3272,7 +3762,7 @@ KlaviyoAPI::Profiles.get_profile_suppression_bulk_create_job(job_id, opts)
|
|
|
3272
3762
|
|
|
3273
3763
|
|
|
3274
3764
|
|
|
3275
|
-
#### [Get Bulk Suppress Profiles Jobs](https://developers.klaviyo.com/en/v2026-
|
|
3765
|
+
#### [Get Bulk Suppress Profiles Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_suppress_profiles_jobs)
|
|
3276
3766
|
|
|
3277
3767
|
```ruby
|
|
3278
3768
|
KlaviyoAPI::Profiles.get_bulk_suppress_profiles_jobs(opts)
|
|
@@ -3286,7 +3776,7 @@ KlaviyoAPI::Profiles.get_profile_suppression_bulk_create_jobs(opts)
|
|
|
3286
3776
|
|
|
3287
3777
|
|
|
3288
3778
|
|
|
3289
|
-
#### [Get Bulk Unsuppress Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
3779
|
+
#### [Get Bulk Unsuppress Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_unsuppress_profiles_job)
|
|
3290
3780
|
|
|
3291
3781
|
```ruby
|
|
3292
3782
|
KlaviyoAPI::Profiles.get_bulk_unsuppress_profiles_job(job_id, opts)
|
|
@@ -3300,7 +3790,7 @@ KlaviyoAPI::Profiles.get_profile_suppression_bulk_delete_job(job_id, opts)
|
|
|
3300
3790
|
|
|
3301
3791
|
|
|
3302
3792
|
|
|
3303
|
-
#### [Get Bulk Unsuppress Profiles Jobs](https://developers.klaviyo.com/en/v2026-
|
|
3793
|
+
#### [Get Bulk Unsuppress Profiles Jobs](https://developers.klaviyo.com/en/v2026-07-15/reference/get_bulk_unsuppress_profiles_jobs)
|
|
3304
3794
|
|
|
3305
3795
|
```ruby
|
|
3306
3796
|
KlaviyoAPI::Profiles.get_bulk_unsuppress_profiles_jobs(opts)
|
|
@@ -3314,21 +3804,21 @@ KlaviyoAPI::Profiles.get_profile_suppression_bulk_delete_jobs(opts)
|
|
|
3314
3804
|
|
|
3315
3805
|
|
|
3316
3806
|
|
|
3317
|
-
#### [Get Conversation for Profile](https://developers.klaviyo.com/en/v2026-
|
|
3807
|
+
#### [Get Conversation for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_conversation_for_profile)
|
|
3318
3808
|
|
|
3319
3809
|
```ruby
|
|
3320
|
-
KlaviyoAPI::Profiles.get_conversation_for_profile(id)
|
|
3810
|
+
KlaviyoAPI::Profiles.get_conversation_for_profile(id, opts)
|
|
3321
3811
|
```
|
|
3322
3812
|
##### Method alias:
|
|
3323
3813
|
```ruby
|
|
3324
|
-
KlaviyoAPI::Profiles.get_profile_conversation(id)
|
|
3814
|
+
KlaviyoAPI::Profiles.get_profile_conversation(id, opts)
|
|
3325
3815
|
```
|
|
3326
3816
|
|
|
3327
3817
|
|
|
3328
3818
|
|
|
3329
3819
|
|
|
3330
3820
|
|
|
3331
|
-
#### [Get Conversation ID for Profile](https://developers.klaviyo.com/en/v2026-
|
|
3821
|
+
#### [Get Conversation ID for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_conversation_id_for_profile)
|
|
3332
3822
|
|
|
3333
3823
|
```ruby
|
|
3334
3824
|
KlaviyoAPI::Profiles.get_conversation_id_for_profile(id)
|
|
@@ -3342,7 +3832,35 @@ KlaviyoAPI::Profiles.get_profile_relationships_conversation(id)
|
|
|
3342
3832
|
|
|
3343
3833
|
|
|
3344
3834
|
|
|
3345
|
-
#### [Get
|
|
3835
|
+
#### [Get Conversation IDs for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_conversation_ids_for_profile)
|
|
3836
|
+
|
|
3837
|
+
```ruby
|
|
3838
|
+
KlaviyoAPI::Profiles.get_conversation_ids_for_profile(id)
|
|
3839
|
+
```
|
|
3840
|
+
##### Method alias:
|
|
3841
|
+
```ruby
|
|
3842
|
+
KlaviyoAPI::Profiles.get_profile_relationships_conversations(id)
|
|
3843
|
+
```
|
|
3844
|
+
|
|
3845
|
+
|
|
3846
|
+
|
|
3847
|
+
|
|
3848
|
+
|
|
3849
|
+
#### [Get Conversations for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_conversations_for_profile)
|
|
3850
|
+
|
|
3851
|
+
```ruby
|
|
3852
|
+
KlaviyoAPI::Profiles.get_conversations_for_profile(id, opts)
|
|
3853
|
+
```
|
|
3854
|
+
##### Method alias:
|
|
3855
|
+
```ruby
|
|
3856
|
+
KlaviyoAPI::Profiles.get_profile_conversations(id, opts)
|
|
3857
|
+
```
|
|
3858
|
+
|
|
3859
|
+
|
|
3860
|
+
|
|
3861
|
+
|
|
3862
|
+
|
|
3863
|
+
#### [Get Errors for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_errors_for_bulk_import_profiles_job)
|
|
3346
3864
|
|
|
3347
3865
|
```ruby
|
|
3348
3866
|
KlaviyoAPI::Profiles.get_errors_for_bulk_import_profiles_job(id, opts)
|
|
@@ -3364,7 +3882,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job_import_errors(id, opts)
|
|
|
3364
3882
|
|
|
3365
3883
|
|
|
3366
3884
|
|
|
3367
|
-
#### [Get List for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
3885
|
+
#### [Get List for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_list_for_bulk_import_profiles_job)
|
|
3368
3886
|
|
|
3369
3887
|
```ruby
|
|
3370
3888
|
KlaviyoAPI::Profiles.get_list_for_bulk_import_profiles_job(id, opts)
|
|
@@ -3386,7 +3904,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job_lists(id, opts)
|
|
|
3386
3904
|
|
|
3387
3905
|
|
|
3388
3906
|
|
|
3389
|
-
#### [Get List IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
3907
|
+
#### [Get List IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_list_ids_for_bulk_import_profiles_job)
|
|
3390
3908
|
|
|
3391
3909
|
```ruby
|
|
3392
3910
|
KlaviyoAPI::Profiles.get_list_ids_for_bulk_import_profiles_job(id)
|
|
@@ -3408,7 +3926,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_lists(id)
|
|
|
3408
3926
|
|
|
3409
3927
|
|
|
3410
3928
|
|
|
3411
|
-
#### [Get List IDs for Profile](https://developers.klaviyo.com/en/v2026-
|
|
3929
|
+
#### [Get List IDs for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_list_ids_for_profile)
|
|
3412
3930
|
|
|
3413
3931
|
```ruby
|
|
3414
3932
|
KlaviyoAPI::Profiles.get_list_ids_for_profile(id)
|
|
@@ -3422,7 +3940,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
|
|
|
3422
3940
|
|
|
3423
3941
|
|
|
3424
3942
|
|
|
3425
|
-
#### [Get Lists for Profile](https://developers.klaviyo.com/en/v2026-
|
|
3943
|
+
#### [Get Lists for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_lists_for_profile)
|
|
3426
3944
|
|
|
3427
3945
|
```ruby
|
|
3428
3946
|
KlaviyoAPI::Profiles.get_lists_for_profile(id, opts)
|
|
@@ -3436,7 +3954,7 @@ KlaviyoAPI::Profiles.get_profile_lists(id, opts)
|
|
|
3436
3954
|
|
|
3437
3955
|
|
|
3438
3956
|
|
|
3439
|
-
#### [Get Profile](https://developers.klaviyo.com/en/v2026-
|
|
3957
|
+
#### [Get Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile)
|
|
3440
3958
|
|
|
3441
3959
|
```ruby
|
|
3442
3960
|
KlaviyoAPI::Profiles.get_profile(id, opts)
|
|
@@ -3446,7 +3964,7 @@ KlaviyoAPI::Profiles.get_profile(id, opts)
|
|
|
3446
3964
|
|
|
3447
3965
|
|
|
3448
3966
|
|
|
3449
|
-
#### [Get Profile for Push Token](https://developers.klaviyo.com/en/v2026-
|
|
3967
|
+
#### [Get Profile for Push Token](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_for_push_token)
|
|
3450
3968
|
|
|
3451
3969
|
```ruby
|
|
3452
3970
|
KlaviyoAPI::Profiles.get_profile_for_push_token(id, opts)
|
|
@@ -3460,7 +3978,7 @@ KlaviyoAPI::Profiles.get_push_token_profile(id, opts)
|
|
|
3460
3978
|
|
|
3461
3979
|
|
|
3462
3980
|
|
|
3463
|
-
#### [Get Profile ID for Push Token](https://developers.klaviyo.com/en/v2026-
|
|
3981
|
+
#### [Get Profile ID for Push Token](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_id_for_push_token)
|
|
3464
3982
|
|
|
3465
3983
|
```ruby
|
|
3466
3984
|
KlaviyoAPI::Profiles.get_profile_id_for_push_token(id)
|
|
@@ -3474,7 +3992,7 @@ KlaviyoAPI::Profiles.get_push_token_relationships_profile(id)
|
|
|
3474
3992
|
|
|
3475
3993
|
|
|
3476
3994
|
|
|
3477
|
-
#### [Get Profile IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
3995
|
+
#### [Get Profile IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_ids_for_bulk_import_profiles_job)
|
|
3478
3996
|
|
|
3479
3997
|
```ruby
|
|
3480
3998
|
KlaviyoAPI::Profiles.get_profile_ids_for_bulk_import_profiles_job(id, opts)
|
|
@@ -3496,7 +4014,7 @@ KlaviyoAPI::Profiles.get_profile_ids_for_profile_bulk_import_job(id, opts)
|
|
|
3496
4014
|
|
|
3497
4015
|
|
|
3498
4016
|
|
|
3499
|
-
#### [Get Profiles](https://developers.klaviyo.com/en/v2026-
|
|
4017
|
+
#### [Get Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profiles)
|
|
3500
4018
|
|
|
3501
4019
|
```ruby
|
|
3502
4020
|
KlaviyoAPI::Profiles.get_profiles(opts)
|
|
@@ -3506,7 +4024,7 @@ KlaviyoAPI::Profiles.get_profiles(opts)
|
|
|
3506
4024
|
|
|
3507
4025
|
|
|
3508
4026
|
|
|
3509
|
-
#### [Get Profiles for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
4027
|
+
#### [Get Profiles for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profiles_for_bulk_import_profiles_job)
|
|
3510
4028
|
|
|
3511
4029
|
```ruby
|
|
3512
4030
|
KlaviyoAPI::Profiles.get_profiles_for_bulk_import_profiles_job(id, opts)
|
|
@@ -3528,7 +4046,7 @@ KlaviyoAPI::Profiles.get_profiles_for_profile_bulk_import_job(id, opts)
|
|
|
3528
4046
|
|
|
3529
4047
|
|
|
3530
4048
|
|
|
3531
|
-
#### [Get Push Token](https://developers.klaviyo.com/en/v2026-
|
|
4049
|
+
#### [Get Push Token](https://developers.klaviyo.com/en/v2026-07-15/reference/get_push_token)
|
|
3532
4050
|
|
|
3533
4051
|
```ruby
|
|
3534
4052
|
KlaviyoAPI::Profiles.get_push_token(id, opts)
|
|
@@ -3538,7 +4056,7 @@ KlaviyoAPI::Profiles.get_push_token(id, opts)
|
|
|
3538
4056
|
|
|
3539
4057
|
|
|
3540
4058
|
|
|
3541
|
-
#### [Get Push Token IDs for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4059
|
+
#### [Get Push Token IDs for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_push_token_ids_for_profile)
|
|
3542
4060
|
|
|
3543
4061
|
```ruby
|
|
3544
4062
|
KlaviyoAPI::Profiles.get_push_token_ids_for_profile(id)
|
|
@@ -3552,7 +4070,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_push_tokens(id)
|
|
|
3552
4070
|
|
|
3553
4071
|
|
|
3554
4072
|
|
|
3555
|
-
#### [Get Push Tokens](https://developers.klaviyo.com/en/v2026-
|
|
4073
|
+
#### [Get Push Tokens](https://developers.klaviyo.com/en/v2026-07-15/reference/get_push_tokens)
|
|
3556
4074
|
|
|
3557
4075
|
```ruby
|
|
3558
4076
|
KlaviyoAPI::Profiles.get_push_tokens(opts)
|
|
@@ -3562,7 +4080,7 @@ KlaviyoAPI::Profiles.get_push_tokens(opts)
|
|
|
3562
4080
|
|
|
3563
4081
|
|
|
3564
4082
|
|
|
3565
|
-
#### [Get Push Tokens for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4083
|
+
#### [Get Push Tokens for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_push_tokens_for_profile)
|
|
3566
4084
|
|
|
3567
4085
|
```ruby
|
|
3568
4086
|
KlaviyoAPI::Profiles.get_push_tokens_for_profile(id, opts)
|
|
@@ -3576,7 +4094,7 @@ KlaviyoAPI::Profiles.get_profile_push_tokens(id, opts)
|
|
|
3576
4094
|
|
|
3577
4095
|
|
|
3578
4096
|
|
|
3579
|
-
#### [Get Segment IDs for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4097
|
+
#### [Get Segment IDs for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_segment_ids_for_profile)
|
|
3580
4098
|
|
|
3581
4099
|
```ruby
|
|
3582
4100
|
KlaviyoAPI::Profiles.get_segment_ids_for_profile(id)
|
|
@@ -3590,7 +4108,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
|
|
|
3590
4108
|
|
|
3591
4109
|
|
|
3592
4110
|
|
|
3593
|
-
#### [Get Segments for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4111
|
+
#### [Get Segments for Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/get_segments_for_profile)
|
|
3594
4112
|
|
|
3595
4113
|
```ruby
|
|
3596
4114
|
KlaviyoAPI::Profiles.get_segments_for_profile(id, opts)
|
|
@@ -3604,21 +4122,21 @@ KlaviyoAPI::Profiles.get_profile_segments(id, opts)
|
|
|
3604
4122
|
|
|
3605
4123
|
|
|
3606
4124
|
|
|
3607
|
-
#### [Merge Profiles](https://developers.klaviyo.com/en/v2026-
|
|
4125
|
+
#### [Merge Profiles](https://developers.klaviyo.com/en/v2026-07-15/reference/merge_profiles)
|
|
3608
4126
|
|
|
3609
4127
|
```ruby
|
|
3610
|
-
KlaviyoAPI::Profiles.merge_profiles(body)
|
|
4128
|
+
KlaviyoAPI::Profiles.merge_profiles(body, opts)
|
|
3611
4129
|
```
|
|
3612
4130
|
##### Method alias:
|
|
3613
4131
|
```ruby
|
|
3614
|
-
KlaviyoAPI::Profiles.create_profile_merge(body)
|
|
4132
|
+
KlaviyoAPI::Profiles.create_profile_merge(body, opts)
|
|
3615
4133
|
```
|
|
3616
4134
|
|
|
3617
4135
|
|
|
3618
4136
|
|
|
3619
4137
|
|
|
3620
4138
|
|
|
3621
|
-
#### [Update Profile](https://developers.klaviyo.com/en/v2026-
|
|
4139
|
+
#### [Update Profile](https://developers.klaviyo.com/en/v2026-07-15/reference/update_profile)
|
|
3622
4140
|
|
|
3623
4141
|
```ruby
|
|
3624
4142
|
KlaviyoAPI::Profiles.update_profile(id, body, opts)
|
|
@@ -3632,7 +4150,7 @@ KlaviyoAPI::Profiles.update_profile(id, body, opts)
|
|
|
3632
4150
|
## Reporting
|
|
3633
4151
|
|
|
3634
4152
|
|
|
3635
|
-
#### [Query Campaign Values](https://developers.klaviyo.com/en/v2026-
|
|
4153
|
+
#### [Query Campaign Values](https://developers.klaviyo.com/en/v2026-07-15/reference/query_campaign_values)
|
|
3636
4154
|
|
|
3637
4155
|
```ruby
|
|
3638
4156
|
KlaviyoAPI::Reporting.query_campaign_values(body, opts)
|
|
@@ -3650,7 +4168,7 @@ KlaviyoAPI::Reporting.create_campaign_values_report(body, opts)
|
|
|
3650
4168
|
|
|
3651
4169
|
|
|
3652
4170
|
|
|
3653
|
-
#### [Query Flow Series](https://developers.klaviyo.com/en/v2026-
|
|
4171
|
+
#### [Query Flow Series](https://developers.klaviyo.com/en/v2026-07-15/reference/query_flow_series)
|
|
3654
4172
|
|
|
3655
4173
|
```ruby
|
|
3656
4174
|
KlaviyoAPI::Reporting.query_flow_series(body, opts)
|
|
@@ -3668,7 +4186,7 @@ KlaviyoAPI::Reporting.create_flow_series_report(body, opts)
|
|
|
3668
4186
|
|
|
3669
4187
|
|
|
3670
4188
|
|
|
3671
|
-
#### [Query Flow Values](https://developers.klaviyo.com/en/v2026-
|
|
4189
|
+
#### [Query Flow Values](https://developers.klaviyo.com/en/v2026-07-15/reference/query_flow_values)
|
|
3672
4190
|
|
|
3673
4191
|
```ruby
|
|
3674
4192
|
KlaviyoAPI::Reporting.query_flow_values(body, opts)
|
|
@@ -3686,72 +4204,72 @@ KlaviyoAPI::Reporting.create_flow_values_report(body, opts)
|
|
|
3686
4204
|
|
|
3687
4205
|
|
|
3688
4206
|
|
|
3689
|
-
#### [Query Form Series](https://developers.klaviyo.com/en/v2026-
|
|
4207
|
+
#### [Query Form Series](https://developers.klaviyo.com/en/v2026-07-15/reference/query_form_series)
|
|
3690
4208
|
|
|
3691
4209
|
```ruby
|
|
3692
|
-
KlaviyoAPI::Reporting.query_form_series(body)
|
|
4210
|
+
KlaviyoAPI::Reporting.query_form_series(body, opts)
|
|
3693
4211
|
```
|
|
3694
4212
|
##### Method alias:
|
|
3695
4213
|
```ruby
|
|
3696
|
-
KlaviyoAPI::Reporting.create_form_sery_report(body)
|
|
4214
|
+
KlaviyoAPI::Reporting.create_form_sery_report(body, opts)
|
|
3697
4215
|
```
|
|
3698
4216
|
##### Method alias:
|
|
3699
4217
|
```ruby
|
|
3700
|
-
KlaviyoAPI::Reporting.create_form_series_report(body)
|
|
4218
|
+
KlaviyoAPI::Reporting.create_form_series_report(body, opts)
|
|
3701
4219
|
```
|
|
3702
4220
|
|
|
3703
4221
|
|
|
3704
4222
|
|
|
3705
4223
|
|
|
3706
4224
|
|
|
3707
|
-
#### [Query Form Values](https://developers.klaviyo.com/en/v2026-
|
|
4225
|
+
#### [Query Form Values](https://developers.klaviyo.com/en/v2026-07-15/reference/query_form_values)
|
|
3708
4226
|
|
|
3709
4227
|
```ruby
|
|
3710
|
-
KlaviyoAPI::Reporting.query_form_values(body)
|
|
4228
|
+
KlaviyoAPI::Reporting.query_form_values(body, opts)
|
|
3711
4229
|
```
|
|
3712
4230
|
##### Method alias:
|
|
3713
4231
|
```ruby
|
|
3714
|
-
KlaviyoAPI::Reporting.create_form_value_report(body)
|
|
4232
|
+
KlaviyoAPI::Reporting.create_form_value_report(body, opts)
|
|
3715
4233
|
```
|
|
3716
4234
|
##### Method alias:
|
|
3717
4235
|
```ruby
|
|
3718
|
-
KlaviyoAPI::Reporting.create_form_values_report(body)
|
|
4236
|
+
KlaviyoAPI::Reporting.create_form_values_report(body, opts)
|
|
3719
4237
|
```
|
|
3720
4238
|
|
|
3721
4239
|
|
|
3722
4240
|
|
|
3723
4241
|
|
|
3724
4242
|
|
|
3725
|
-
#### [Query Segment Series](https://developers.klaviyo.com/en/v2026-
|
|
4243
|
+
#### [Query Segment Series](https://developers.klaviyo.com/en/v2026-07-15/reference/query_segment_series)
|
|
3726
4244
|
|
|
3727
4245
|
```ruby
|
|
3728
|
-
KlaviyoAPI::Reporting.query_segment_series(body)
|
|
4246
|
+
KlaviyoAPI::Reporting.query_segment_series(body, opts)
|
|
3729
4247
|
```
|
|
3730
4248
|
##### Method alias:
|
|
3731
4249
|
```ruby
|
|
3732
|
-
KlaviyoAPI::Reporting.create_segment_sery_report(body)
|
|
4250
|
+
KlaviyoAPI::Reporting.create_segment_sery_report(body, opts)
|
|
3733
4251
|
```
|
|
3734
4252
|
##### Method alias:
|
|
3735
4253
|
```ruby
|
|
3736
|
-
KlaviyoAPI::Reporting.create_segment_series_report(body)
|
|
4254
|
+
KlaviyoAPI::Reporting.create_segment_series_report(body, opts)
|
|
3737
4255
|
```
|
|
3738
4256
|
|
|
3739
4257
|
|
|
3740
4258
|
|
|
3741
4259
|
|
|
3742
4260
|
|
|
3743
|
-
#### [Query Segment Values](https://developers.klaviyo.com/en/v2026-
|
|
4261
|
+
#### [Query Segment Values](https://developers.klaviyo.com/en/v2026-07-15/reference/query_segment_values)
|
|
3744
4262
|
|
|
3745
4263
|
```ruby
|
|
3746
|
-
KlaviyoAPI::Reporting.query_segment_values(body)
|
|
4264
|
+
KlaviyoAPI::Reporting.query_segment_values(body, opts)
|
|
3747
4265
|
```
|
|
3748
4266
|
##### Method alias:
|
|
3749
4267
|
```ruby
|
|
3750
|
-
KlaviyoAPI::Reporting.create_segment_value_report(body)
|
|
4268
|
+
KlaviyoAPI::Reporting.create_segment_value_report(body, opts)
|
|
3751
4269
|
```
|
|
3752
4270
|
##### Method alias:
|
|
3753
4271
|
```ruby
|
|
3754
|
-
KlaviyoAPI::Reporting.create_segment_values_report(body)
|
|
4272
|
+
KlaviyoAPI::Reporting.create_segment_values_report(body, opts)
|
|
3755
4273
|
```
|
|
3756
4274
|
|
|
3757
4275
|
|
|
@@ -3762,7 +4280,7 @@ KlaviyoAPI::Reporting.create_segment_values_report(body)
|
|
|
3762
4280
|
## Reviews
|
|
3763
4281
|
|
|
3764
4282
|
|
|
3765
|
-
#### [Get Review](https://developers.klaviyo.com/en/v2026-
|
|
4283
|
+
#### [Get Review](https://developers.klaviyo.com/en/v2026-07-15/reference/get_review)
|
|
3766
4284
|
|
|
3767
4285
|
```ruby
|
|
3768
4286
|
KlaviyoAPI::Reviews.get_review(id, opts)
|
|
@@ -3772,7 +4290,7 @@ KlaviyoAPI::Reviews.get_review(id, opts)
|
|
|
3772
4290
|
|
|
3773
4291
|
|
|
3774
4292
|
|
|
3775
|
-
#### [Get Reviews](https://developers.klaviyo.com/en/v2026-
|
|
4293
|
+
#### [Get Reviews](https://developers.klaviyo.com/en/v2026-07-15/reference/get_reviews)
|
|
3776
4294
|
|
|
3777
4295
|
```ruby
|
|
3778
4296
|
KlaviyoAPI::Reviews.get_reviews(opts)
|
|
@@ -3782,10 +4300,10 @@ KlaviyoAPI::Reviews.get_reviews(opts)
|
|
|
3782
4300
|
|
|
3783
4301
|
|
|
3784
4302
|
|
|
3785
|
-
#### [Update Review](https://developers.klaviyo.com/en/v2026-
|
|
4303
|
+
#### [Update Review](https://developers.klaviyo.com/en/v2026-07-15/reference/update_review)
|
|
3786
4304
|
|
|
3787
4305
|
```ruby
|
|
3788
|
-
KlaviyoAPI::Reviews.update_review(id, body)
|
|
4306
|
+
KlaviyoAPI::Reviews.update_review(id, body, opts)
|
|
3789
4307
|
```
|
|
3790
4308
|
|
|
3791
4309
|
|
|
@@ -3796,17 +4314,17 @@ KlaviyoAPI::Reviews.update_review(id, body)
|
|
|
3796
4314
|
## Segments
|
|
3797
4315
|
|
|
3798
4316
|
|
|
3799
|
-
#### [Create Segment](https://developers.klaviyo.com/en/v2026-
|
|
4317
|
+
#### [Create Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/create_segment)
|
|
3800
4318
|
|
|
3801
4319
|
```ruby
|
|
3802
|
-
KlaviyoAPI::Segments.create_segment(body)
|
|
4320
|
+
KlaviyoAPI::Segments.create_segment(body, opts)
|
|
3803
4321
|
```
|
|
3804
4322
|
|
|
3805
4323
|
|
|
3806
4324
|
|
|
3807
4325
|
|
|
3808
4326
|
|
|
3809
|
-
#### [Delete Segment](https://developers.klaviyo.com/en/v2026-
|
|
4327
|
+
#### [Delete Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_segment)
|
|
3810
4328
|
|
|
3811
4329
|
```ruby
|
|
3812
4330
|
KlaviyoAPI::Segments.delete_segment(id)
|
|
@@ -3816,7 +4334,7 @@ KlaviyoAPI::Segments.delete_segment(id)
|
|
|
3816
4334
|
|
|
3817
4335
|
|
|
3818
4336
|
|
|
3819
|
-
#### [Get Flows Triggered by Segment](https://developers.klaviyo.com/en/v2026-
|
|
4337
|
+
#### [Get Flows Triggered by Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flows_triggered_by_segment)
|
|
3820
4338
|
|
|
3821
4339
|
```ruby
|
|
3822
4340
|
KlaviyoAPI::Segments.get_flows_triggered_by_segment(id, opts)
|
|
@@ -3834,7 +4352,7 @@ KlaviyoAPI::Segments.get_segment_flow_triggers(id, opts)
|
|
|
3834
4352
|
|
|
3835
4353
|
|
|
3836
4354
|
|
|
3837
|
-
#### [Get IDs for Flows Triggered by Segment](https://developers.klaviyo.com/en/v2026-
|
|
4355
|
+
#### [Get IDs for Flows Triggered by Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_ids_for_flows_triggered_by_segment)
|
|
3838
4356
|
|
|
3839
4357
|
```ruby
|
|
3840
4358
|
KlaviyoAPI::Segments.get_ids_for_flows_triggered_by_segment(id)
|
|
@@ -3852,7 +4370,7 @@ KlaviyoAPI::Segments.get_segment_relationships_flow_triggers(id)
|
|
|
3852
4370
|
|
|
3853
4371
|
|
|
3854
4372
|
|
|
3855
|
-
#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2026-
|
|
4373
|
+
#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profile_ids_for_segment)
|
|
3856
4374
|
|
|
3857
4375
|
```ruby
|
|
3858
4376
|
KlaviyoAPI::Segments.get_profile_ids_for_segment(id, opts)
|
|
@@ -3866,7 +4384,7 @@ KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
|
|
|
3866
4384
|
|
|
3867
4385
|
|
|
3868
4386
|
|
|
3869
|
-
#### [Get Profiles for Segment](https://developers.klaviyo.com/en/v2026-
|
|
4387
|
+
#### [Get Profiles for Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_profiles_for_segment)
|
|
3870
4388
|
|
|
3871
4389
|
```ruby
|
|
3872
4390
|
KlaviyoAPI::Segments.get_profiles_for_segment(id, opts)
|
|
@@ -3880,7 +4398,7 @@ KlaviyoAPI::Segments.get_segment_profiles(id, opts)
|
|
|
3880
4398
|
|
|
3881
4399
|
|
|
3882
4400
|
|
|
3883
|
-
#### [Get Segment](https://developers.klaviyo.com/en/v2026-
|
|
4401
|
+
#### [Get Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_segment)
|
|
3884
4402
|
|
|
3885
4403
|
```ruby
|
|
3886
4404
|
KlaviyoAPI::Segments.get_segment(id, opts)
|
|
@@ -3890,7 +4408,7 @@ KlaviyoAPI::Segments.get_segment(id, opts)
|
|
|
3890
4408
|
|
|
3891
4409
|
|
|
3892
4410
|
|
|
3893
|
-
#### [Get Segments](https://developers.klaviyo.com/en/v2026-
|
|
4411
|
+
#### [Get Segments](https://developers.klaviyo.com/en/v2026-07-15/reference/get_segments)
|
|
3894
4412
|
|
|
3895
4413
|
```ruby
|
|
3896
4414
|
KlaviyoAPI::Segments.get_segments(opts)
|
|
@@ -3900,7 +4418,7 @@ KlaviyoAPI::Segments.get_segments(opts)
|
|
|
3900
4418
|
|
|
3901
4419
|
|
|
3902
4420
|
|
|
3903
|
-
#### [Get Tag IDs for Segment](https://developers.klaviyo.com/en/v2026-
|
|
4421
|
+
#### [Get Tag IDs for Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_ids_for_segment)
|
|
3904
4422
|
|
|
3905
4423
|
```ruby
|
|
3906
4424
|
KlaviyoAPI::Segments.get_tag_ids_for_segment(id)
|
|
@@ -3914,7 +4432,7 @@ KlaviyoAPI::Segments.get_segment_relationships_tags(id)
|
|
|
3914
4432
|
|
|
3915
4433
|
|
|
3916
4434
|
|
|
3917
|
-
#### [Get Tags for Segment](https://developers.klaviyo.com/en/v2026-
|
|
4435
|
+
#### [Get Tags for Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tags_for_segment)
|
|
3918
4436
|
|
|
3919
4437
|
```ruby
|
|
3920
4438
|
KlaviyoAPI::Segments.get_tags_for_segment(id, opts)
|
|
@@ -3928,10 +4446,10 @@ KlaviyoAPI::Segments.get_segment_tags(id, opts)
|
|
|
3928
4446
|
|
|
3929
4447
|
|
|
3930
4448
|
|
|
3931
|
-
#### [Update Segment](https://developers.klaviyo.com/en/v2026-
|
|
4449
|
+
#### [Update Segment](https://developers.klaviyo.com/en/v2026-07-15/reference/update_segment)
|
|
3932
4450
|
|
|
3933
4451
|
```ruby
|
|
3934
|
-
KlaviyoAPI::Segments.update_segment(id, body)
|
|
4452
|
+
KlaviyoAPI::Segments.update_segment(id, body, opts)
|
|
3935
4453
|
```
|
|
3936
4454
|
|
|
3937
4455
|
|
|
@@ -3942,27 +4460,27 @@ KlaviyoAPI::Segments.update_segment(id, body)
|
|
|
3942
4460
|
## Tags
|
|
3943
4461
|
|
|
3944
4462
|
|
|
3945
|
-
#### [Create Tag](https://developers.klaviyo.com/en/v2026-
|
|
4463
|
+
#### [Create Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/create_tag)
|
|
3946
4464
|
|
|
3947
4465
|
```ruby
|
|
3948
|
-
KlaviyoAPI::Tags.create_tag(body)
|
|
4466
|
+
KlaviyoAPI::Tags.create_tag(body, opts)
|
|
3949
4467
|
```
|
|
3950
4468
|
|
|
3951
4469
|
|
|
3952
4470
|
|
|
3953
4471
|
|
|
3954
4472
|
|
|
3955
|
-
#### [Create Tag Group](https://developers.klaviyo.com/en/v2026-
|
|
4473
|
+
#### [Create Tag Group](https://developers.klaviyo.com/en/v2026-07-15/reference/create_tag_group)
|
|
3956
4474
|
|
|
3957
4475
|
```ruby
|
|
3958
|
-
KlaviyoAPI::Tags.create_tag_group(body)
|
|
4476
|
+
KlaviyoAPI::Tags.create_tag_group(body, opts)
|
|
3959
4477
|
```
|
|
3960
4478
|
|
|
3961
4479
|
|
|
3962
4480
|
|
|
3963
4481
|
|
|
3964
4482
|
|
|
3965
|
-
#### [Delete Tag](https://developers.klaviyo.com/en/v2026-
|
|
4483
|
+
#### [Delete Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_tag)
|
|
3966
4484
|
|
|
3967
4485
|
```ruby
|
|
3968
4486
|
KlaviyoAPI::Tags.delete_tag(id)
|
|
@@ -3972,7 +4490,7 @@ KlaviyoAPI::Tags.delete_tag(id)
|
|
|
3972
4490
|
|
|
3973
4491
|
|
|
3974
4492
|
|
|
3975
|
-
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2026-
|
|
4493
|
+
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_tag_group)
|
|
3976
4494
|
|
|
3977
4495
|
```ruby
|
|
3978
4496
|
KlaviyoAPI::Tags.delete_tag_group(id)
|
|
@@ -3982,7 +4500,7 @@ KlaviyoAPI::Tags.delete_tag_group(id)
|
|
|
3982
4500
|
|
|
3983
4501
|
|
|
3984
4502
|
|
|
3985
|
-
#### [Get Campaign IDs for Tag](https://developers.klaviyo.com/en/v2026-
|
|
4503
|
+
#### [Get Campaign IDs for Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_campaign_ids_for_tag)
|
|
3986
4504
|
|
|
3987
4505
|
```ruby
|
|
3988
4506
|
KlaviyoAPI::Tags.get_campaign_ids_for_tag(id)
|
|
@@ -3996,7 +4514,7 @@ KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
|
|
|
3996
4514
|
|
|
3997
4515
|
|
|
3998
4516
|
|
|
3999
|
-
#### [Get Flow IDs for Tag](https://developers.klaviyo.com/en/v2026-
|
|
4517
|
+
#### [Get Flow IDs for Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_flow_ids_for_tag)
|
|
4000
4518
|
|
|
4001
4519
|
```ruby
|
|
4002
4520
|
KlaviyoAPI::Tags.get_flow_ids_for_tag(id)
|
|
@@ -4010,7 +4528,7 @@ KlaviyoAPI::Tags.get_tag_relationships_flows(id)
|
|
|
4010
4528
|
|
|
4011
4529
|
|
|
4012
4530
|
|
|
4013
|
-
#### [Get List IDs for Tag](https://developers.klaviyo.com/en/v2026-
|
|
4531
|
+
#### [Get List IDs for Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_list_ids_for_tag)
|
|
4014
4532
|
|
|
4015
4533
|
```ruby
|
|
4016
4534
|
KlaviyoAPI::Tags.get_list_ids_for_tag(id)
|
|
@@ -4024,7 +4542,7 @@ KlaviyoAPI::Tags.get_tag_relationships_lists(id)
|
|
|
4024
4542
|
|
|
4025
4543
|
|
|
4026
4544
|
|
|
4027
|
-
#### [Get Segment IDs for Tag](https://developers.klaviyo.com/en/v2026-
|
|
4545
|
+
#### [Get Segment IDs for Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_segment_ids_for_tag)
|
|
4028
4546
|
|
|
4029
4547
|
```ruby
|
|
4030
4548
|
KlaviyoAPI::Tags.get_segment_ids_for_tag(id)
|
|
@@ -4038,7 +4556,7 @@ KlaviyoAPI::Tags.get_tag_relationships_segments(id)
|
|
|
4038
4556
|
|
|
4039
4557
|
|
|
4040
4558
|
|
|
4041
|
-
#### [Get Tag](https://developers.klaviyo.com/en/v2026-
|
|
4559
|
+
#### [Get Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag)
|
|
4042
4560
|
|
|
4043
4561
|
```ruby
|
|
4044
4562
|
KlaviyoAPI::Tags.get_tag(id, opts)
|
|
@@ -4048,7 +4566,7 @@ KlaviyoAPI::Tags.get_tag(id, opts)
|
|
|
4048
4566
|
|
|
4049
4567
|
|
|
4050
4568
|
|
|
4051
|
-
#### [Get Tag Group](https://developers.klaviyo.com/en/v2026-
|
|
4569
|
+
#### [Get Tag Group](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_group)
|
|
4052
4570
|
|
|
4053
4571
|
```ruby
|
|
4054
4572
|
KlaviyoAPI::Tags.get_tag_group(id, opts)
|
|
@@ -4058,7 +4576,7 @@ KlaviyoAPI::Tags.get_tag_group(id, opts)
|
|
|
4058
4576
|
|
|
4059
4577
|
|
|
4060
4578
|
|
|
4061
|
-
#### [Get Tag Group for Tag](https://developers.klaviyo.com/en/v2026-
|
|
4579
|
+
#### [Get Tag Group for Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_group_for_tag)
|
|
4062
4580
|
|
|
4063
4581
|
```ruby
|
|
4064
4582
|
KlaviyoAPI::Tags.get_tag_group_for_tag(id, opts)
|
|
@@ -4076,7 +4594,7 @@ KlaviyoAPI::Tags.get_group_for_tag(id, opts)
|
|
|
4076
4594
|
|
|
4077
4595
|
|
|
4078
4596
|
|
|
4079
|
-
#### [Get Tag Group ID for Tag](https://developers.klaviyo.com/en/v2026-
|
|
4597
|
+
#### [Get Tag Group ID for Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_group_id_for_tag)
|
|
4080
4598
|
|
|
4081
4599
|
```ruby
|
|
4082
4600
|
KlaviyoAPI::Tags.get_tag_group_id_for_tag(id)
|
|
@@ -4098,7 +4616,7 @@ KlaviyoAPI::Tags.get_tag_relationships_group(id)
|
|
|
4098
4616
|
|
|
4099
4617
|
|
|
4100
4618
|
|
|
4101
|
-
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2026-
|
|
4619
|
+
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_groups)
|
|
4102
4620
|
|
|
4103
4621
|
```ruby
|
|
4104
4622
|
KlaviyoAPI::Tags.get_tag_groups(opts)
|
|
@@ -4108,7 +4626,7 @@ KlaviyoAPI::Tags.get_tag_groups(opts)
|
|
|
4108
4626
|
|
|
4109
4627
|
|
|
4110
4628
|
|
|
4111
|
-
#### [Get Tag IDs for Tag Group](https://developers.klaviyo.com/en/v2026-
|
|
4629
|
+
#### [Get Tag IDs for Tag Group](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tag_ids_for_tag_group)
|
|
4112
4630
|
|
|
4113
4631
|
```ruby
|
|
4114
4632
|
KlaviyoAPI::Tags.get_tag_ids_for_tag_group(id)
|
|
@@ -4122,7 +4640,7 @@ KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
|
|
|
4122
4640
|
|
|
4123
4641
|
|
|
4124
4642
|
|
|
4125
|
-
#### [Get Tags](https://developers.klaviyo.com/en/v2026-
|
|
4643
|
+
#### [Get Tags](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tags)
|
|
4126
4644
|
|
|
4127
4645
|
```ruby
|
|
4128
4646
|
KlaviyoAPI::Tags.get_tags(opts)
|
|
@@ -4132,7 +4650,7 @@ KlaviyoAPI::Tags.get_tags(opts)
|
|
|
4132
4650
|
|
|
4133
4651
|
|
|
4134
4652
|
|
|
4135
|
-
#### [Get Tags for Tag Group](https://developers.klaviyo.com/en/v2026-
|
|
4653
|
+
#### [Get Tags for Tag Group](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tags_for_tag_group)
|
|
4136
4654
|
|
|
4137
4655
|
```ruby
|
|
4138
4656
|
KlaviyoAPI::Tags.get_tags_for_tag_group(id, opts)
|
|
@@ -4146,7 +4664,7 @@ KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
|
|
|
4146
4664
|
|
|
4147
4665
|
|
|
4148
4666
|
|
|
4149
|
-
#### [Remove Tag from Campaigns](https://developers.klaviyo.com/en/v2026-
|
|
4667
|
+
#### [Remove Tag from Campaigns](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_tag_from_campaigns)
|
|
4150
4668
|
|
|
4151
4669
|
```ruby
|
|
4152
4670
|
KlaviyoAPI::Tags.remove_tag_from_campaigns(id, body)
|
|
@@ -4164,7 +4682,7 @@ KlaviyoAPI::Tags.remove_campaigns_from_tag(id, body)
|
|
|
4164
4682
|
|
|
4165
4683
|
|
|
4166
4684
|
|
|
4167
|
-
#### [Remove Tag from Flows](https://developers.klaviyo.com/en/v2026-
|
|
4685
|
+
#### [Remove Tag from Flows](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_tag_from_flows)
|
|
4168
4686
|
|
|
4169
4687
|
```ruby
|
|
4170
4688
|
KlaviyoAPI::Tags.remove_tag_from_flows(id, body)
|
|
@@ -4182,7 +4700,7 @@ KlaviyoAPI::Tags.remove_flows_from_tag(id, body)
|
|
|
4182
4700
|
|
|
4183
4701
|
|
|
4184
4702
|
|
|
4185
|
-
#### [Remove Tag from Lists](https://developers.klaviyo.com/en/v2026-
|
|
4703
|
+
#### [Remove Tag from Lists](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_tag_from_lists)
|
|
4186
4704
|
|
|
4187
4705
|
```ruby
|
|
4188
4706
|
KlaviyoAPI::Tags.remove_tag_from_lists(id, body)
|
|
@@ -4200,7 +4718,7 @@ KlaviyoAPI::Tags.remove_lists_from_tag(id, body)
|
|
|
4200
4718
|
|
|
4201
4719
|
|
|
4202
4720
|
|
|
4203
|
-
#### [Remove Tag from Segments](https://developers.klaviyo.com/en/v2026-
|
|
4721
|
+
#### [Remove Tag from Segments](https://developers.klaviyo.com/en/v2026-07-15/reference/remove_tag_from_segments)
|
|
4204
4722
|
|
|
4205
4723
|
```ruby
|
|
4206
4724
|
KlaviyoAPI::Tags.remove_tag_from_segments(id, body)
|
|
@@ -4218,7 +4736,7 @@ KlaviyoAPI::Tags.remove_segments_from_tag(id, body)
|
|
|
4218
4736
|
|
|
4219
4737
|
|
|
4220
4738
|
|
|
4221
|
-
#### [Tag Campaigns](https://developers.klaviyo.com/en/v2026-
|
|
4739
|
+
#### [Tag Campaigns](https://developers.klaviyo.com/en/v2026-07-15/reference/tag_campaigns)
|
|
4222
4740
|
|
|
4223
4741
|
```ruby
|
|
4224
4742
|
KlaviyoAPI::Tags.tag_campaigns(id, body)
|
|
@@ -4240,7 +4758,7 @@ KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
|
|
|
4240
4758
|
|
|
4241
4759
|
|
|
4242
4760
|
|
|
4243
|
-
#### [Tag Flows](https://developers.klaviyo.com/en/v2026-
|
|
4761
|
+
#### [Tag Flows](https://developers.klaviyo.com/en/v2026-07-15/reference/tag_flows)
|
|
4244
4762
|
|
|
4245
4763
|
```ruby
|
|
4246
4764
|
KlaviyoAPI::Tags.tag_flows(id, body)
|
|
@@ -4262,7 +4780,7 @@ KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
|
|
|
4262
4780
|
|
|
4263
4781
|
|
|
4264
4782
|
|
|
4265
|
-
#### [Tag Lists](https://developers.klaviyo.com/en/v2026-
|
|
4783
|
+
#### [Tag Lists](https://developers.klaviyo.com/en/v2026-07-15/reference/tag_lists)
|
|
4266
4784
|
|
|
4267
4785
|
```ruby
|
|
4268
4786
|
KlaviyoAPI::Tags.tag_lists(id, body)
|
|
@@ -4284,7 +4802,7 @@ KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
|
|
|
4284
4802
|
|
|
4285
4803
|
|
|
4286
4804
|
|
|
4287
|
-
#### [Tag Segments](https://developers.klaviyo.com/en/v2026-
|
|
4805
|
+
#### [Tag Segments](https://developers.klaviyo.com/en/v2026-07-15/reference/tag_segments)
|
|
4288
4806
|
|
|
4289
4807
|
```ruby
|
|
4290
4808
|
KlaviyoAPI::Tags.tag_segments(id, body)
|
|
@@ -4306,7 +4824,7 @@ KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
|
|
|
4306
4824
|
|
|
4307
4825
|
|
|
4308
4826
|
|
|
4309
|
-
#### [Update Tag](https://developers.klaviyo.com/en/v2026-
|
|
4827
|
+
#### [Update Tag](https://developers.klaviyo.com/en/v2026-07-15/reference/update_tag)
|
|
4310
4828
|
|
|
4311
4829
|
```ruby
|
|
4312
4830
|
KlaviyoAPI::Tags.update_tag(id, body)
|
|
@@ -4316,7 +4834,7 @@ KlaviyoAPI::Tags.update_tag(id, body)
|
|
|
4316
4834
|
|
|
4317
4835
|
|
|
4318
4836
|
|
|
4319
|
-
#### [Update Tag Group](https://developers.klaviyo.com/en/v2026-
|
|
4837
|
+
#### [Update Tag Group](https://developers.klaviyo.com/en/v2026-07-15/reference/update_tag_group)
|
|
4320
4838
|
|
|
4321
4839
|
```ruby
|
|
4322
4840
|
KlaviyoAPI::Tags.update_tag_group(id, body)
|
|
@@ -4330,21 +4848,21 @@ KlaviyoAPI::Tags.update_tag_group(id, body)
|
|
|
4330
4848
|
## Templates
|
|
4331
4849
|
|
|
4332
4850
|
|
|
4333
|
-
#### [Clone Template](https://developers.klaviyo.com/en/v2026-
|
|
4851
|
+
#### [Clone Template](https://developers.klaviyo.com/en/v2026-07-15/reference/clone_template)
|
|
4334
4852
|
|
|
4335
4853
|
```ruby
|
|
4336
|
-
KlaviyoAPI::Templates.clone_template(body)
|
|
4854
|
+
KlaviyoAPI::Templates.clone_template(body, opts)
|
|
4337
4855
|
```
|
|
4338
4856
|
##### Method alias:
|
|
4339
4857
|
```ruby
|
|
4340
|
-
KlaviyoAPI::Templates.create_template_clone(body)
|
|
4858
|
+
KlaviyoAPI::Templates.create_template_clone(body, opts)
|
|
4341
4859
|
```
|
|
4342
4860
|
|
|
4343
4861
|
|
|
4344
4862
|
|
|
4345
4863
|
|
|
4346
4864
|
|
|
4347
|
-
#### [Create Template](https://developers.klaviyo.com/en/v2026-
|
|
4865
|
+
#### [Create Template](https://developers.klaviyo.com/en/v2026-07-15/reference/create_template)
|
|
4348
4866
|
|
|
4349
4867
|
```ruby
|
|
4350
4868
|
KlaviyoAPI::Templates.create_template(body, opts)
|
|
@@ -4354,21 +4872,21 @@ KlaviyoAPI::Templates.create_template(body, opts)
|
|
|
4354
4872
|
|
|
4355
4873
|
|
|
4356
4874
|
|
|
4357
|
-
#### [Create Universal Content](https://developers.klaviyo.com/en/v2026-
|
|
4875
|
+
#### [Create Universal Content](https://developers.klaviyo.com/en/v2026-07-15/reference/create_universal_content)
|
|
4358
4876
|
|
|
4359
4877
|
```ruby
|
|
4360
|
-
KlaviyoAPI::Templates.create_universal_content(body)
|
|
4878
|
+
KlaviyoAPI::Templates.create_universal_content(body, opts)
|
|
4361
4879
|
```
|
|
4362
4880
|
##### Method alias:
|
|
4363
4881
|
```ruby
|
|
4364
|
-
KlaviyoAPI::Templates.create_template_universal_content(body)
|
|
4882
|
+
KlaviyoAPI::Templates.create_template_universal_content(body, opts)
|
|
4365
4883
|
```
|
|
4366
4884
|
|
|
4367
4885
|
|
|
4368
4886
|
|
|
4369
4887
|
|
|
4370
4888
|
|
|
4371
|
-
#### [Delete Template](https://developers.klaviyo.com/en/v2026-
|
|
4889
|
+
#### [Delete Template](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_template)
|
|
4372
4890
|
|
|
4373
4891
|
```ruby
|
|
4374
4892
|
KlaviyoAPI::Templates.delete_template(id)
|
|
@@ -4378,7 +4896,7 @@ KlaviyoAPI::Templates.delete_template(id)
|
|
|
4378
4896
|
|
|
4379
4897
|
|
|
4380
4898
|
|
|
4381
|
-
#### [Delete Universal Content](https://developers.klaviyo.com/en/v2026-
|
|
4899
|
+
#### [Delete Universal Content](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_universal_content)
|
|
4382
4900
|
|
|
4383
4901
|
```ruby
|
|
4384
4902
|
KlaviyoAPI::Templates.delete_universal_content(id)
|
|
@@ -4392,7 +4910,7 @@ KlaviyoAPI::Templates.delete_template_universal_content(id)
|
|
|
4392
4910
|
|
|
4393
4911
|
|
|
4394
4912
|
|
|
4395
|
-
#### [Get All Universal Content](https://developers.klaviyo.com/en/v2026-
|
|
4913
|
+
#### [Get All Universal Content](https://developers.klaviyo.com/en/v2026-07-15/reference/get_all_universal_content)
|
|
4396
4914
|
|
|
4397
4915
|
```ruby
|
|
4398
4916
|
KlaviyoAPI::Templates.get_all_universal_content(opts)
|
|
@@ -4406,7 +4924,7 @@ KlaviyoAPI::Templates.get_template_universal_content(opts)
|
|
|
4406
4924
|
|
|
4407
4925
|
|
|
4408
4926
|
|
|
4409
|
-
#### [Get Template](https://developers.klaviyo.com/en/v2026-
|
|
4927
|
+
#### [Get Template](https://developers.klaviyo.com/en/v2026-07-15/reference/get_template)
|
|
4410
4928
|
|
|
4411
4929
|
```ruby
|
|
4412
4930
|
KlaviyoAPI::Templates.get_template(id, opts)
|
|
@@ -4416,7 +4934,7 @@ KlaviyoAPI::Templates.get_template(id, opts)
|
|
|
4416
4934
|
|
|
4417
4935
|
|
|
4418
4936
|
|
|
4419
|
-
#### [Get Templates](https://developers.klaviyo.com/en/v2026-
|
|
4937
|
+
#### [Get Templates](https://developers.klaviyo.com/en/v2026-07-15/reference/get_templates)
|
|
4420
4938
|
|
|
4421
4939
|
```ruby
|
|
4422
4940
|
KlaviyoAPI::Templates.get_templates(opts)
|
|
@@ -4426,7 +4944,7 @@ KlaviyoAPI::Templates.get_templates(opts)
|
|
|
4426
4944
|
|
|
4427
4945
|
|
|
4428
4946
|
|
|
4429
|
-
#### [Get Universal Content](https://developers.klaviyo.com/en/v2026-
|
|
4947
|
+
#### [Get Universal Content](https://developers.klaviyo.com/en/v2026-07-15/reference/get_universal_content)
|
|
4430
4948
|
|
|
4431
4949
|
```ruby
|
|
4432
4950
|
KlaviyoAPI::Templates.get_universal_content(id, opts)
|
|
@@ -4436,21 +4954,21 @@ KlaviyoAPI::Templates.get_universal_content(id, opts)
|
|
|
4436
4954
|
|
|
4437
4955
|
|
|
4438
4956
|
|
|
4439
|
-
#### [Render Template](https://developers.klaviyo.com/en/v2026-
|
|
4957
|
+
#### [Render Template](https://developers.klaviyo.com/en/v2026-07-15/reference/render_template)
|
|
4440
4958
|
|
|
4441
4959
|
```ruby
|
|
4442
|
-
KlaviyoAPI::Templates.render_template(body)
|
|
4960
|
+
KlaviyoAPI::Templates.render_template(body, opts)
|
|
4443
4961
|
```
|
|
4444
4962
|
##### Method alias:
|
|
4445
4963
|
```ruby
|
|
4446
|
-
KlaviyoAPI::Templates.create_template_render(body)
|
|
4964
|
+
KlaviyoAPI::Templates.create_template_render(body, opts)
|
|
4447
4965
|
```
|
|
4448
4966
|
|
|
4449
4967
|
|
|
4450
4968
|
|
|
4451
4969
|
|
|
4452
4970
|
|
|
4453
|
-
#### [Update Template](https://developers.klaviyo.com/en/v2026-
|
|
4971
|
+
#### [Update Template](https://developers.klaviyo.com/en/v2026-07-15/reference/update_template)
|
|
4454
4972
|
|
|
4455
4973
|
```ruby
|
|
4456
4974
|
KlaviyoAPI::Templates.update_template(id, body, opts)
|
|
@@ -4460,14 +4978,14 @@ KlaviyoAPI::Templates.update_template(id, body, opts)
|
|
|
4460
4978
|
|
|
4461
4979
|
|
|
4462
4980
|
|
|
4463
|
-
#### [Update Universal Content](https://developers.klaviyo.com/en/v2026-
|
|
4981
|
+
#### [Update Universal Content](https://developers.klaviyo.com/en/v2026-07-15/reference/update_universal_content)
|
|
4464
4982
|
|
|
4465
4983
|
```ruby
|
|
4466
|
-
KlaviyoAPI::Templates.update_universal_content(id, body)
|
|
4984
|
+
KlaviyoAPI::Templates.update_universal_content(id, body, opts)
|
|
4467
4985
|
```
|
|
4468
4986
|
##### Method alias:
|
|
4469
4987
|
```ruby
|
|
4470
|
-
KlaviyoAPI::Templates.update_template_universal_content(id, body)
|
|
4988
|
+
KlaviyoAPI::Templates.update_template_universal_content(id, body, opts)
|
|
4471
4989
|
```
|
|
4472
4990
|
|
|
4473
4991
|
|
|
@@ -4478,7 +4996,7 @@ KlaviyoAPI::Templates.update_template_universal_content(id, body)
|
|
|
4478
4996
|
## Tracking Settings
|
|
4479
4997
|
|
|
4480
4998
|
|
|
4481
|
-
#### [Get Tracking Setting](https://developers.klaviyo.com/en/v2026-
|
|
4999
|
+
#### [Get Tracking Setting](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tracking_setting)
|
|
4482
5000
|
|
|
4483
5001
|
```ruby
|
|
4484
5002
|
KlaviyoAPI::TrackingSettings.get_tracking_setting(id, opts)
|
|
@@ -4488,7 +5006,7 @@ KlaviyoAPI::TrackingSettings.get_tracking_setting(id, opts)
|
|
|
4488
5006
|
|
|
4489
5007
|
|
|
4490
5008
|
|
|
4491
|
-
#### [Get Tracking Settings](https://developers.klaviyo.com/en/v2026-
|
|
5009
|
+
#### [Get Tracking Settings](https://developers.klaviyo.com/en/v2026-07-15/reference/get_tracking_settings)
|
|
4492
5010
|
|
|
4493
5011
|
```ruby
|
|
4494
5012
|
KlaviyoAPI::TrackingSettings.get_tracking_settings(opts)
|
|
@@ -4498,10 +5016,10 @@ KlaviyoAPI::TrackingSettings.get_tracking_settings(opts)
|
|
|
4498
5016
|
|
|
4499
5017
|
|
|
4500
5018
|
|
|
4501
|
-
#### [Update Tracking Setting](https://developers.klaviyo.com/en/v2026-
|
|
5019
|
+
#### [Update Tracking Setting](https://developers.klaviyo.com/en/v2026-07-15/reference/update_tracking_setting)
|
|
4502
5020
|
|
|
4503
5021
|
```ruby
|
|
4504
|
-
KlaviyoAPI::TrackingSettings.update_tracking_setting(id, body)
|
|
5022
|
+
KlaviyoAPI::TrackingSettings.update_tracking_setting(id, body, opts)
|
|
4505
5023
|
```
|
|
4506
5024
|
|
|
4507
5025
|
|
|
@@ -4512,17 +5030,17 @@ KlaviyoAPI::TrackingSettings.update_tracking_setting(id, body)
|
|
|
4512
5030
|
## Web Feeds
|
|
4513
5031
|
|
|
4514
5032
|
|
|
4515
|
-
#### [Create Web Feed](https://developers.klaviyo.com/en/v2026-
|
|
5033
|
+
#### [Create Web Feed](https://developers.klaviyo.com/en/v2026-07-15/reference/create_web_feed)
|
|
4516
5034
|
|
|
4517
5035
|
```ruby
|
|
4518
|
-
KlaviyoAPI::WebFeeds.create_web_feed(body)
|
|
5036
|
+
KlaviyoAPI::WebFeeds.create_web_feed(body, opts)
|
|
4519
5037
|
```
|
|
4520
5038
|
|
|
4521
5039
|
|
|
4522
5040
|
|
|
4523
5041
|
|
|
4524
5042
|
|
|
4525
|
-
#### [Delete Web Feed](https://developers.klaviyo.com/en/v2026-
|
|
5043
|
+
#### [Delete Web Feed](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_web_feed)
|
|
4526
5044
|
|
|
4527
5045
|
```ruby
|
|
4528
5046
|
KlaviyoAPI::WebFeeds.delete_web_feed(id)
|
|
@@ -4532,7 +5050,7 @@ KlaviyoAPI::WebFeeds.delete_web_feed(id)
|
|
|
4532
5050
|
|
|
4533
5051
|
|
|
4534
5052
|
|
|
4535
|
-
#### [Get Web Feed](https://developers.klaviyo.com/en/v2026-
|
|
5053
|
+
#### [Get Web Feed](https://developers.klaviyo.com/en/v2026-07-15/reference/get_web_feed)
|
|
4536
5054
|
|
|
4537
5055
|
```ruby
|
|
4538
5056
|
KlaviyoAPI::WebFeeds.get_web_feed(id, opts)
|
|
@@ -4542,7 +5060,7 @@ KlaviyoAPI::WebFeeds.get_web_feed(id, opts)
|
|
|
4542
5060
|
|
|
4543
5061
|
|
|
4544
5062
|
|
|
4545
|
-
#### [Get Web Feeds](https://developers.klaviyo.com/en/v2026-
|
|
5063
|
+
#### [Get Web Feeds](https://developers.klaviyo.com/en/v2026-07-15/reference/get_web_feeds)
|
|
4546
5064
|
|
|
4547
5065
|
```ruby
|
|
4548
5066
|
KlaviyoAPI::WebFeeds.get_web_feeds(opts)
|
|
@@ -4552,10 +5070,10 @@ KlaviyoAPI::WebFeeds.get_web_feeds(opts)
|
|
|
4552
5070
|
|
|
4553
5071
|
|
|
4554
5072
|
|
|
4555
|
-
#### [Update Web Feed](https://developers.klaviyo.com/en/v2026-
|
|
5073
|
+
#### [Update Web Feed](https://developers.klaviyo.com/en/v2026-07-15/reference/update_web_feed)
|
|
4556
5074
|
|
|
4557
5075
|
```ruby
|
|
4558
|
-
KlaviyoAPI::WebFeeds.update_web_feed(id, body)
|
|
5076
|
+
KlaviyoAPI::WebFeeds.update_web_feed(id, body, opts)
|
|
4559
5077
|
```
|
|
4560
5078
|
|
|
4561
5079
|
|
|
@@ -4566,17 +5084,17 @@ KlaviyoAPI::WebFeeds.update_web_feed(id, body)
|
|
|
4566
5084
|
## Webhooks
|
|
4567
5085
|
|
|
4568
5086
|
|
|
4569
|
-
#### [Create Webhook](https://developers.klaviyo.com/en/v2026-
|
|
5087
|
+
#### [Create Webhook](https://developers.klaviyo.com/en/v2026-07-15/reference/create_webhook)
|
|
4570
5088
|
|
|
4571
5089
|
```ruby
|
|
4572
|
-
KlaviyoAPI::Webhooks.create_webhook(body)
|
|
5090
|
+
KlaviyoAPI::Webhooks.create_webhook(body, opts)
|
|
4573
5091
|
```
|
|
4574
5092
|
|
|
4575
5093
|
|
|
4576
5094
|
|
|
4577
5095
|
|
|
4578
5096
|
|
|
4579
|
-
#### [Delete Webhook](https://developers.klaviyo.com/en/v2026-
|
|
5097
|
+
#### [Delete Webhook](https://developers.klaviyo.com/en/v2026-07-15/reference/delete_webhook)
|
|
4580
5098
|
|
|
4581
5099
|
```ruby
|
|
4582
5100
|
KlaviyoAPI::Webhooks.delete_webhook(id)
|
|
@@ -4586,7 +5104,7 @@ KlaviyoAPI::Webhooks.delete_webhook(id)
|
|
|
4586
5104
|
|
|
4587
5105
|
|
|
4588
5106
|
|
|
4589
|
-
#### [Get Webhook](https://developers.klaviyo.com/en/v2026-
|
|
5107
|
+
#### [Get Webhook](https://developers.klaviyo.com/en/v2026-07-15/reference/get_webhook)
|
|
4590
5108
|
|
|
4591
5109
|
```ruby
|
|
4592
5110
|
KlaviyoAPI::Webhooks.get_webhook(id, opts)
|
|
@@ -4596,27 +5114,27 @@ KlaviyoAPI::Webhooks.get_webhook(id, opts)
|
|
|
4596
5114
|
|
|
4597
5115
|
|
|
4598
5116
|
|
|
4599
|
-
#### [Get Webhook Topic](https://developers.klaviyo.com/en/v2026-
|
|
5117
|
+
#### [Get Webhook Topic](https://developers.klaviyo.com/en/v2026-07-15/reference/get_webhook_topic)
|
|
4600
5118
|
|
|
4601
5119
|
```ruby
|
|
4602
|
-
KlaviyoAPI::Webhooks.get_webhook_topic(id)
|
|
5120
|
+
KlaviyoAPI::Webhooks.get_webhook_topic(id, opts)
|
|
4603
5121
|
```
|
|
4604
5122
|
|
|
4605
5123
|
|
|
4606
5124
|
|
|
4607
5125
|
|
|
4608
5126
|
|
|
4609
|
-
#### [Get Webhook Topics](https://developers.klaviyo.com/en/v2026-
|
|
5127
|
+
#### [Get Webhook Topics](https://developers.klaviyo.com/en/v2026-07-15/reference/get_webhook_topics)
|
|
4610
5128
|
|
|
4611
5129
|
```ruby
|
|
4612
|
-
KlaviyoAPI::Webhooks.get_webhook_topics
|
|
5130
|
+
KlaviyoAPI::Webhooks.get_webhook_topics(opts)
|
|
4613
5131
|
```
|
|
4614
5132
|
|
|
4615
5133
|
|
|
4616
5134
|
|
|
4617
5135
|
|
|
4618
5136
|
|
|
4619
|
-
#### [Get Webhooks](https://developers.klaviyo.com/en/v2026-
|
|
5137
|
+
#### [Get Webhooks](https://developers.klaviyo.com/en/v2026-07-15/reference/get_webhooks)
|
|
4620
5138
|
|
|
4621
5139
|
```ruby
|
|
4622
5140
|
KlaviyoAPI::Webhooks.get_webhooks(opts)
|
|
@@ -4626,10 +5144,10 @@ KlaviyoAPI::Webhooks.get_webhooks(opts)
|
|
|
4626
5144
|
|
|
4627
5145
|
|
|
4628
5146
|
|
|
4629
|
-
#### [Update Webhook](https://developers.klaviyo.com/en/v2026-
|
|
5147
|
+
#### [Update Webhook](https://developers.klaviyo.com/en/v2026-07-15/reference/update_webhook)
|
|
4630
5148
|
|
|
4631
5149
|
```ruby
|
|
4632
|
-
KlaviyoAPI::Webhooks.update_webhook(id, body)
|
|
5150
|
+
KlaviyoAPI::Webhooks.update_webhook(id, body, opts)
|
|
4633
5151
|
```
|
|
4634
5152
|
|
|
4635
5153
|
|