klaviyo-api-sdk 14.0.1 → 16.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 +17 -0
- data/README.md +332 -298
- data/klaviyo-api-sdk.gemspec +1 -1
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -6
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +82 -82
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +235 -235
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +63 -63
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +89 -13
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/events_api.rb +35 -35
- data/lib/klaviyo-api-sdk/api/flows_api.rb +180 -104
- data/lib/klaviyo-api-sdk/api/forms_api.rb +107 -51
- data/lib/klaviyo-api-sdk/api/images_api.rb +15 -15
- data/lib/klaviyo-api-sdk/api/lists_api.rb +60 -60
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +86 -86
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +132 -132
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +13 -13
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +21 -21
- data/lib/klaviyo-api-sdk/api/segments_api.rb +54 -54
- data/lib/klaviyo-api-sdk/api/tags_api.rb +58 -58
- data/lib/klaviyo-api-sdk/api/templates_api.rb +54 -54
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +9 -9
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +15 -15
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +15 -15
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/account_default_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/action_output_condition.rb +265 -0
- data/lib/klaviyo-api-sdk/models/action_output_condition_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/action_output_condition_filter2.rb +108 -0
- data/lib/klaviyo-api-sdk/models/action_output_condition_group.rb +225 -0
- data/lib/klaviyo-api-sdk/models/action_output_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/action_output_split_action.rb +263 -0
- data/lib/klaviyo-api-sdk/models/action_output_split_action_data.rb +223 -0
- data/lib/klaviyo-api-sdk/models/action_output_split_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/additional_field.rb +237 -0
- data/lib/klaviyo-api-sdk/models/after_close_or_submit_timeout_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/after_close_timeout.rb +242 -0
- data/lib/klaviyo-api-sdk/models/after_close_timeout_properties.rb +220 -0
- data/lib/klaviyo-api-sdk/models/age_gate.rb +289 -0
- data/lib/klaviyo-api-sdk/models/age_gate_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +349 -0
- data/lib/klaviyo-api-sdk/models/age_gate_styles.rb +228 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock.rb +242 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_dynamic_button_border_styles.rb +289 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_dynamic_button_data.rb +284 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_dynamic_button_drop_shadow_styles.rb +231 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_dynamic_button_styles.rb +330 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_dynamic_button_text_styles.rb +318 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox.rb +256 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_properties.rb +339 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_styles.rb +274 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_properties.rb +231 -0
- data/lib/klaviyo-api-sdk/models/background_image.rb +232 -0
- data/lib/klaviyo-api-sdk/models/background_image_styles.rb +323 -0
- data/lib/klaviyo-api-sdk/models/banner_styles.rb +290 -0
- data/lib/klaviyo-api-sdk/models/bis_promotional_email_checkbox_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/border_style.rb +285 -0
- data/lib/klaviyo-api-sdk/models/button.rb +265 -0
- data/lib/klaviyo-api-sdk/models/button_action.rb +113 -0
- data/lib/klaviyo-api-sdk/models/button_properties.rb +268 -0
- data/lib/klaviyo-api-sdk/models/button_styles.rb +333 -0
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes.rb +15 -2
- data/lib/klaviyo-api-sdk/models/cart_item_count.rb +242 -0
- data/lib/klaviyo-api-sdk/models/cart_item_count_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/cart_item_count_properties.rb +264 -0
- data/lib/klaviyo-api-sdk/models/cart_product.rb +242 -0
- data/lib/klaviyo-api-sdk/models/cart_product_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/cart_product_properties.rb +264 -0
- data/lib/klaviyo-api-sdk/models/cart_value.rb +242 -0
- data/lib/klaviyo-api-sdk/models/cart_value_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/cart_value_properties.rb +264 -0
- data/lib/klaviyo-api-sdk/models/channel.rb +247 -0
- data/lib/klaviyo-api-sdk/models/channel_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/channel_properties.rb +258 -0
- data/lib/klaviyo-api-sdk/models/channel_settings.rb +227 -0
- data/lib/klaviyo-api-sdk/models/checkboxes.rb +256 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +324 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_styles.rb +298 -0
- data/lib/klaviyo-api-sdk/models/close.rb +256 -0
- data/lib/klaviyo-api-sdk/models/close_button_style.rb +273 -0
- data/lib/klaviyo-api-sdk/models/close_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/close_properties.rb +219 -0
- data/lib/klaviyo-api-sdk/models/column.rb +239 -0
- data/lib/klaviyo-api-sdk/models/column_styles.rb +228 -0
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +3 -1
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/content_experiment_action.rb +264 -0
- data/lib/klaviyo-api-sdk/models/content_experiment_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/countdown_timer.rb +256 -0
- data/lib/klaviyo-api-sdk/models/countdown_timer_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/countdown_timer_properties.rb +305 -0
- data/lib/klaviyo-api-sdk/models/countdown_timer_properties_configuration.rb +104 -0
- data/lib/klaviyo-api-sdk/models/countdown_timer_styles.rb +305 -0
- data/lib/klaviyo-api-sdk/models/coupon.rb +256 -0
- data/lib/klaviyo-api-sdk/models/coupon_properties.rb +266 -0
- data/lib/klaviyo-api-sdk/models/coupon_properties_coupon.rb +104 -0
- data/lib/klaviyo-api-sdk/models/coupon_styles.rb +258 -0
- data/lib/klaviyo-api-sdk/models/custom_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/custom_javascript.rb +248 -0
- data/lib/klaviyo-api-sdk/models/custom_javascript_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/data_source_create_query_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/data_source_record_create_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_create_job_create_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_create_job_create_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_create_job_create_query_resource_object_attributes_data_source_record.rb +224 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_create_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/date.rb +256 -0
- data/lib/klaviyo-api-sdk/models/date_properties.rb +319 -0
- data/lib/klaviyo-api-sdk/models/date_styles.rb +228 -0
- data/lib/klaviyo-api-sdk/models/delay.rb +242 -0
- data/lib/klaviyo-api-sdk/models/delay_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/delay_properties.rb +220 -0
- data/lib/klaviyo-api-sdk/models/device.rb +242 -0
- data/lib/klaviyo-api-sdk/models/device_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/device_properties.rb +255 -0
- data/lib/klaviyo-api-sdk/models/dollar_sign_age_gated_date_of_birth_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/dollar_sign_email_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/drop_shadow.rb +243 -0
- data/lib/klaviyo-api-sdk/models/dropdown.rb +256 -0
- data/lib/klaviyo-api-sdk/models/dropdown_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +324 -0
- data/lib/klaviyo-api-sdk/models/dropdown_styles.rb +228 -0
- data/lib/klaviyo-api-sdk/models/dynamic_button.rb +282 -0
- data/lib/klaviyo-api-sdk/models/effective_date_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/effective_date_filter.rb +237 -0
- data/lib/klaviyo-api-sdk/models/email.rb +256 -0
- data/lib/klaviyo-api-sdk/models/email_properties.rb +303 -0
- data/lib/klaviyo-api-sdk/models/email_styles.rb +228 -0
- data/lib/klaviyo-api-sdk/models/error_messages.rb +231 -0
- data/lib/klaviyo-api-sdk/models/exit_intent.rb +248 -0
- data/lib/klaviyo-api-sdk/models/exit_intent_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/explicitly_reachable.rb +239 -0
- data/lib/klaviyo-api-sdk/models/explicitly_reachable_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/explicitly_reachable_filters_inner.rb +106 -0
- data/lib/klaviyo-api-sdk/models/explicitly_unreachable.rb +239 -0
- data/lib/klaviyo-api-sdk/models/explicitly_unreachable_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/fixed_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/fixed_timer_configuration.rb +281 -0
- data/lib/klaviyo-api-sdk/models/flow_action_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/flow_action_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/flow_action_update_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/flow_action_update_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/flow_action_update_query_resource_object_attributes_definition.rb +124 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +3 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_series_request_dto_resource_object_attributes.rb +15 -2
- data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_values_request_dto_resource_object_attributes.rb +15 -2
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +271 -0
- data/lib/klaviyo-api-sdk/models/form_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/form_create_query_resource_object_attributes.rb +302 -0
- data/lib/klaviyo-api-sdk/models/form_definition.rb +225 -0
- data/lib/klaviyo-api-sdk/models/form_subscribe_filter.rb +246 -0
- data/lib/klaviyo-api-sdk/models/{profile_partial_update_query_resource_object_attributes.rb → go_to_inbox.rb} +76 -115
- data/lib/klaviyo-api-sdk/models/go_to_inbox_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/html_text.rb +251 -0
- data/lib/klaviyo-api-sdk/models/html_text_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/html_text_properties.rb +253 -0
- data/lib/klaviyo-api-sdk/models/html_text_styles.rb +228 -0
- data/lib/klaviyo-api-sdk/models/identified_profiles.rb +248 -0
- data/lib/klaviyo-api-sdk/models/identified_profiles_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/image.rb +266 -0
- data/lib/klaviyo-api-sdk/models/image_action.rb +113 -0
- data/lib/klaviyo-api-sdk/models/image_asset_properties.rb +259 -0
- data/lib/klaviyo-api-sdk/models/image_properties.rb +268 -0
- data/lib/klaviyo-api-sdk/models/image_styles.rb +284 -0
- data/lib/klaviyo-api-sdk/models/implicitly_or_explicitly_reachable.rb +223 -0
- data/lib/klaviyo-api-sdk/models/implicitly_or_explicitly_reachable_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/implicitly_or_explicitly_unreachable.rb +223 -0
- data/lib/klaviyo-api-sdk/models/implicitly_or_explicitly_unreachable_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/implicitly_reachable.rb +223 -0
- data/lib/klaviyo-api-sdk/models/implicitly_reachable_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/implicitly_unreachable.rb +223 -0
- data/lib/klaviyo-api-sdk/models/implicitly_unreachable_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/input_styles.rb +317 -0
- data/lib/klaviyo-api-sdk/models/link_styles.rb +229 -0
- data/lib/klaviyo-api-sdk/models/list_create_query_resource_object_attributes.rb +49 -4
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/list_partial_update_query_resource_object_attributes.rb +265 -0
- data/lib/klaviyo-api-sdk/models/list_update_action.rb +18 -18
- data/lib/klaviyo-api-sdk/models/list_update_action_data.rb +1 -1
- data/lib/klaviyo-api-sdk/models/lists_and_segments.rb +247 -0
- data/lib/klaviyo-api-sdk/models/lists_and_segments_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/lists_and_segments_properties.rb +233 -0
- data/lib/klaviyo-api-sdk/models/location.rb +247 -0
- data/lib/klaviyo-api-sdk/models/location_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/location_properties.rb +233 -0
- data/lib/klaviyo-api-sdk/models/location_properties_allow_list_inner.rb +103 -0
- data/lib/klaviyo-api-sdk/models/margin.rb +253 -0
- data/lib/klaviyo-api-sdk/models/method_filter.rb +272 -0
- data/lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb +2 -2
- data/lib/klaviyo-api-sdk/models/mobile_overlay.rb +266 -0
- data/lib/klaviyo-api-sdk/models/next_step.rb +256 -0
- data/lib/klaviyo-api-sdk/models/next_step_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/next_step_properties.rb +219 -0
- data/lib/klaviyo-api-sdk/models/open_form.rb +292 -0
- data/lib/klaviyo-api-sdk/models/open_form_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/open_form_properties.rb +234 -0
- data/lib/klaviyo-api-sdk/models/opt_in_code.rb +256 -0
- data/lib/klaviyo-api-sdk/models/opt_in_code_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +314 -0
- data/lib/klaviyo-api-sdk/models/opt_in_code_styles.rb +228 -0
- data/lib/klaviyo-api-sdk/models/opt_in_promotional_email_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/opt_in_promotional_sms_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/padding.rb +253 -0
- data/lib/klaviyo-api-sdk/models/page_visits.rb +242 -0
- data/lib/klaviyo-api-sdk/models/page_visits_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/page_visits_properties.rb +220 -0
- data/lib/klaviyo-api-sdk/models/phone_number.rb +256 -0
- data/lib/klaviyo-api-sdk/models/phone_number_consent_channel_settings.rb +254 -0
- data/lib/klaviyo-api-sdk/models/phone_number_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +326 -0
- data/lib/klaviyo-api-sdk/models/phone_number_styles.rb +228 -0
- data/lib/klaviyo-api-sdk/models/previously_submitted.rb +248 -0
- data/lib/klaviyo-api-sdk/models/previously_submitted_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_event_tracked.rb +247 -0
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +223 -0
- data/lib/klaviyo-api-sdk/models/profile_has_not_received_email_message_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{profile_not_in_flow_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_identifier_dto_resource_object_attributes.rb +5 -15
- data/lib/klaviyo-api-sdk/models/profile_metric_funnel_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_metric_funnel_steps.rb +249 -0
- data/lib/klaviyo-api-sdk/models/profile_not_in_flow_condition.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/profile_permissions_condition.rb +286 -0
- data/lib/klaviyo-api-sdk/models/profile_permissions_condition_permission.rb +108 -0
- data/lib/klaviyo-api-sdk/models/profile_permissions_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb +1 -12
- data/lib/klaviyo-api-sdk/models/promotional_sms_checkbox_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/promotional_sms_subscription.rb +299 -0
- data/lib/klaviyo-api-sdk/models/promotional_sms_subscription_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/property_option.rb +237 -0
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -12
- data/lib/klaviyo-api-sdk/models/quote_style.rb +321 -0
- data/lib/klaviyo-api-sdk/models/radio_buttons.rb +256 -0
- data/lib/klaviyo-api-sdk/models/radio_buttons_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +324 -0
- data/lib/klaviyo-api-sdk/models/radio_buttons_styles.rb +298 -0
- data/lib/klaviyo-api-sdk/models/rating_style.rb +323 -0
- data/lib/klaviyo-api-sdk/models/recorded_date_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/recorded_date_filter.rb +237 -0
- data/lib/klaviyo-api-sdk/models/redirect.rb +261 -0
- data/lib/klaviyo-api-sdk/models/redirect_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/redirect_properties.rb +244 -0
- data/lib/klaviyo-api-sdk/models/resend_opt_in_code.rb +299 -0
- data/lib/klaviyo-api-sdk/models/resend_opt_in_code_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/review.rb +256 -0
- data/lib/klaviyo-api-sdk/models/review_properties.rb +327 -0
- data/lib/klaviyo-api-sdk/models/review_styles.rb +266 -0
- data/lib/klaviyo-api-sdk/models/reviewer_name_style.rb +345 -0
- data/lib/klaviyo-api-sdk/models/rich_text_margin.rb +311 -0
- data/lib/klaviyo-api-sdk/models/rich_text_style.rb +343 -0
- data/lib/klaviyo-api-sdk/models/rich_text_styles.rb +281 -0
- data/lib/klaviyo-api-sdk/models/row.rb +235 -0
- data/lib/klaviyo-api-sdk/models/row_blocks_inner.rb +122 -0
- data/lib/klaviyo-api-sdk/models/scroll.rb +242 -0
- data/lib/klaviyo-api-sdk/models/scroll_percentage_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/scroll_properties.rb +220 -0
- data/lib/klaviyo-api-sdk/models/segments_profile_metric_funnel_condition.rb +298 -0
- data/lib/klaviyo-api-sdk/models/segments_profile_metric_funnel_condition_timeframe_filter.rb +105 -0
- data/lib/klaviyo-api-sdk/models/send_email_action_data.rb +0 -5
- data/lib/klaviyo-api-sdk/models/send_push_notification_action_data.rb +0 -5
- data/lib/klaviyo-api-sdk/models/send_sms_action_data.rb +0 -5
- data/lib/klaviyo-api-sdk/models/send_whats_app_action.rb +263 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action_data.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_whatsapp_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/side_image_settings.rb +290 -0
- data/lib/klaviyo-api-sdk/models/signup_counter.rb +256 -0
- data/lib/klaviyo-api-sdk/models/signup_counter_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/signup_counter_properties.rb +297 -0
- data/lib/klaviyo-api-sdk/models/signup_counter_styles.rb +228 -0
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox.rb +256 -0
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_properties.rb +350 -0
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_styles.rb +274 -0
- data/lib/klaviyo-api-sdk/models/sms_disclosure.rb +251 -0
- data/lib/klaviyo-api-sdk/models/sms_disclosure_account_default.rb +233 -0
- data/lib/klaviyo-api-sdk/models/sms_disclosure_custom.rb +267 -0
- data/lib/klaviyo-api-sdk/models/sms_disclosure_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/sms_disclosure_properties.rb +251 -0
- data/lib/klaviyo-api-sdk/models/sms_disclosure_properties_content.rb +104 -0
- data/lib/klaviyo-api-sdk/models/sms_disclosure_styles.rb +246 -0
- data/lib/klaviyo-api-sdk/models/sms_disclosure_text_style.rb +299 -0
- data/lib/klaviyo-api-sdk/models/spin_to_win.rb +256 -0
- data/lib/klaviyo-api-sdk/models/spin_to_win_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +269 -0
- data/lib/klaviyo-api-sdk/models/spin_to_win_slice_config.rb +251 -0
- data/lib/klaviyo-api-sdk/models/spin_to_win_slice_style.rb +231 -0
- data/lib/klaviyo-api-sdk/models/spin_to_win_styles.rb +303 -0
- data/lib/klaviyo-api-sdk/models/static_coupon_config.rb +233 -0
- data/lib/klaviyo-api-sdk/models/step.rb +257 -0
- data/lib/klaviyo-api-sdk/models/string_operator_filter.rb +2 -2
- data/lib/klaviyo-api-sdk/models/string_phone_operator_array_filter.rb +1 -1
- data/lib/klaviyo-api-sdk/models/submit_back_in_stock.rb +287 -0
- data/lib/klaviyo-api-sdk/models/submit_back_in_stock_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/submit_back_in_stock_properties.rb +219 -0
- data/lib/klaviyo-api-sdk/models/submit_opt_in_code.rb +299 -0
- data/lib/klaviyo-api-sdk/models/submit_opt_in_code_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/subscribe_method_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/subscribe_via_sms.rb +292 -0
- data/lib/klaviyo-api-sdk/models/subscribe_via_sms_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/subscribe_via_sms_properties.rb +243 -0
- data/lib/klaviyo-api-sdk/models/subscribe_via_whats_app.rb +292 -0
- data/lib/klaviyo-api-sdk/models/subscribe_via_whats_app_properties.rb +243 -0
- data/lib/klaviyo-api-sdk/models/subscribe_via_whatsapp_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/subscription_channels.rb +13 -4
- data/lib/klaviyo-api-sdk/models/teaser.rb +405 -0
- data/lib/klaviyo-api-sdk/models/teaser_styles.rb +267 -0
- data/lib/klaviyo-api-sdk/models/text.rb +256 -0
- data/lib/klaviyo-api-sdk/models/text_properties.rb +308 -0
- data/lib/klaviyo-api-sdk/models/text_style.rb +299 -0
- data/lib/klaviyo-api-sdk/models/text_style_font_family.rb +103 -0
- data/lib/klaviyo-api-sdk/models/text_styles.rb +228 -0
- data/lib/klaviyo-api-sdk/models/underline_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/unidentified_profiles.rb +248 -0
- data/lib/klaviyo-api-sdk/models/unidentified_profiles_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/unique_coupon_config.rb +299 -0
- data/lib/klaviyo-api-sdk/models/unique_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/unsubscription_channels.rb +13 -4
- data/lib/klaviyo-api-sdk/models/url_patterns.rb +242 -0
- data/lib/klaviyo-api-sdk/models/url_patterns_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/url_patterns_properties.rb +233 -0
- data/lib/klaviyo-api-sdk/models/variable_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/variable_timer_configuration.rb +265 -0
- data/lib/klaviyo-api-sdk/models/version.rb +409 -0
- data/lib/klaviyo-api-sdk/models/version_properties.rb +299 -0
- data/lib/klaviyo-api-sdk/models/version_styles.rb +412 -0
- data/lib/klaviyo-api-sdk/models/version_triggers_inner.rb +121 -0
- data/lib/klaviyo-api-sdk/models/whats_app_subscription_parameters.rb +227 -0
- data/lib/klaviyo-api-sdk/models/whats_app_unsubscription_parameters.rb +236 -0
- data/lib/klaviyo-api-sdk.rb +280 -2
- data/lib/klaviyo-api-sdk.rb.bak +280 -2
- data/spec/.DS_Store +0 -0
- metadata +283 -4
data/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# Klaviyo Ruby SDK
|
|
2
2
|
|
|
3
|
-
- SDK version:
|
|
4
|
-
- API revision:
|
|
3
|
+
- SDK version: 16.0.0
|
|
4
|
+
- API revision: 2026-01-15
|
|
5
5
|
|
|
6
6
|
## Helpful Resources
|
|
7
7
|
|
|
8
|
-
- [API Reference](https://developers.klaviyo.com/en/
|
|
9
|
-
- [API Guides](https://developers.klaviyo.com/en/
|
|
8
|
+
- [API Reference](https://developers.klaviyo.com/en/v2026-01-15/reference)
|
|
9
|
+
- [API Guides](https://developers.klaviyo.com/en/v2026-01-15/docs)
|
|
10
10
|
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)
|
|
11
11
|
|
|
12
12
|
## Design & Approach
|
|
@@ -118,13 +118,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
|
118
118
|
Then install the gem locally:
|
|
119
119
|
|
|
120
120
|
```shell
|
|
121
|
-
gem install ./klaviyo-api-sdk-
|
|
121
|
+
gem install ./klaviyo-api-sdk-16.0.0.gem
|
|
122
122
|
```
|
|
123
123
|
|
|
124
124
|
|
|
125
125
|
Finally add this to the Gemfile:
|
|
126
126
|
|
|
127
|
-
gem 'klaviyo-api-sdk', '~>
|
|
127
|
+
gem 'klaviyo-api-sdk', '~> 16.0.0'
|
|
128
128
|
|
|
129
129
|
To install directly from rubygems:
|
|
130
130
|
|
|
@@ -518,7 +518,7 @@ response = KlaviyoAPI::Events.get_events(opts)
|
|
|
518
518
|
## Comprehensive list of Operations & Parameters
|
|
519
519
|
|
|
520
520
|
_**NOTE:**_
|
|
521
|
-
- 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/
|
|
521
|
+
- 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-01-15/reference/get_events).
|
|
522
522
|
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
|
523
523
|
- Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.
|
|
524
524
|
|
|
@@ -530,7 +530,7 @@ _**NOTE:**_
|
|
|
530
530
|
## Accounts
|
|
531
531
|
|
|
532
532
|
|
|
533
|
-
#### [Get Account](https://developers.klaviyo.com/en/
|
|
533
|
+
#### [Get Account](https://developers.klaviyo.com/en/v2026-01-15/reference/get_account)
|
|
534
534
|
|
|
535
535
|
```ruby
|
|
536
536
|
KlaviyoAPI::Accounts.get_account(id, opts)
|
|
@@ -540,7 +540,7 @@ KlaviyoAPI::Accounts.get_account(id, opts)
|
|
|
540
540
|
|
|
541
541
|
|
|
542
542
|
|
|
543
|
-
#### [Get Accounts](https://developers.klaviyo.com/en/
|
|
543
|
+
#### [Get Accounts](https://developers.klaviyo.com/en/v2026-01-15/reference/get_accounts)
|
|
544
544
|
|
|
545
545
|
```ruby
|
|
546
546
|
KlaviyoAPI::Accounts.get_accounts(opts)
|
|
@@ -554,7 +554,7 @@ KlaviyoAPI::Accounts.get_accounts(opts)
|
|
|
554
554
|
## Campaigns
|
|
555
555
|
|
|
556
556
|
|
|
557
|
-
#### [Assign Template to Campaign Message](https://developers.klaviyo.com/en/
|
|
557
|
+
#### [Assign Template to Campaign Message](https://developers.klaviyo.com/en/v2026-01-15/reference/assign_template_to_campaign_message)
|
|
558
558
|
|
|
559
559
|
```ruby
|
|
560
560
|
KlaviyoAPI::Campaigns.assign_template_to_campaign_message(body)
|
|
@@ -568,7 +568,7 @@ KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body)
|
|
|
568
568
|
|
|
569
569
|
|
|
570
570
|
|
|
571
|
-
#### [Cancel Campaign Send](https://developers.klaviyo.com/en/
|
|
571
|
+
#### [Cancel Campaign Send](https://developers.klaviyo.com/en/v2026-01-15/reference/cancel_campaign_send)
|
|
572
572
|
|
|
573
573
|
```ruby
|
|
574
574
|
KlaviyoAPI::Campaigns.cancel_campaign_send(id, body)
|
|
@@ -582,7 +582,7 @@ KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
|
|
|
582
582
|
|
|
583
583
|
|
|
584
584
|
|
|
585
|
-
#### [Create Campaign](https://developers.klaviyo.com/en/
|
|
585
|
+
#### [Create Campaign](https://developers.klaviyo.com/en/v2026-01-15/reference/create_campaign)
|
|
586
586
|
|
|
587
587
|
```ruby
|
|
588
588
|
KlaviyoAPI::Campaigns.create_campaign(body)
|
|
@@ -592,7 +592,7 @@ KlaviyoAPI::Campaigns.create_campaign(body)
|
|
|
592
592
|
|
|
593
593
|
|
|
594
594
|
|
|
595
|
-
#### [Create Campaign Clone](https://developers.klaviyo.com/en/
|
|
595
|
+
#### [Create Campaign Clone](https://developers.klaviyo.com/en/v2026-01-15/reference/create_campaign_clone)
|
|
596
596
|
|
|
597
597
|
```ruby
|
|
598
598
|
KlaviyoAPI::Campaigns.create_campaign_clone(body)
|
|
@@ -606,7 +606,7 @@ KlaviyoAPI::Campaigns.clone_campaign(body)
|
|
|
606
606
|
|
|
607
607
|
|
|
608
608
|
|
|
609
|
-
#### [Delete Campaign](https://developers.klaviyo.com/en/
|
|
609
|
+
#### [Delete Campaign](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_campaign)
|
|
610
610
|
|
|
611
611
|
```ruby
|
|
612
612
|
KlaviyoAPI::Campaigns.delete_campaign(id)
|
|
@@ -616,7 +616,7 @@ KlaviyoAPI::Campaigns.delete_campaign(id)
|
|
|
616
616
|
|
|
617
617
|
|
|
618
618
|
|
|
619
|
-
#### [Get Campaign](https://developers.klaviyo.com/en/
|
|
619
|
+
#### [Get Campaign](https://developers.klaviyo.com/en/v2026-01-15/reference/get_campaign)
|
|
620
620
|
|
|
621
621
|
```ruby
|
|
622
622
|
KlaviyoAPI::Campaigns.get_campaign(id, opts)
|
|
@@ -626,7 +626,7 @@ KlaviyoAPI::Campaigns.get_campaign(id, opts)
|
|
|
626
626
|
|
|
627
627
|
|
|
628
628
|
|
|
629
|
-
#### [Get Campaign for Campaign Message](https://developers.klaviyo.com/en/
|
|
629
|
+
#### [Get Campaign for Campaign Message](https://developers.klaviyo.com/en/v2026-01-15/reference/get_campaign_for_campaign_message)
|
|
630
630
|
|
|
631
631
|
```ruby
|
|
632
632
|
KlaviyoAPI::Campaigns.get_campaign_for_campaign_message(id, opts)
|
|
@@ -640,7 +640,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_campaign(id, opts)
|
|
|
640
640
|
|
|
641
641
|
|
|
642
642
|
|
|
643
|
-
#### [Get Campaign ID for Campaign Message](https://developers.klaviyo.com/en/
|
|
643
|
+
#### [Get Campaign ID for Campaign Message](https://developers.klaviyo.com/en/v2026-01-15/reference/get_campaign_id_for_campaign_message)
|
|
644
644
|
|
|
645
645
|
```ruby
|
|
646
646
|
KlaviyoAPI::Campaigns.get_campaign_id_for_campaign_message(id)
|
|
@@ -654,7 +654,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_relationships_campaign(id)
|
|
|
654
654
|
|
|
655
655
|
|
|
656
656
|
|
|
657
|
-
#### [Get Campaign Message](https://developers.klaviyo.com/en/
|
|
657
|
+
#### [Get Campaign Message](https://developers.klaviyo.com/en/v2026-01-15/reference/get_campaign_message)
|
|
658
658
|
|
|
659
659
|
```ruby
|
|
660
660
|
KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
|
|
@@ -664,7 +664,7 @@ KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
|
|
|
664
664
|
|
|
665
665
|
|
|
666
666
|
|
|
667
|
-
#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/
|
|
667
|
+
#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2026-01-15/reference/get_campaign_recipient_estimation)
|
|
668
668
|
|
|
669
669
|
```ruby
|
|
670
670
|
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
|
|
@@ -674,7 +674,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
|
|
|
674
674
|
|
|
675
675
|
|
|
676
676
|
|
|
677
|
-
#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/
|
|
677
|
+
#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_campaign_recipient_estimation_job)
|
|
678
678
|
|
|
679
679
|
```ruby
|
|
680
680
|
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
|
|
@@ -684,7 +684,7 @@ KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
|
|
|
684
684
|
|
|
685
685
|
|
|
686
686
|
|
|
687
|
-
#### [Get Campaign Send Job](https://developers.klaviyo.com/en/
|
|
687
|
+
#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_campaign_send_job)
|
|
688
688
|
|
|
689
689
|
```ruby
|
|
690
690
|
KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
|
@@ -694,7 +694,7 @@ KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
|
|
694
694
|
|
|
695
695
|
|
|
696
696
|
|
|
697
|
-
#### [Get Campaigns](https://developers.klaviyo.com/en/
|
|
697
|
+
#### [Get Campaigns](https://developers.klaviyo.com/en/v2026-01-15/reference/get_campaigns)
|
|
698
698
|
|
|
699
699
|
```ruby
|
|
700
700
|
KlaviyoAPI::Campaigns.get_campaigns(filter, opts)
|
|
@@ -704,7 +704,7 @@ KlaviyoAPI::Campaigns.get_campaigns(filter, opts)
|
|
|
704
704
|
|
|
705
705
|
|
|
706
706
|
|
|
707
|
-
#### [Get Image for Campaign Message](https://developers.klaviyo.com/en/
|
|
707
|
+
#### [Get Image for Campaign Message](https://developers.klaviyo.com/en/v2026-01-15/reference/get_image_for_campaign_message)
|
|
708
708
|
|
|
709
709
|
```ruby
|
|
710
710
|
KlaviyoAPI::Campaigns.get_image_for_campaign_message(id, opts)
|
|
@@ -718,7 +718,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_image(id, opts)
|
|
|
718
718
|
|
|
719
719
|
|
|
720
720
|
|
|
721
|
-
#### [Get Image ID for Campaign Message](https://developers.klaviyo.com/en/
|
|
721
|
+
#### [Get Image ID for Campaign Message](https://developers.klaviyo.com/en/v2026-01-15/reference/get_image_id_for_campaign_message)
|
|
722
722
|
|
|
723
723
|
```ruby
|
|
724
724
|
KlaviyoAPI::Campaigns.get_image_id_for_campaign_message(id)
|
|
@@ -732,7 +732,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_relationships_image(id)
|
|
|
732
732
|
|
|
733
733
|
|
|
734
734
|
|
|
735
|
-
#### [Get Message IDs for Campaign](https://developers.klaviyo.com/en/
|
|
735
|
+
#### [Get Message IDs for Campaign](https://developers.klaviyo.com/en/v2026-01-15/reference/get_message_ids_for_campaign)
|
|
736
736
|
|
|
737
737
|
```ruby
|
|
738
738
|
KlaviyoAPI::Campaigns.get_message_ids_for_campaign(id)
|
|
@@ -750,7 +750,7 @@ KlaviyoAPI::Campaigns.get_campaign_relationships_messages(id)
|
|
|
750
750
|
|
|
751
751
|
|
|
752
752
|
|
|
753
|
-
#### [Get Messages for Campaign](https://developers.klaviyo.com/en/
|
|
753
|
+
#### [Get Messages for Campaign](https://developers.klaviyo.com/en/v2026-01-15/reference/get_messages_for_campaign)
|
|
754
754
|
|
|
755
755
|
```ruby
|
|
756
756
|
KlaviyoAPI::Campaigns.get_messages_for_campaign(id, opts)
|
|
@@ -768,7 +768,7 @@ KlaviyoAPI::Campaigns.get_campaign_messages(id, opts)
|
|
|
768
768
|
|
|
769
769
|
|
|
770
770
|
|
|
771
|
-
#### [Get Tag IDs for Campaign](https://developers.klaviyo.com/en/
|
|
771
|
+
#### [Get Tag IDs for Campaign](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tag_ids_for_campaign)
|
|
772
772
|
|
|
773
773
|
```ruby
|
|
774
774
|
KlaviyoAPI::Campaigns.get_tag_ids_for_campaign(id)
|
|
@@ -782,7 +782,7 @@ KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
|
|
|
782
782
|
|
|
783
783
|
|
|
784
784
|
|
|
785
|
-
#### [Get Tags for Campaign](https://developers.klaviyo.com/en/
|
|
785
|
+
#### [Get Tags for Campaign](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tags_for_campaign)
|
|
786
786
|
|
|
787
787
|
```ruby
|
|
788
788
|
KlaviyoAPI::Campaigns.get_tags_for_campaign(id, opts)
|
|
@@ -796,7 +796,7 @@ KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
|
|
|
796
796
|
|
|
797
797
|
|
|
798
798
|
|
|
799
|
-
#### [Get Template for Campaign Message](https://developers.klaviyo.com/en/
|
|
799
|
+
#### [Get Template for Campaign Message](https://developers.klaviyo.com/en/v2026-01-15/reference/get_template_for_campaign_message)
|
|
800
800
|
|
|
801
801
|
```ruby
|
|
802
802
|
KlaviyoAPI::Campaigns.get_template_for_campaign_message(id, opts)
|
|
@@ -810,7 +810,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_template(id, opts)
|
|
|
810
810
|
|
|
811
811
|
|
|
812
812
|
|
|
813
|
-
#### [Get Template ID for Campaign Message](https://developers.klaviyo.com/en/
|
|
813
|
+
#### [Get Template ID for Campaign Message](https://developers.klaviyo.com/en/v2026-01-15/reference/get_template_id_for_campaign_message)
|
|
814
814
|
|
|
815
815
|
```ruby
|
|
816
816
|
KlaviyoAPI::Campaigns.get_template_id_for_campaign_message(id)
|
|
@@ -824,7 +824,7 @@ KlaviyoAPI::Campaigns.get_campaign_message_relationships_template(id)
|
|
|
824
824
|
|
|
825
825
|
|
|
826
826
|
|
|
827
|
-
#### [Refresh Campaign Recipient Estimation](https://developers.klaviyo.com/en/
|
|
827
|
+
#### [Refresh Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2026-01-15/reference/refresh_campaign_recipient_estimation)
|
|
828
828
|
|
|
829
829
|
```ruby
|
|
830
830
|
KlaviyoAPI::Campaigns.refresh_campaign_recipient_estimation(body)
|
|
@@ -838,7 +838,7 @@ KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body)
|
|
|
838
838
|
|
|
839
839
|
|
|
840
840
|
|
|
841
|
-
#### [Send Campaign](https://developers.klaviyo.com/en/
|
|
841
|
+
#### [Send Campaign](https://developers.klaviyo.com/en/v2026-01-15/reference/send_campaign)
|
|
842
842
|
|
|
843
843
|
```ruby
|
|
844
844
|
KlaviyoAPI::Campaigns.send_campaign(body)
|
|
@@ -852,7 +852,7 @@ KlaviyoAPI::Campaigns.create_campaign_send_job(body)
|
|
|
852
852
|
|
|
853
853
|
|
|
854
854
|
|
|
855
|
-
#### [Update Campaign](https://developers.klaviyo.com/en/
|
|
855
|
+
#### [Update Campaign](https://developers.klaviyo.com/en/v2026-01-15/reference/update_campaign)
|
|
856
856
|
|
|
857
857
|
```ruby
|
|
858
858
|
KlaviyoAPI::Campaigns.update_campaign(id, body)
|
|
@@ -862,7 +862,7 @@ KlaviyoAPI::Campaigns.update_campaign(id, body)
|
|
|
862
862
|
|
|
863
863
|
|
|
864
864
|
|
|
865
|
-
#### [Update Campaign Message](https://developers.klaviyo.com/en/
|
|
865
|
+
#### [Update Campaign Message](https://developers.klaviyo.com/en/v2026-01-15/reference/update_campaign_message)
|
|
866
866
|
|
|
867
867
|
```ruby
|
|
868
868
|
KlaviyoAPI::Campaigns.update_campaign_message(id, body)
|
|
@@ -872,7 +872,7 @@ KlaviyoAPI::Campaigns.update_campaign_message(id, body)
|
|
|
872
872
|
|
|
873
873
|
|
|
874
874
|
|
|
875
|
-
#### [Update Image for Campaign Message](https://developers.klaviyo.com/en/
|
|
875
|
+
#### [Update Image for Campaign Message](https://developers.klaviyo.com/en/v2026-01-15/reference/update_image_for_campaign_message)
|
|
876
876
|
|
|
877
877
|
```ruby
|
|
878
878
|
KlaviyoAPI::Campaigns.update_image_for_campaign_message(id, body)
|
|
@@ -890,7 +890,7 @@ KlaviyoAPI::Campaigns.update_campaign_message_relationships_image(id, body)
|
|
|
890
890
|
## Catalogs
|
|
891
891
|
|
|
892
892
|
|
|
893
|
-
#### [Add Categories to Catalog Item](https://developers.klaviyo.com/en/
|
|
893
|
+
#### [Add Categories to Catalog Item](https://developers.klaviyo.com/en/v2026-01-15/reference/add_categories_to_catalog_item)
|
|
894
894
|
|
|
895
895
|
```ruby
|
|
896
896
|
KlaviyoAPI::Catalogs.add_categories_to_catalog_item(id, body)
|
|
@@ -912,7 +912,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
|
|
|
912
912
|
|
|
913
913
|
|
|
914
914
|
|
|
915
|
-
#### [Add Items to Catalog Category](https://developers.klaviyo.com/en/
|
|
915
|
+
#### [Add Items to Catalog Category](https://developers.klaviyo.com/en/v2026-01-15/reference/add_items_to_catalog_category)
|
|
916
916
|
|
|
917
917
|
```ruby
|
|
918
918
|
KlaviyoAPI::Catalogs.add_items_to_catalog_category(id, body)
|
|
@@ -930,7 +930,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
|
|
|
930
930
|
|
|
931
931
|
|
|
932
932
|
|
|
933
|
-
#### [Bulk Create Catalog Categories](https://developers.klaviyo.com/en/
|
|
933
|
+
#### [Bulk Create Catalog Categories](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_create_catalog_categories)
|
|
934
934
|
|
|
935
935
|
```ruby
|
|
936
936
|
KlaviyoAPI::Catalogs.bulk_create_catalog_categories(body)
|
|
@@ -948,7 +948,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_bulk_create_job(body)
|
|
|
948
948
|
|
|
949
949
|
|
|
950
950
|
|
|
951
|
-
#### [Bulk Create Catalog Items](https://developers.klaviyo.com/en/
|
|
951
|
+
#### [Bulk Create Catalog Items](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_create_catalog_items)
|
|
952
952
|
|
|
953
953
|
```ruby
|
|
954
954
|
KlaviyoAPI::Catalogs.bulk_create_catalog_items(body)
|
|
@@ -966,7 +966,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_bulk_create_job(body)
|
|
|
966
966
|
|
|
967
967
|
|
|
968
968
|
|
|
969
|
-
#### [Bulk Create Catalog Variants](https://developers.klaviyo.com/en/
|
|
969
|
+
#### [Bulk Create Catalog Variants](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_create_catalog_variants)
|
|
970
970
|
|
|
971
971
|
```ruby
|
|
972
972
|
KlaviyoAPI::Catalogs.bulk_create_catalog_variants(body)
|
|
@@ -984,7 +984,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant_bulk_create_job(body)
|
|
|
984
984
|
|
|
985
985
|
|
|
986
986
|
|
|
987
|
-
#### [Bulk Delete Catalog Categories](https://developers.klaviyo.com/en/
|
|
987
|
+
#### [Bulk Delete Catalog Categories](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_delete_catalog_categories)
|
|
988
988
|
|
|
989
989
|
```ruby
|
|
990
990
|
KlaviyoAPI::Catalogs.bulk_delete_catalog_categories(body)
|
|
@@ -1002,7 +1002,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_bulk_delete_job(body)
|
|
|
1002
1002
|
|
|
1003
1003
|
|
|
1004
1004
|
|
|
1005
|
-
#### [Bulk Delete Catalog Items](https://developers.klaviyo.com/en/
|
|
1005
|
+
#### [Bulk Delete Catalog Items](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_delete_catalog_items)
|
|
1006
1006
|
|
|
1007
1007
|
```ruby
|
|
1008
1008
|
KlaviyoAPI::Catalogs.bulk_delete_catalog_items(body)
|
|
@@ -1020,7 +1020,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_bulk_delete_job(body)
|
|
|
1020
1020
|
|
|
1021
1021
|
|
|
1022
1022
|
|
|
1023
|
-
#### [Bulk Delete Catalog Variants](https://developers.klaviyo.com/en/
|
|
1023
|
+
#### [Bulk Delete Catalog Variants](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_delete_catalog_variants)
|
|
1024
1024
|
|
|
1025
1025
|
```ruby
|
|
1026
1026
|
KlaviyoAPI::Catalogs.bulk_delete_catalog_variants(body)
|
|
@@ -1038,7 +1038,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant_bulk_delete_job(body)
|
|
|
1038
1038
|
|
|
1039
1039
|
|
|
1040
1040
|
|
|
1041
|
-
#### [Bulk Update Catalog Categories](https://developers.klaviyo.com/en/
|
|
1041
|
+
#### [Bulk Update Catalog Categories](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_update_catalog_categories)
|
|
1042
1042
|
|
|
1043
1043
|
```ruby
|
|
1044
1044
|
KlaviyoAPI::Catalogs.bulk_update_catalog_categories(body)
|
|
@@ -1056,7 +1056,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_bulk_update_job(body)
|
|
|
1056
1056
|
|
|
1057
1057
|
|
|
1058
1058
|
|
|
1059
|
-
#### [Bulk Update Catalog Items](https://developers.klaviyo.com/en/
|
|
1059
|
+
#### [Bulk Update Catalog Items](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_update_catalog_items)
|
|
1060
1060
|
|
|
1061
1061
|
```ruby
|
|
1062
1062
|
KlaviyoAPI::Catalogs.bulk_update_catalog_items(body)
|
|
@@ -1074,7 +1074,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_bulk_update_job(body)
|
|
|
1074
1074
|
|
|
1075
1075
|
|
|
1076
1076
|
|
|
1077
|
-
#### [Bulk Update Catalog Variants](https://developers.klaviyo.com/en/
|
|
1077
|
+
#### [Bulk Update Catalog Variants](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_update_catalog_variants)
|
|
1078
1078
|
|
|
1079
1079
|
```ruby
|
|
1080
1080
|
KlaviyoAPI::Catalogs.bulk_update_catalog_variants(body)
|
|
@@ -1092,7 +1092,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant_bulk_update_job(body)
|
|
|
1092
1092
|
|
|
1093
1093
|
|
|
1094
1094
|
|
|
1095
|
-
#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/
|
|
1095
|
+
#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2026-01-15/reference/create_back_in_stock_subscription)
|
|
1096
1096
|
|
|
1097
1097
|
```ruby
|
|
1098
1098
|
KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
|
|
@@ -1102,7 +1102,7 @@ KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
|
|
|
1102
1102
|
|
|
1103
1103
|
|
|
1104
1104
|
|
|
1105
|
-
#### [Create Catalog Category](https://developers.klaviyo.com/en/
|
|
1105
|
+
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2026-01-15/reference/create_catalog_category)
|
|
1106
1106
|
|
|
1107
1107
|
```ruby
|
|
1108
1108
|
KlaviyoAPI::Catalogs.create_catalog_category(body)
|
|
@@ -1112,7 +1112,7 @@ KlaviyoAPI::Catalogs.create_catalog_category(body)
|
|
|
1112
1112
|
|
|
1113
1113
|
|
|
1114
1114
|
|
|
1115
|
-
#### [Create Catalog Item](https://developers.klaviyo.com/en/
|
|
1115
|
+
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2026-01-15/reference/create_catalog_item)
|
|
1116
1116
|
|
|
1117
1117
|
```ruby
|
|
1118
1118
|
KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
@@ -1122,7 +1122,7 @@ KlaviyoAPI::Catalogs.create_catalog_item(body)
|
|
|
1122
1122
|
|
|
1123
1123
|
|
|
1124
1124
|
|
|
1125
|
-
#### [Create Catalog Variant](https://developers.klaviyo.com/en/
|
|
1125
|
+
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2026-01-15/reference/create_catalog_variant)
|
|
1126
1126
|
|
|
1127
1127
|
```ruby
|
|
1128
1128
|
KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
|
@@ -1132,7 +1132,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant(body)
|
|
|
1132
1132
|
|
|
1133
1133
|
|
|
1134
1134
|
|
|
1135
|
-
#### [Delete Catalog Category](https://developers.klaviyo.com/en/
|
|
1135
|
+
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_catalog_category)
|
|
1136
1136
|
|
|
1137
1137
|
```ruby
|
|
1138
1138
|
KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
|
@@ -1142,7 +1142,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
|
|
1142
1142
|
|
|
1143
1143
|
|
|
1144
1144
|
|
|
1145
|
-
#### [Delete Catalog Item](https://developers.klaviyo.com/en/
|
|
1145
|
+
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_catalog_item)
|
|
1146
1146
|
|
|
1147
1147
|
```ruby
|
|
1148
1148
|
KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
|
@@ -1152,7 +1152,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
|
|
1152
1152
|
|
|
1153
1153
|
|
|
1154
1154
|
|
|
1155
|
-
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/
|
|
1155
|
+
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_catalog_variant)
|
|
1156
1156
|
|
|
1157
1157
|
```ruby
|
|
1158
1158
|
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
|
@@ -1162,7 +1162,7 @@ KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
|
|
1162
1162
|
|
|
1163
1163
|
|
|
1164
1164
|
|
|
1165
|
-
#### [Get Bulk Create Catalog Items Job](https://developers.klaviyo.com/en/
|
|
1165
|
+
#### [Get Bulk Create Catalog Items Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_create_catalog_items_job)
|
|
1166
1166
|
|
|
1167
1167
|
```ruby
|
|
1168
1168
|
KlaviyoAPI::Catalogs.get_bulk_create_catalog_items_job(job_id, opts)
|
|
@@ -1180,7 +1180,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_job(job_id, opts)
|
|
|
1180
1180
|
|
|
1181
1181
|
|
|
1182
1182
|
|
|
1183
|
-
#### [Get Bulk Create Catalog Items Jobs](https://developers.klaviyo.com/en/
|
|
1183
|
+
#### [Get Bulk Create Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_create_catalog_items_jobs)
|
|
1184
1184
|
|
|
1185
1185
|
```ruby
|
|
1186
1186
|
KlaviyoAPI::Catalogs.get_bulk_create_catalog_items_jobs(opts)
|
|
@@ -1198,7 +1198,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_jobs(opts)
|
|
|
1198
1198
|
|
|
1199
1199
|
|
|
1200
1200
|
|
|
1201
|
-
#### [Get Bulk Create Categories Job](https://developers.klaviyo.com/en/
|
|
1201
|
+
#### [Get Bulk Create Categories Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_create_categories_job)
|
|
1202
1202
|
|
|
1203
1203
|
```ruby
|
|
1204
1204
|
KlaviyoAPI::Catalogs.get_bulk_create_categories_job(job_id, opts)
|
|
@@ -1216,7 +1216,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_job(job_id, opts)
|
|
|
1216
1216
|
|
|
1217
1217
|
|
|
1218
1218
|
|
|
1219
|
-
#### [Get Bulk Create Categories Jobs](https://developers.klaviyo.com/en/
|
|
1219
|
+
#### [Get Bulk Create Categories Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_create_categories_jobs)
|
|
1220
1220
|
|
|
1221
1221
|
```ruby
|
|
1222
1222
|
KlaviyoAPI::Catalogs.get_bulk_create_categories_jobs(opts)
|
|
@@ -1234,7 +1234,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_jobs(opts)
|
|
|
1234
1234
|
|
|
1235
1235
|
|
|
1236
1236
|
|
|
1237
|
-
#### [Get Bulk Create Variants Job](https://developers.klaviyo.com/en/
|
|
1237
|
+
#### [Get Bulk Create Variants Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_create_variants_job)
|
|
1238
1238
|
|
|
1239
1239
|
```ruby
|
|
1240
1240
|
KlaviyoAPI::Catalogs.get_bulk_create_variants_job(job_id, opts)
|
|
@@ -1252,7 +1252,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_job(job_id, opts)
|
|
|
1252
1252
|
|
|
1253
1253
|
|
|
1254
1254
|
|
|
1255
|
-
#### [Get Bulk Create Variants Jobs](https://developers.klaviyo.com/en/
|
|
1255
|
+
#### [Get Bulk Create Variants Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_create_variants_jobs)
|
|
1256
1256
|
|
|
1257
1257
|
```ruby
|
|
1258
1258
|
KlaviyoAPI::Catalogs.get_bulk_create_variants_jobs(opts)
|
|
@@ -1270,7 +1270,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_jobs(opts)
|
|
|
1270
1270
|
|
|
1271
1271
|
|
|
1272
1272
|
|
|
1273
|
-
#### [Get Bulk Delete Catalog Items Job](https://developers.klaviyo.com/en/
|
|
1273
|
+
#### [Get Bulk Delete Catalog Items Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_delete_catalog_items_job)
|
|
1274
1274
|
|
|
1275
1275
|
```ruby
|
|
1276
1276
|
KlaviyoAPI::Catalogs.get_bulk_delete_catalog_items_job(job_id, opts)
|
|
@@ -1288,7 +1288,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_job(job_id, opts)
|
|
|
1288
1288
|
|
|
1289
1289
|
|
|
1290
1290
|
|
|
1291
|
-
#### [Get Bulk Delete Catalog Items Jobs](https://developers.klaviyo.com/en/
|
|
1291
|
+
#### [Get Bulk Delete Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_delete_catalog_items_jobs)
|
|
1292
1292
|
|
|
1293
1293
|
```ruby
|
|
1294
1294
|
KlaviyoAPI::Catalogs.get_bulk_delete_catalog_items_jobs(opts)
|
|
@@ -1306,7 +1306,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_jobs(opts)
|
|
|
1306
1306
|
|
|
1307
1307
|
|
|
1308
1308
|
|
|
1309
|
-
#### [Get Bulk Delete Categories Job](https://developers.klaviyo.com/en/
|
|
1309
|
+
#### [Get Bulk Delete Categories Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_delete_categories_job)
|
|
1310
1310
|
|
|
1311
1311
|
```ruby
|
|
1312
1312
|
KlaviyoAPI::Catalogs.get_bulk_delete_categories_job(job_id, opts)
|
|
@@ -1324,7 +1324,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_job(job_id, opts)
|
|
|
1324
1324
|
|
|
1325
1325
|
|
|
1326
1326
|
|
|
1327
|
-
#### [Get Bulk Delete Categories Jobs](https://developers.klaviyo.com/en/
|
|
1327
|
+
#### [Get Bulk Delete Categories Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_delete_categories_jobs)
|
|
1328
1328
|
|
|
1329
1329
|
```ruby
|
|
1330
1330
|
KlaviyoAPI::Catalogs.get_bulk_delete_categories_jobs(opts)
|
|
@@ -1342,7 +1342,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_jobs(opts)
|
|
|
1342
1342
|
|
|
1343
1343
|
|
|
1344
1344
|
|
|
1345
|
-
#### [Get Bulk Delete Variants Job](https://developers.klaviyo.com/en/
|
|
1345
|
+
#### [Get Bulk Delete Variants Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_delete_variants_job)
|
|
1346
1346
|
|
|
1347
1347
|
```ruby
|
|
1348
1348
|
KlaviyoAPI::Catalogs.get_bulk_delete_variants_job(job_id, opts)
|
|
@@ -1360,7 +1360,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_job(job_id, opts)
|
|
|
1360
1360
|
|
|
1361
1361
|
|
|
1362
1362
|
|
|
1363
|
-
#### [Get Bulk Delete Variants Jobs](https://developers.klaviyo.com/en/
|
|
1363
|
+
#### [Get Bulk Delete Variants Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_delete_variants_jobs)
|
|
1364
1364
|
|
|
1365
1365
|
```ruby
|
|
1366
1366
|
KlaviyoAPI::Catalogs.get_bulk_delete_variants_jobs(opts)
|
|
@@ -1378,7 +1378,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_jobs(opts)
|
|
|
1378
1378
|
|
|
1379
1379
|
|
|
1380
1380
|
|
|
1381
|
-
#### [Get Bulk Update Catalog Items Job](https://developers.klaviyo.com/en/
|
|
1381
|
+
#### [Get Bulk Update Catalog Items Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_update_catalog_items_job)
|
|
1382
1382
|
|
|
1383
1383
|
```ruby
|
|
1384
1384
|
KlaviyoAPI::Catalogs.get_bulk_update_catalog_items_job(job_id, opts)
|
|
@@ -1396,7 +1396,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_job(job_id, opts)
|
|
|
1396
1396
|
|
|
1397
1397
|
|
|
1398
1398
|
|
|
1399
|
-
#### [Get Bulk Update Catalog Items Jobs](https://developers.klaviyo.com/en/
|
|
1399
|
+
#### [Get Bulk Update Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_update_catalog_items_jobs)
|
|
1400
1400
|
|
|
1401
1401
|
```ruby
|
|
1402
1402
|
KlaviyoAPI::Catalogs.get_bulk_update_catalog_items_jobs(opts)
|
|
@@ -1414,7 +1414,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_jobs(opts)
|
|
|
1414
1414
|
|
|
1415
1415
|
|
|
1416
1416
|
|
|
1417
|
-
#### [Get Bulk Update Categories Job](https://developers.klaviyo.com/en/
|
|
1417
|
+
#### [Get Bulk Update Categories Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_update_categories_job)
|
|
1418
1418
|
|
|
1419
1419
|
```ruby
|
|
1420
1420
|
KlaviyoAPI::Catalogs.get_bulk_update_categories_job(job_id, opts)
|
|
@@ -1432,7 +1432,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_job(job_id, opts)
|
|
|
1432
1432
|
|
|
1433
1433
|
|
|
1434
1434
|
|
|
1435
|
-
#### [Get Bulk Update Categories Jobs](https://developers.klaviyo.com/en/
|
|
1435
|
+
#### [Get Bulk Update Categories Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_update_categories_jobs)
|
|
1436
1436
|
|
|
1437
1437
|
```ruby
|
|
1438
1438
|
KlaviyoAPI::Catalogs.get_bulk_update_categories_jobs(opts)
|
|
@@ -1450,7 +1450,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_jobs(opts)
|
|
|
1450
1450
|
|
|
1451
1451
|
|
|
1452
1452
|
|
|
1453
|
-
#### [Get Bulk Update Variants Job](https://developers.klaviyo.com/en/
|
|
1453
|
+
#### [Get Bulk Update Variants Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_update_variants_job)
|
|
1454
1454
|
|
|
1455
1455
|
```ruby
|
|
1456
1456
|
KlaviyoAPI::Catalogs.get_bulk_update_variants_job(job_id, opts)
|
|
@@ -1468,7 +1468,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_job(job_id, opts)
|
|
|
1468
1468
|
|
|
1469
1469
|
|
|
1470
1470
|
|
|
1471
|
-
#### [Get Bulk Update Variants Jobs](https://developers.klaviyo.com/en/
|
|
1471
|
+
#### [Get Bulk Update Variants Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_update_variants_jobs)
|
|
1472
1472
|
|
|
1473
1473
|
```ruby
|
|
1474
1474
|
KlaviyoAPI::Catalogs.get_bulk_update_variants_jobs(opts)
|
|
@@ -1486,7 +1486,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_jobs(opts)
|
|
|
1486
1486
|
|
|
1487
1487
|
|
|
1488
1488
|
|
|
1489
|
-
#### [Get Catalog Categories](https://developers.klaviyo.com/en/
|
|
1489
|
+
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2026-01-15/reference/get_catalog_categories)
|
|
1490
1490
|
|
|
1491
1491
|
```ruby
|
|
1492
1492
|
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
|
@@ -1496,7 +1496,7 @@ KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
|
|
1496
1496
|
|
|
1497
1497
|
|
|
1498
1498
|
|
|
1499
|
-
#### [Get Catalog Category](https://developers.klaviyo.com/en/
|
|
1499
|
+
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2026-01-15/reference/get_catalog_category)
|
|
1500
1500
|
|
|
1501
1501
|
```ruby
|
|
1502
1502
|
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
|
@@ -1506,7 +1506,7 @@ KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
|
|
1506
1506
|
|
|
1507
1507
|
|
|
1508
1508
|
|
|
1509
|
-
#### [Get Catalog Item](https://developers.klaviyo.com/en/
|
|
1509
|
+
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2026-01-15/reference/get_catalog_item)
|
|
1510
1510
|
|
|
1511
1511
|
```ruby
|
|
1512
1512
|
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
|
@@ -1516,7 +1516,7 @@ KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
|
|
1516
1516
|
|
|
1517
1517
|
|
|
1518
1518
|
|
|
1519
|
-
#### [Get Catalog Items](https://developers.klaviyo.com/en/
|
|
1519
|
+
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2026-01-15/reference/get_catalog_items)
|
|
1520
1520
|
|
|
1521
1521
|
```ruby
|
|
1522
1522
|
KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
|
@@ -1526,7 +1526,7 @@ KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
|
|
1526
1526
|
|
|
1527
1527
|
|
|
1528
1528
|
|
|
1529
|
-
#### [Get Catalog Variant](https://developers.klaviyo.com/en/
|
|
1529
|
+
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2026-01-15/reference/get_catalog_variant)
|
|
1530
1530
|
|
|
1531
1531
|
```ruby
|
|
1532
1532
|
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
|
@@ -1536,7 +1536,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
|
|
1536
1536
|
|
|
1537
1537
|
|
|
1538
1538
|
|
|
1539
|
-
#### [Get Catalog Variants](https://developers.klaviyo.com/en/
|
|
1539
|
+
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2026-01-15/reference/get_catalog_variants)
|
|
1540
1540
|
|
|
1541
1541
|
```ruby
|
|
1542
1542
|
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
|
@@ -1546,7 +1546,7 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
|
|
1546
1546
|
|
|
1547
1547
|
|
|
1548
1548
|
|
|
1549
|
-
#### [Get Categories for Catalog Item](https://developers.klaviyo.com/en/
|
|
1549
|
+
#### [Get Categories for Catalog Item](https://developers.klaviyo.com/en/v2026-01-15/reference/get_categories_for_catalog_item)
|
|
1550
1550
|
|
|
1551
1551
|
```ruby
|
|
1552
1552
|
KlaviyoAPI::Catalogs.get_categories_for_catalog_item(id, opts)
|
|
@@ -1560,7 +1560,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts)
|
|
|
1560
1560
|
|
|
1561
1561
|
|
|
1562
1562
|
|
|
1563
|
-
#### [Get Category IDs for Catalog Item](https://developers.klaviyo.com/en/
|
|
1563
|
+
#### [Get Category IDs for Catalog Item](https://developers.klaviyo.com/en/v2026-01-15/reference/get_category_ids_for_catalog_item)
|
|
1564
1564
|
|
|
1565
1565
|
```ruby
|
|
1566
1566
|
KlaviyoAPI::Catalogs.get_category_ids_for_catalog_item(id, opts)
|
|
@@ -1574,7 +1574,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
|
|
|
1574
1574
|
|
|
1575
1575
|
|
|
1576
1576
|
|
|
1577
|
-
#### [Get Item IDs for Catalog Category](https://developers.klaviyo.com/en/
|
|
1577
|
+
#### [Get Item IDs for Catalog Category](https://developers.klaviyo.com/en/v2026-01-15/reference/get_item_ids_for_catalog_category)
|
|
1578
1578
|
|
|
1579
1579
|
```ruby
|
|
1580
1580
|
KlaviyoAPI::Catalogs.get_item_ids_for_catalog_category(id, opts)
|
|
@@ -1588,7 +1588,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
|
|
|
1588
1588
|
|
|
1589
1589
|
|
|
1590
1590
|
|
|
1591
|
-
#### [Get Items for Catalog Category](https://developers.klaviyo.com/en/
|
|
1591
|
+
#### [Get Items for Catalog Category](https://developers.klaviyo.com/en/v2026-01-15/reference/get_items_for_catalog_category)
|
|
1592
1592
|
|
|
1593
1593
|
```ruby
|
|
1594
1594
|
KlaviyoAPI::Catalogs.get_items_for_catalog_category(id, opts)
|
|
@@ -1602,7 +1602,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts)
|
|
|
1602
1602
|
|
|
1603
1603
|
|
|
1604
1604
|
|
|
1605
|
-
#### [Get Variant IDs for Catalog Item](https://developers.klaviyo.com/en/
|
|
1605
|
+
#### [Get Variant IDs for Catalog Item](https://developers.klaviyo.com/en/v2026-01-15/reference/get_variant_ids_for_catalog_item)
|
|
1606
1606
|
|
|
1607
1607
|
```ruby
|
|
1608
1608
|
KlaviyoAPI::Catalogs.get_variant_ids_for_catalog_item(id, opts)
|
|
@@ -1616,7 +1616,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships_variants(id, opts)
|
|
|
1616
1616
|
|
|
1617
1617
|
|
|
1618
1618
|
|
|
1619
|
-
#### [Get Variants for Catalog Item](https://developers.klaviyo.com/en/
|
|
1619
|
+
#### [Get Variants for Catalog Item](https://developers.klaviyo.com/en/v2026-01-15/reference/get_variants_for_catalog_item)
|
|
1620
1620
|
|
|
1621
1621
|
```ruby
|
|
1622
1622
|
KlaviyoAPI::Catalogs.get_variants_for_catalog_item(id, opts)
|
|
@@ -1630,7 +1630,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts)
|
|
|
1630
1630
|
|
|
1631
1631
|
|
|
1632
1632
|
|
|
1633
|
-
#### [Remove Categories from Catalog Item](https://developers.klaviyo.com/en/
|
|
1633
|
+
#### [Remove Categories from Catalog Item](https://developers.klaviyo.com/en/v2026-01-15/reference/remove_categories_from_catalog_item)
|
|
1634
1634
|
|
|
1635
1635
|
```ruby
|
|
1636
1636
|
KlaviyoAPI::Catalogs.remove_categories_from_catalog_item(id, body)
|
|
@@ -1644,7 +1644,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
|
|
|
1644
1644
|
|
|
1645
1645
|
|
|
1646
1646
|
|
|
1647
|
-
#### [Remove Items from Catalog Category](https://developers.klaviyo.com/en/
|
|
1647
|
+
#### [Remove Items from Catalog Category](https://developers.klaviyo.com/en/v2026-01-15/reference/remove_items_from_catalog_category)
|
|
1648
1648
|
|
|
1649
1649
|
```ruby
|
|
1650
1650
|
KlaviyoAPI::Catalogs.remove_items_from_catalog_category(id, body)
|
|
@@ -1658,7 +1658,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
|
|
|
1658
1658
|
|
|
1659
1659
|
|
|
1660
1660
|
|
|
1661
|
-
#### [Update Catalog Category](https://developers.klaviyo.com/en/
|
|
1661
|
+
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2026-01-15/reference/update_catalog_category)
|
|
1662
1662
|
|
|
1663
1663
|
```ruby
|
|
1664
1664
|
KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
|
@@ -1668,7 +1668,7 @@ KlaviyoAPI::Catalogs.update_catalog_category(id, body)
|
|
|
1668
1668
|
|
|
1669
1669
|
|
|
1670
1670
|
|
|
1671
|
-
#### [Update Catalog Item](https://developers.klaviyo.com/en/
|
|
1671
|
+
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2026-01-15/reference/update_catalog_item)
|
|
1672
1672
|
|
|
1673
1673
|
```ruby
|
|
1674
1674
|
KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
|
@@ -1678,7 +1678,7 @@ KlaviyoAPI::Catalogs.update_catalog_item(id, body)
|
|
|
1678
1678
|
|
|
1679
1679
|
|
|
1680
1680
|
|
|
1681
|
-
#### [Update Catalog Variant](https://developers.klaviyo.com/en/
|
|
1681
|
+
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2026-01-15/reference/update_catalog_variant)
|
|
1682
1682
|
|
|
1683
1683
|
```ruby
|
|
1684
1684
|
KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
|
@@ -1688,7 +1688,7 @@ KlaviyoAPI::Catalogs.update_catalog_variant(id, body)
|
|
|
1688
1688
|
|
|
1689
1689
|
|
|
1690
1690
|
|
|
1691
|
-
#### [Update Categories for Catalog Item](https://developers.klaviyo.com/en/
|
|
1691
|
+
#### [Update Categories for Catalog Item](https://developers.klaviyo.com/en/v2026-01-15/reference/update_categories_for_catalog_item)
|
|
1692
1692
|
|
|
1693
1693
|
```ruby
|
|
1694
1694
|
KlaviyoAPI::Catalogs.update_categories_for_catalog_item(id, body)
|
|
@@ -1702,7 +1702,7 @@ KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
|
|
|
1702
1702
|
|
|
1703
1703
|
|
|
1704
1704
|
|
|
1705
|
-
#### [Update Items for Catalog Category](https://developers.klaviyo.com/en/
|
|
1705
|
+
#### [Update Items for Catalog Category](https://developers.klaviyo.com/en/v2026-01-15/reference/update_items_for_catalog_category)
|
|
1706
1706
|
|
|
1707
1707
|
```ruby
|
|
1708
1708
|
KlaviyoAPI::Catalogs.update_items_for_catalog_category(id, body)
|
|
@@ -1720,7 +1720,7 @@ KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
|
|
|
1720
1720
|
## Coupons
|
|
1721
1721
|
|
|
1722
1722
|
|
|
1723
|
-
#### [Bulk Create Coupon Codes](https://developers.klaviyo.com/en/
|
|
1723
|
+
#### [Bulk Create Coupon Codes](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_create_coupon_codes)
|
|
1724
1724
|
|
|
1725
1725
|
```ruby
|
|
1726
1726
|
KlaviyoAPI::Coupons.bulk_create_coupon_codes(body)
|
|
@@ -1738,7 +1738,7 @@ KlaviyoAPI::Coupons.create_coupon_code_bulk_create_job(body)
|
|
|
1738
1738
|
|
|
1739
1739
|
|
|
1740
1740
|
|
|
1741
|
-
#### [Create Coupon](https://developers.klaviyo.com/en/
|
|
1741
|
+
#### [Create Coupon](https://developers.klaviyo.com/en/v2026-01-15/reference/create_coupon)
|
|
1742
1742
|
|
|
1743
1743
|
```ruby
|
|
1744
1744
|
KlaviyoAPI::Coupons.create_coupon(body)
|
|
@@ -1748,7 +1748,7 @@ KlaviyoAPI::Coupons.create_coupon(body)
|
|
|
1748
1748
|
|
|
1749
1749
|
|
|
1750
1750
|
|
|
1751
|
-
#### [Create Coupon Code](https://developers.klaviyo.com/en/
|
|
1751
|
+
#### [Create Coupon Code](https://developers.klaviyo.com/en/v2026-01-15/reference/create_coupon_code)
|
|
1752
1752
|
|
|
1753
1753
|
```ruby
|
|
1754
1754
|
KlaviyoAPI::Coupons.create_coupon_code(body)
|
|
@@ -1758,7 +1758,7 @@ KlaviyoAPI::Coupons.create_coupon_code(body)
|
|
|
1758
1758
|
|
|
1759
1759
|
|
|
1760
1760
|
|
|
1761
|
-
#### [Delete Coupon](https://developers.klaviyo.com/en/
|
|
1761
|
+
#### [Delete Coupon](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_coupon)
|
|
1762
1762
|
|
|
1763
1763
|
```ruby
|
|
1764
1764
|
KlaviyoAPI::Coupons.delete_coupon(id)
|
|
@@ -1768,7 +1768,7 @@ KlaviyoAPI::Coupons.delete_coupon(id)
|
|
|
1768
1768
|
|
|
1769
1769
|
|
|
1770
1770
|
|
|
1771
|
-
#### [Delete Coupon Code](https://developers.klaviyo.com/en/
|
|
1771
|
+
#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_coupon_code)
|
|
1772
1772
|
|
|
1773
1773
|
```ruby
|
|
1774
1774
|
KlaviyoAPI::Coupons.delete_coupon_code(id)
|
|
@@ -1778,7 +1778,7 @@ KlaviyoAPI::Coupons.delete_coupon_code(id)
|
|
|
1778
1778
|
|
|
1779
1779
|
|
|
1780
1780
|
|
|
1781
|
-
#### [Get Bulk Create Coupon Code Jobs](https://developers.klaviyo.com/en/
|
|
1781
|
+
#### [Get Bulk Create Coupon Code Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_create_coupon_code_jobs)
|
|
1782
1782
|
|
|
1783
1783
|
```ruby
|
|
1784
1784
|
KlaviyoAPI::Coupons.get_bulk_create_coupon_code_jobs(opts)
|
|
@@ -1792,7 +1792,7 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_jobs(opts)
|
|
|
1792
1792
|
|
|
1793
1793
|
|
|
1794
1794
|
|
|
1795
|
-
#### [Get Bulk Create Coupon Codes Job](https://developers.klaviyo.com/en/
|
|
1795
|
+
#### [Get Bulk Create Coupon Codes Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_create_coupon_codes_job)
|
|
1796
1796
|
|
|
1797
1797
|
```ruby
|
|
1798
1798
|
KlaviyoAPI::Coupons.get_bulk_create_coupon_codes_job(job_id, opts)
|
|
@@ -1806,7 +1806,7 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts)
|
|
|
1806
1806
|
|
|
1807
1807
|
|
|
1808
1808
|
|
|
1809
|
-
#### [Get Coupon](https://developers.klaviyo.com/en/
|
|
1809
|
+
#### [Get Coupon](https://developers.klaviyo.com/en/v2026-01-15/reference/get_coupon)
|
|
1810
1810
|
|
|
1811
1811
|
```ruby
|
|
1812
1812
|
KlaviyoAPI::Coupons.get_coupon(id, opts)
|
|
@@ -1816,7 +1816,7 @@ KlaviyoAPI::Coupons.get_coupon(id, opts)
|
|
|
1816
1816
|
|
|
1817
1817
|
|
|
1818
1818
|
|
|
1819
|
-
#### [Get Coupon Code](https://developers.klaviyo.com/en/
|
|
1819
|
+
#### [Get Coupon Code](https://developers.klaviyo.com/en/v2026-01-15/reference/get_coupon_code)
|
|
1820
1820
|
|
|
1821
1821
|
```ruby
|
|
1822
1822
|
KlaviyoAPI::Coupons.get_coupon_code(id, opts)
|
|
@@ -1826,7 +1826,7 @@ KlaviyoAPI::Coupons.get_coupon_code(id, opts)
|
|
|
1826
1826
|
|
|
1827
1827
|
|
|
1828
1828
|
|
|
1829
|
-
#### [Get Coupon Code IDs for Coupon](https://developers.klaviyo.com/en/
|
|
1829
|
+
#### [Get Coupon Code IDs for Coupon](https://developers.klaviyo.com/en/v2026-01-15/reference/get_coupon_code_ids_for_coupon)
|
|
1830
1830
|
|
|
1831
1831
|
```ruby
|
|
1832
1832
|
KlaviyoAPI::Coupons.get_coupon_code_ids_for_coupon(id, opts)
|
|
@@ -1848,7 +1848,7 @@ KlaviyoAPI::Coupons.get_coupon_relationships_codes(id, opts)
|
|
|
1848
1848
|
|
|
1849
1849
|
|
|
1850
1850
|
|
|
1851
|
-
#### [Get Coupon Codes](https://developers.klaviyo.com/en/
|
|
1851
|
+
#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2026-01-15/reference/get_coupon_codes)
|
|
1852
1852
|
|
|
1853
1853
|
```ruby
|
|
1854
1854
|
KlaviyoAPI::Coupons.get_coupon_codes(filter, opts)
|
|
@@ -1858,7 +1858,7 @@ KlaviyoAPI::Coupons.get_coupon_codes(filter, opts)
|
|
|
1858
1858
|
|
|
1859
1859
|
|
|
1860
1860
|
|
|
1861
|
-
#### [Get Coupon Codes for Coupon](https://developers.klaviyo.com/en/
|
|
1861
|
+
#### [Get Coupon Codes for Coupon](https://developers.klaviyo.com/en/v2026-01-15/reference/get_coupon_codes_for_coupon)
|
|
1862
1862
|
|
|
1863
1863
|
```ruby
|
|
1864
1864
|
KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
|
|
@@ -1876,7 +1876,7 @@ KlaviyoAPI::Coupons.get_codes_for_coupon(id, opts)
|
|
|
1876
1876
|
|
|
1877
1877
|
|
|
1878
1878
|
|
|
1879
|
-
#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/
|
|
1879
|
+
#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2026-01-15/reference/get_coupon_for_coupon_code)
|
|
1880
1880
|
|
|
1881
1881
|
```ruby
|
|
1882
1882
|
KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts)
|
|
@@ -1890,7 +1890,7 @@ KlaviyoAPI::Coupons.get_coupon_code_coupon(id, opts)
|
|
|
1890
1890
|
|
|
1891
1891
|
|
|
1892
1892
|
|
|
1893
|
-
#### [Get Coupon ID for Coupon Code](https://developers.klaviyo.com/en/
|
|
1893
|
+
#### [Get Coupon ID for Coupon Code](https://developers.klaviyo.com/en/v2026-01-15/reference/get_coupon_id_for_coupon_code)
|
|
1894
1894
|
|
|
1895
1895
|
```ruby
|
|
1896
1896
|
KlaviyoAPI::Coupons.get_coupon_id_for_coupon_code(id)
|
|
@@ -1904,7 +1904,7 @@ KlaviyoAPI::Coupons.get_coupon_relationships_coupon_codes(id)
|
|
|
1904
1904
|
|
|
1905
1905
|
|
|
1906
1906
|
|
|
1907
|
-
#### [Get Coupons](https://developers.klaviyo.com/en/
|
|
1907
|
+
#### [Get Coupons](https://developers.klaviyo.com/en/v2026-01-15/reference/get_coupons)
|
|
1908
1908
|
|
|
1909
1909
|
```ruby
|
|
1910
1910
|
KlaviyoAPI::Coupons.get_coupons(opts)
|
|
@@ -1914,7 +1914,7 @@ KlaviyoAPI::Coupons.get_coupons(opts)
|
|
|
1914
1914
|
|
|
1915
1915
|
|
|
1916
1916
|
|
|
1917
|
-
#### [Update Coupon](https://developers.klaviyo.com/en/
|
|
1917
|
+
#### [Update Coupon](https://developers.klaviyo.com/en/v2026-01-15/reference/update_coupon)
|
|
1918
1918
|
|
|
1919
1919
|
```ruby
|
|
1920
1920
|
KlaviyoAPI::Coupons.update_coupon(id, body)
|
|
@@ -1924,7 +1924,7 @@ KlaviyoAPI::Coupons.update_coupon(id, body)
|
|
|
1924
1924
|
|
|
1925
1925
|
|
|
1926
1926
|
|
|
1927
|
-
#### [Update Coupon Code](https://developers.klaviyo.com/en/
|
|
1927
|
+
#### [Update Coupon Code](https://developers.klaviyo.com/en/v2026-01-15/reference/update_coupon_code)
|
|
1928
1928
|
|
|
1929
1929
|
```ruby
|
|
1930
1930
|
KlaviyoAPI::Coupons.update_coupon_code(id, body)
|
|
@@ -1938,7 +1938,7 @@ KlaviyoAPI::Coupons.update_coupon_code(id, body)
|
|
|
1938
1938
|
## Custom Objects
|
|
1939
1939
|
|
|
1940
1940
|
|
|
1941
|
-
#### [Bulk Create Data Source Records](https://developers.klaviyo.com/en/
|
|
1941
|
+
#### [Bulk Create Data Source Records](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_create_data_source_records)
|
|
1942
1942
|
|
|
1943
1943
|
```ruby
|
|
1944
1944
|
KlaviyoAPI::CustomObjects.bulk_create_data_source_records(body)
|
|
@@ -1952,7 +1952,7 @@ KlaviyoAPI::CustomObjects.create_data_source_record_bulk_create_job(body)
|
|
|
1952
1952
|
|
|
1953
1953
|
|
|
1954
1954
|
|
|
1955
|
-
#### [Create Data Source](https://developers.klaviyo.com/en/
|
|
1955
|
+
#### [Create Data Source](https://developers.klaviyo.com/en/v2026-01-15/reference/create_data_source)
|
|
1956
1956
|
|
|
1957
1957
|
```ruby
|
|
1958
1958
|
KlaviyoAPI::CustomObjects.create_data_source(body)
|
|
@@ -1962,7 +1962,21 @@ KlaviyoAPI::CustomObjects.create_data_source(body)
|
|
|
1962
1962
|
|
|
1963
1963
|
|
|
1964
1964
|
|
|
1965
|
-
#### [
|
|
1965
|
+
#### [Create Data Source Record](https://developers.klaviyo.com/en/v2026-01-15/reference/create_data_source_record)
|
|
1966
|
+
|
|
1967
|
+
```ruby
|
|
1968
|
+
KlaviyoAPI::CustomObjects.create_data_source_record(body)
|
|
1969
|
+
```
|
|
1970
|
+
##### Method alias:
|
|
1971
|
+
```ruby
|
|
1972
|
+
KlaviyoAPI::CustomObjects.create_data_source_record_create_job(body)
|
|
1973
|
+
```
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
|
|
1977
|
+
|
|
1978
|
+
|
|
1979
|
+
#### [Delete Data Source](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_data_source)
|
|
1966
1980
|
|
|
1967
1981
|
```ruby
|
|
1968
1982
|
KlaviyoAPI::CustomObjects.delete_data_source(id)
|
|
@@ -1972,7 +1986,7 @@ KlaviyoAPI::CustomObjects.delete_data_source(id)
|
|
|
1972
1986
|
|
|
1973
1987
|
|
|
1974
1988
|
|
|
1975
|
-
#### [Get Data Source](https://developers.klaviyo.com/en/
|
|
1989
|
+
#### [Get Data Source](https://developers.klaviyo.com/en/v2026-01-15/reference/get_data_source)
|
|
1976
1990
|
|
|
1977
1991
|
```ruby
|
|
1978
1992
|
KlaviyoAPI::CustomObjects.get_data_source(id, opts)
|
|
@@ -1982,7 +1996,7 @@ KlaviyoAPI::CustomObjects.get_data_source(id, opts)
|
|
|
1982
1996
|
|
|
1983
1997
|
|
|
1984
1998
|
|
|
1985
|
-
#### [Get Data Sources](https://developers.klaviyo.com/en/
|
|
1999
|
+
#### [Get Data Sources](https://developers.klaviyo.com/en/v2026-01-15/reference/get_data_sources)
|
|
1986
2000
|
|
|
1987
2001
|
```ruby
|
|
1988
2002
|
KlaviyoAPI::CustomObjects.get_data_sources(opts)
|
|
@@ -1996,7 +2010,7 @@ KlaviyoAPI::CustomObjects.get_data_sources(opts)
|
|
|
1996
2010
|
## Data Privacy
|
|
1997
2011
|
|
|
1998
2012
|
|
|
1999
|
-
#### [Request Profile Deletion](https://developers.klaviyo.com/en/
|
|
2013
|
+
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2026-01-15/reference/request_profile_deletion)
|
|
2000
2014
|
|
|
2001
2015
|
```ruby
|
|
2002
2016
|
KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
|
|
@@ -2014,7 +2028,7 @@ KlaviyoAPI::DataPrivacy.create_data_privacy_deletion_job(body)
|
|
|
2014
2028
|
## Events
|
|
2015
2029
|
|
|
2016
2030
|
|
|
2017
|
-
#### [Bulk Create Events](https://developers.klaviyo.com/en/
|
|
2031
|
+
#### [Bulk Create Events](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_create_events)
|
|
2018
2032
|
|
|
2019
2033
|
```ruby
|
|
2020
2034
|
KlaviyoAPI::Events.bulk_create_events(body)
|
|
@@ -2028,7 +2042,7 @@ KlaviyoAPI::Events.create_event_bulk_create_job(body)
|
|
|
2028
2042
|
|
|
2029
2043
|
|
|
2030
2044
|
|
|
2031
|
-
#### [Create Event](https://developers.klaviyo.com/en/
|
|
2045
|
+
#### [Create Event](https://developers.klaviyo.com/en/v2026-01-15/reference/create_event)
|
|
2032
2046
|
|
|
2033
2047
|
```ruby
|
|
2034
2048
|
KlaviyoAPI::Events.create_event(body)
|
|
@@ -2038,7 +2052,7 @@ KlaviyoAPI::Events.create_event(body)
|
|
|
2038
2052
|
|
|
2039
2053
|
|
|
2040
2054
|
|
|
2041
|
-
#### [Get Event](https://developers.klaviyo.com/en/
|
|
2055
|
+
#### [Get Event](https://developers.klaviyo.com/en/v2026-01-15/reference/get_event)
|
|
2042
2056
|
|
|
2043
2057
|
```ruby
|
|
2044
2058
|
KlaviyoAPI::Events.get_event(id, opts)
|
|
@@ -2048,7 +2062,7 @@ KlaviyoAPI::Events.get_event(id, opts)
|
|
|
2048
2062
|
|
|
2049
2063
|
|
|
2050
2064
|
|
|
2051
|
-
#### [Get Events](https://developers.klaviyo.com/en/
|
|
2065
|
+
#### [Get Events](https://developers.klaviyo.com/en/v2026-01-15/reference/get_events)
|
|
2052
2066
|
|
|
2053
2067
|
```ruby
|
|
2054
2068
|
KlaviyoAPI::Events.get_events(opts)
|
|
@@ -2058,7 +2072,7 @@ KlaviyoAPI::Events.get_events(opts)
|
|
|
2058
2072
|
|
|
2059
2073
|
|
|
2060
2074
|
|
|
2061
|
-
#### [Get Metric for Event](https://developers.klaviyo.com/en/
|
|
2075
|
+
#### [Get Metric for Event](https://developers.klaviyo.com/en/v2026-01-15/reference/get_metric_for_event)
|
|
2062
2076
|
|
|
2063
2077
|
```ruby
|
|
2064
2078
|
KlaviyoAPI::Events.get_metric_for_event(id, opts)
|
|
@@ -2072,7 +2086,7 @@ KlaviyoAPI::Events.get_event_metric(id, opts)
|
|
|
2072
2086
|
|
|
2073
2087
|
|
|
2074
2088
|
|
|
2075
|
-
#### [Get Metric ID for Event](https://developers.klaviyo.com/en/
|
|
2089
|
+
#### [Get Metric ID for Event](https://developers.klaviyo.com/en/v2026-01-15/reference/get_metric_id_for_event)
|
|
2076
2090
|
|
|
2077
2091
|
```ruby
|
|
2078
2092
|
KlaviyoAPI::Events.get_metric_id_for_event(id)
|
|
@@ -2086,7 +2100,7 @@ KlaviyoAPI::Events.get_event_relationships_metric(id)
|
|
|
2086
2100
|
|
|
2087
2101
|
|
|
2088
2102
|
|
|
2089
|
-
#### [Get Profile for Event](https://developers.klaviyo.com/en/
|
|
2103
|
+
#### [Get Profile for Event](https://developers.klaviyo.com/en/v2026-01-15/reference/get_profile_for_event)
|
|
2090
2104
|
|
|
2091
2105
|
```ruby
|
|
2092
2106
|
KlaviyoAPI::Events.get_profile_for_event(id, opts)
|
|
@@ -2100,7 +2114,7 @@ KlaviyoAPI::Events.get_event_profile(id, opts)
|
|
|
2100
2114
|
|
|
2101
2115
|
|
|
2102
2116
|
|
|
2103
|
-
#### [Get Profile ID for Event](https://developers.klaviyo.com/en/
|
|
2117
|
+
#### [Get Profile ID for Event](https://developers.klaviyo.com/en/v2026-01-15/reference/get_profile_id_for_event)
|
|
2104
2118
|
|
|
2105
2119
|
```ruby
|
|
2106
2120
|
KlaviyoAPI::Events.get_profile_id_for_event(id)
|
|
@@ -2118,7 +2132,7 @@ KlaviyoAPI::Events.get_event_relationships_profile(id)
|
|
|
2118
2132
|
## Flows
|
|
2119
2133
|
|
|
2120
2134
|
|
|
2121
|
-
#### [Create Flow](https://developers.klaviyo.com/en/
|
|
2135
|
+
#### [Create Flow](https://developers.klaviyo.com/en/v2026-01-15/reference/create_flow)
|
|
2122
2136
|
|
|
2123
2137
|
```ruby
|
|
2124
2138
|
KlaviyoAPI::Flows.create_flow(body, opts)
|
|
@@ -2128,7 +2142,7 @@ KlaviyoAPI::Flows.create_flow(body, opts)
|
|
|
2128
2142
|
|
|
2129
2143
|
|
|
2130
2144
|
|
|
2131
|
-
#### [Delete Flow](https://developers.klaviyo.com/en/
|
|
2145
|
+
#### [Delete Flow](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_flow)
|
|
2132
2146
|
|
|
2133
2147
|
```ruby
|
|
2134
2148
|
KlaviyoAPI::Flows.delete_flow(id)
|
|
@@ -2138,7 +2152,7 @@ KlaviyoAPI::Flows.delete_flow(id)
|
|
|
2138
2152
|
|
|
2139
2153
|
|
|
2140
2154
|
|
|
2141
|
-
#### [Get Action for Flow Message](https://developers.klaviyo.com/en/
|
|
2155
|
+
#### [Get Action for Flow Message](https://developers.klaviyo.com/en/v2026-01-15/reference/get_action_for_flow_message)
|
|
2142
2156
|
|
|
2143
2157
|
```ruby
|
|
2144
2158
|
KlaviyoAPI::Flows.get_action_for_flow_message(id, opts)
|
|
@@ -2152,7 +2166,7 @@ KlaviyoAPI::Flows.get_flow_message_action(id, opts)
|
|
|
2152
2166
|
|
|
2153
2167
|
|
|
2154
2168
|
|
|
2155
|
-
#### [Get Action ID for Flow Message](https://developers.klaviyo.com/en/
|
|
2169
|
+
#### [Get Action ID for Flow Message](https://developers.klaviyo.com/en/v2026-01-15/reference/get_action_id_for_flow_message)
|
|
2156
2170
|
|
|
2157
2171
|
```ruby
|
|
2158
2172
|
KlaviyoAPI::Flows.get_action_id_for_flow_message(id)
|
|
@@ -2166,7 +2180,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
|
|
|
2166
2180
|
|
|
2167
2181
|
|
|
2168
2182
|
|
|
2169
|
-
#### [Get Action IDs for Flow](https://developers.klaviyo.com/en/
|
|
2183
|
+
#### [Get Action IDs for Flow](https://developers.klaviyo.com/en/v2026-01-15/reference/get_action_ids_for_flow)
|
|
2170
2184
|
|
|
2171
2185
|
```ruby
|
|
2172
2186
|
KlaviyoAPI::Flows.get_action_ids_for_flow(id, opts)
|
|
@@ -2184,7 +2198,7 @@ KlaviyoAPI::Flows.get_flow_relationships_actions(id, opts)
|
|
|
2184
2198
|
|
|
2185
2199
|
|
|
2186
2200
|
|
|
2187
|
-
#### [Get Actions for Flow](https://developers.klaviyo.com/en/
|
|
2201
|
+
#### [Get Actions for Flow](https://developers.klaviyo.com/en/v2026-01-15/reference/get_actions_for_flow)
|
|
2188
2202
|
|
|
2189
2203
|
```ruby
|
|
2190
2204
|
KlaviyoAPI::Flows.get_actions_for_flow(id, opts)
|
|
@@ -2202,7 +2216,7 @@ KlaviyoAPI::Flows.get_flow_actions(id, opts)
|
|
|
2202
2216
|
|
|
2203
2217
|
|
|
2204
2218
|
|
|
2205
|
-
#### [Get Flow](https://developers.klaviyo.com/en/
|
|
2219
|
+
#### [Get Flow](https://developers.klaviyo.com/en/v2026-01-15/reference/get_flow)
|
|
2206
2220
|
|
|
2207
2221
|
```ruby
|
|
2208
2222
|
KlaviyoAPI::Flows.get_flow(id, opts)
|
|
@@ -2212,7 +2226,7 @@ KlaviyoAPI::Flows.get_flow(id, opts)
|
|
|
2212
2226
|
|
|
2213
2227
|
|
|
2214
2228
|
|
|
2215
|
-
#### [Get Flow Action](https://developers.klaviyo.com/en/
|
|
2229
|
+
#### [Get Flow Action](https://developers.klaviyo.com/en/v2026-01-15/reference/get_flow_action)
|
|
2216
2230
|
|
|
2217
2231
|
```ruby
|
|
2218
2232
|
KlaviyoAPI::Flows.get_flow_action(id, opts)
|
|
@@ -2222,7 +2236,7 @@ KlaviyoAPI::Flows.get_flow_action(id, opts)
|
|
|
2222
2236
|
|
|
2223
2237
|
|
|
2224
2238
|
|
|
2225
|
-
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/
|
|
2239
|
+
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2026-01-15/reference/get_flow_action_messages)
|
|
2226
2240
|
|
|
2227
2241
|
```ruby
|
|
2228
2242
|
KlaviyoAPI::Flows.get_flow_action_messages(id, opts)
|
|
@@ -2236,7 +2250,7 @@ KlaviyoAPI::Flows.get_messages_for_flow_action(id, opts)
|
|
|
2236
2250
|
|
|
2237
2251
|
|
|
2238
2252
|
|
|
2239
|
-
#### [Get Flow for Flow Action](https://developers.klaviyo.com/en/
|
|
2253
|
+
#### [Get Flow for Flow Action](https://developers.klaviyo.com/en/v2026-01-15/reference/get_flow_for_flow_action)
|
|
2240
2254
|
|
|
2241
2255
|
```ruby
|
|
2242
2256
|
KlaviyoAPI::Flows.get_flow_for_flow_action(id, opts)
|
|
@@ -2250,7 +2264,7 @@ KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
|
|
|
2250
2264
|
|
|
2251
2265
|
|
|
2252
2266
|
|
|
2253
|
-
#### [Get Flow ID for Flow Action](https://developers.klaviyo.com/en/
|
|
2267
|
+
#### [Get Flow ID for Flow Action](https://developers.klaviyo.com/en/v2026-01-15/reference/get_flow_id_for_flow_action)
|
|
2254
2268
|
|
|
2255
2269
|
```ruby
|
|
2256
2270
|
KlaviyoAPI::Flows.get_flow_id_for_flow_action(id)
|
|
@@ -2264,7 +2278,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
|
|
|
2264
2278
|
|
|
2265
2279
|
|
|
2266
2280
|
|
|
2267
|
-
#### [Get Flow Message](https://developers.klaviyo.com/en/
|
|
2281
|
+
#### [Get Flow Message](https://developers.klaviyo.com/en/v2026-01-15/reference/get_flow_message)
|
|
2268
2282
|
|
|
2269
2283
|
```ruby
|
|
2270
2284
|
KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
@@ -2274,7 +2288,7 @@ KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
|
2274
2288
|
|
|
2275
2289
|
|
|
2276
2290
|
|
|
2277
|
-
#### [Get Flows](https://developers.klaviyo.com/en/
|
|
2291
|
+
#### [Get Flows](https://developers.klaviyo.com/en/v2026-01-15/reference/get_flows)
|
|
2278
2292
|
|
|
2279
2293
|
```ruby
|
|
2280
2294
|
KlaviyoAPI::Flows.get_flows(opts)
|
|
@@ -2284,7 +2298,7 @@ KlaviyoAPI::Flows.get_flows(opts)
|
|
|
2284
2298
|
|
|
2285
2299
|
|
|
2286
2300
|
|
|
2287
|
-
#### [Get Message IDs for Flow Action](https://developers.klaviyo.com/en/
|
|
2301
|
+
#### [Get Message IDs for Flow Action](https://developers.klaviyo.com/en/v2026-01-15/reference/get_message_ids_for_flow_action)
|
|
2288
2302
|
|
|
2289
2303
|
```ruby
|
|
2290
2304
|
KlaviyoAPI::Flows.get_message_ids_for_flow_action(id, opts)
|
|
@@ -2298,7 +2312,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
|
|
|
2298
2312
|
|
|
2299
2313
|
|
|
2300
2314
|
|
|
2301
|
-
#### [Get Tag IDs for Flow](https://developers.klaviyo.com/en/
|
|
2315
|
+
#### [Get Tag IDs for Flow](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tag_ids_for_flow)
|
|
2302
2316
|
|
|
2303
2317
|
```ruby
|
|
2304
2318
|
KlaviyoAPI::Flows.get_tag_ids_for_flow(id)
|
|
@@ -2312,7 +2326,7 @@ KlaviyoAPI::Flows.get_flow_relationships_tags(id)
|
|
|
2312
2326
|
|
|
2313
2327
|
|
|
2314
2328
|
|
|
2315
|
-
#### [Get Tags for Flow](https://developers.klaviyo.com/en/
|
|
2329
|
+
#### [Get Tags for Flow](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tags_for_flow)
|
|
2316
2330
|
|
|
2317
2331
|
```ruby
|
|
2318
2332
|
KlaviyoAPI::Flows.get_tags_for_flow(id, opts)
|
|
@@ -2326,7 +2340,7 @@ KlaviyoAPI::Flows.get_flow_tags(id, opts)
|
|
|
2326
2340
|
|
|
2327
2341
|
|
|
2328
2342
|
|
|
2329
|
-
#### [Get Template for Flow Message](https://developers.klaviyo.com/en/
|
|
2343
|
+
#### [Get Template for Flow Message](https://developers.klaviyo.com/en/v2026-01-15/reference/get_template_for_flow_message)
|
|
2330
2344
|
|
|
2331
2345
|
```ruby
|
|
2332
2346
|
KlaviyoAPI::Flows.get_template_for_flow_message(id, opts)
|
|
@@ -2340,7 +2354,7 @@ KlaviyoAPI::Flows.get_flow_message_template(id, opts)
|
|
|
2340
2354
|
|
|
2341
2355
|
|
|
2342
2356
|
|
|
2343
|
-
#### [Get Template ID for Flow Message](https://developers.klaviyo.com/en/
|
|
2357
|
+
#### [Get Template ID for Flow Message](https://developers.klaviyo.com/en/v2026-01-15/reference/get_template_id_for_flow_message)
|
|
2344
2358
|
|
|
2345
2359
|
```ruby
|
|
2346
2360
|
KlaviyoAPI::Flows.get_template_id_for_flow_message(id)
|
|
@@ -2354,7 +2368,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships_template(id)
|
|
|
2354
2368
|
|
|
2355
2369
|
|
|
2356
2370
|
|
|
2357
|
-
#### [Update Flow Status](https://developers.klaviyo.com/en/
|
|
2371
|
+
#### [Update Flow Status](https://developers.klaviyo.com/en/v2026-01-15/reference/update_flow)
|
|
2358
2372
|
|
|
2359
2373
|
```ruby
|
|
2360
2374
|
KlaviyoAPI::Flows.update_flow(id, body)
|
|
@@ -2364,11 +2378,31 @@ KlaviyoAPI::Flows.update_flow(id, body)
|
|
|
2364
2378
|
|
|
2365
2379
|
|
|
2366
2380
|
|
|
2381
|
+
#### [Update Flow Action](https://developers.klaviyo.com/en/v2026-01-15/reference/update_flow_action)
|
|
2382
|
+
|
|
2383
|
+
```ruby
|
|
2384
|
+
KlaviyoAPI::Flows.update_flow_action(id, body)
|
|
2385
|
+
```
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
|
|
2389
|
+
|
|
2390
|
+
|
|
2367
2391
|
|
|
2368
2392
|
## Forms
|
|
2369
2393
|
|
|
2370
2394
|
|
|
2371
|
-
#### [
|
|
2395
|
+
#### [Create Form](https://developers.klaviyo.com/en/v2026-01-15/reference/create_form)
|
|
2396
|
+
|
|
2397
|
+
```ruby
|
|
2398
|
+
KlaviyoAPI::Forms.create_form(body)
|
|
2399
|
+
```
|
|
2400
|
+
|
|
2401
|
+
|
|
2402
|
+
|
|
2403
|
+
|
|
2404
|
+
|
|
2405
|
+
#### [Delete Form](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_form)
|
|
2372
2406
|
|
|
2373
2407
|
```ruby
|
|
2374
2408
|
KlaviyoAPI::Forms.delete_form(id)
|
|
@@ -2378,7 +2412,7 @@ KlaviyoAPI::Forms.delete_form(id)
|
|
|
2378
2412
|
|
|
2379
2413
|
|
|
2380
2414
|
|
|
2381
|
-
#### [Get Form](https://developers.klaviyo.com/en/
|
|
2415
|
+
#### [Get Form](https://developers.klaviyo.com/en/v2026-01-15/reference/get_form)
|
|
2382
2416
|
|
|
2383
2417
|
```ruby
|
|
2384
2418
|
KlaviyoAPI::Forms.get_form(id, opts)
|
|
@@ -2388,7 +2422,7 @@ KlaviyoAPI::Forms.get_form(id, opts)
|
|
|
2388
2422
|
|
|
2389
2423
|
|
|
2390
2424
|
|
|
2391
|
-
#### [Get Form for Form Version](https://developers.klaviyo.com/en/
|
|
2425
|
+
#### [Get Form for Form Version](https://developers.klaviyo.com/en/v2026-01-15/reference/get_form_for_form_version)
|
|
2392
2426
|
|
|
2393
2427
|
```ruby
|
|
2394
2428
|
KlaviyoAPI::Forms.get_form_for_form_version(id, opts)
|
|
@@ -2402,7 +2436,7 @@ KlaviyoAPI::Forms.get_form_version_form(id, opts)
|
|
|
2402
2436
|
|
|
2403
2437
|
|
|
2404
2438
|
|
|
2405
|
-
#### [Get Form ID for Form Version](https://developers.klaviyo.com/en/
|
|
2439
|
+
#### [Get Form ID for Form Version](https://developers.klaviyo.com/en/v2026-01-15/reference/get_form_id_for_form_version)
|
|
2406
2440
|
|
|
2407
2441
|
```ruby
|
|
2408
2442
|
KlaviyoAPI::Forms.get_form_id_for_form_version(id)
|
|
@@ -2416,7 +2450,7 @@ KlaviyoAPI::Forms.get_form_version_relationships_form(id)
|
|
|
2416
2450
|
|
|
2417
2451
|
|
|
2418
2452
|
|
|
2419
|
-
#### [Get Form Version](https://developers.klaviyo.com/en/
|
|
2453
|
+
#### [Get Form Version](https://developers.klaviyo.com/en/v2026-01-15/reference/get_form_version)
|
|
2420
2454
|
|
|
2421
2455
|
```ruby
|
|
2422
2456
|
KlaviyoAPI::Forms.get_form_version(id, opts)
|
|
@@ -2426,7 +2460,7 @@ KlaviyoAPI::Forms.get_form_version(id, opts)
|
|
|
2426
2460
|
|
|
2427
2461
|
|
|
2428
2462
|
|
|
2429
|
-
#### [Get Forms](https://developers.klaviyo.com/en/
|
|
2463
|
+
#### [Get Forms](https://developers.klaviyo.com/en/v2026-01-15/reference/get_forms)
|
|
2430
2464
|
|
|
2431
2465
|
```ruby
|
|
2432
2466
|
KlaviyoAPI::Forms.get_forms(opts)
|
|
@@ -2436,7 +2470,7 @@ KlaviyoAPI::Forms.get_forms(opts)
|
|
|
2436
2470
|
|
|
2437
2471
|
|
|
2438
2472
|
|
|
2439
|
-
#### [Get Version IDs for Form](https://developers.klaviyo.com/en/
|
|
2473
|
+
#### [Get Version IDs for Form](https://developers.klaviyo.com/en/v2026-01-15/reference/get_version_ids_for_form)
|
|
2440
2474
|
|
|
2441
2475
|
```ruby
|
|
2442
2476
|
KlaviyoAPI::Forms.get_version_ids_for_form(id, opts)
|
|
@@ -2454,7 +2488,7 @@ KlaviyoAPI::Forms.get_form_relationships_versions(id, opts)
|
|
|
2454
2488
|
|
|
2455
2489
|
|
|
2456
2490
|
|
|
2457
|
-
#### [Get Versions for Form](https://developers.klaviyo.com/en/
|
|
2491
|
+
#### [Get Versions for Form](https://developers.klaviyo.com/en/v2026-01-15/reference/get_versions_for_form)
|
|
2458
2492
|
|
|
2459
2493
|
```ruby
|
|
2460
2494
|
KlaviyoAPI::Forms.get_versions_for_form(id, opts)
|
|
@@ -2476,7 +2510,7 @@ KlaviyoAPI::Forms.get_form_versions(id, opts)
|
|
|
2476
2510
|
## Images
|
|
2477
2511
|
|
|
2478
2512
|
|
|
2479
|
-
#### [Get Image](https://developers.klaviyo.com/en/
|
|
2513
|
+
#### [Get Image](https://developers.klaviyo.com/en/v2026-01-15/reference/get_image)
|
|
2480
2514
|
|
|
2481
2515
|
```ruby
|
|
2482
2516
|
KlaviyoAPI::Images.get_image(id, opts)
|
|
@@ -2486,7 +2520,7 @@ KlaviyoAPI::Images.get_image(id, opts)
|
|
|
2486
2520
|
|
|
2487
2521
|
|
|
2488
2522
|
|
|
2489
|
-
#### [Get Images](https://developers.klaviyo.com/en/
|
|
2523
|
+
#### [Get Images](https://developers.klaviyo.com/en/v2026-01-15/reference/get_images)
|
|
2490
2524
|
|
|
2491
2525
|
```ruby
|
|
2492
2526
|
KlaviyoAPI::Images.get_images(opts)
|
|
@@ -2496,7 +2530,7 @@ KlaviyoAPI::Images.get_images(opts)
|
|
|
2496
2530
|
|
|
2497
2531
|
|
|
2498
2532
|
|
|
2499
|
-
#### [Update Image](https://developers.klaviyo.com/en/
|
|
2533
|
+
#### [Update Image](https://developers.klaviyo.com/en/v2026-01-15/reference/update_image)
|
|
2500
2534
|
|
|
2501
2535
|
```ruby
|
|
2502
2536
|
KlaviyoAPI::Images.update_image(id, body)
|
|
@@ -2506,7 +2540,7 @@ KlaviyoAPI::Images.update_image(id, body)
|
|
|
2506
2540
|
|
|
2507
2541
|
|
|
2508
2542
|
|
|
2509
|
-
#### [Upload Image From File](https://developers.klaviyo.com/en/
|
|
2543
|
+
#### [Upload Image From File](https://developers.klaviyo.com/en/v2026-01-15/reference/upload_image_from_file)
|
|
2510
2544
|
|
|
2511
2545
|
```ruby
|
|
2512
2546
|
KlaviyoAPI::Images.upload_image_from_file(file, opts)
|
|
@@ -2520,7 +2554,7 @@ KlaviyoAPI::Images.create_image_upload(file, opts)
|
|
|
2520
2554
|
|
|
2521
2555
|
|
|
2522
2556
|
|
|
2523
|
-
#### [Upload Image From URL](https://developers.klaviyo.com/en/
|
|
2557
|
+
#### [Upload Image From URL](https://developers.klaviyo.com/en/v2026-01-15/reference/upload_image_from_url)
|
|
2524
2558
|
|
|
2525
2559
|
```ruby
|
|
2526
2560
|
KlaviyoAPI::Images.upload_image_from_url(body)
|
|
@@ -2538,7 +2572,7 @@ KlaviyoAPI::Images.create_image(body)
|
|
|
2538
2572
|
## Lists
|
|
2539
2573
|
|
|
2540
2574
|
|
|
2541
|
-
#### [Add Profiles to List](https://developers.klaviyo.com/en/
|
|
2575
|
+
#### [Add Profiles to List](https://developers.klaviyo.com/en/v2026-01-15/reference/add_profiles_to_list)
|
|
2542
2576
|
|
|
2543
2577
|
```ruby
|
|
2544
2578
|
KlaviyoAPI::Lists.add_profiles_to_list(id, body)
|
|
@@ -2560,7 +2594,7 @@ KlaviyoAPI::Lists.create_list_relationships_profiles(id, body)
|
|
|
2560
2594
|
|
|
2561
2595
|
|
|
2562
2596
|
|
|
2563
|
-
#### [Create List](https://developers.klaviyo.com/en/
|
|
2597
|
+
#### [Create List](https://developers.klaviyo.com/en/v2026-01-15/reference/create_list)
|
|
2564
2598
|
|
|
2565
2599
|
```ruby
|
|
2566
2600
|
KlaviyoAPI::Lists.create_list(body)
|
|
@@ -2570,7 +2604,7 @@ KlaviyoAPI::Lists.create_list(body)
|
|
|
2570
2604
|
|
|
2571
2605
|
|
|
2572
2606
|
|
|
2573
|
-
#### [Delete List](https://developers.klaviyo.com/en/
|
|
2607
|
+
#### [Delete List](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_list)
|
|
2574
2608
|
|
|
2575
2609
|
```ruby
|
|
2576
2610
|
KlaviyoAPI::Lists.delete_list(id)
|
|
@@ -2580,7 +2614,7 @@ KlaviyoAPI::Lists.delete_list(id)
|
|
|
2580
2614
|
|
|
2581
2615
|
|
|
2582
2616
|
|
|
2583
|
-
#### [Get Flows Triggered by List](https://developers.klaviyo.com/en/
|
|
2617
|
+
#### [Get Flows Triggered by List](https://developers.klaviyo.com/en/v2026-01-15/reference/get_flows_triggered_by_list)
|
|
2584
2618
|
|
|
2585
2619
|
```ruby
|
|
2586
2620
|
KlaviyoAPI::Lists.get_flows_triggered_by_list(id, opts)
|
|
@@ -2598,7 +2632,7 @@ KlaviyoAPI::Lists.get_list_flow_triggers(id, opts)
|
|
|
2598
2632
|
|
|
2599
2633
|
|
|
2600
2634
|
|
|
2601
|
-
#### [Get IDs for Flows Triggered by List](https://developers.klaviyo.com/en/
|
|
2635
|
+
#### [Get IDs for Flows Triggered by List](https://developers.klaviyo.com/en/v2026-01-15/reference/get_ids_for_flows_triggered_by_list)
|
|
2602
2636
|
|
|
2603
2637
|
```ruby
|
|
2604
2638
|
KlaviyoAPI::Lists.get_ids_for_flows_triggered_by_list(id)
|
|
@@ -2616,7 +2650,7 @@ KlaviyoAPI::Lists.get_list_relationships_flow_triggers(id)
|
|
|
2616
2650
|
|
|
2617
2651
|
|
|
2618
2652
|
|
|
2619
|
-
#### [Get List](https://developers.klaviyo.com/en/
|
|
2653
|
+
#### [Get List](https://developers.klaviyo.com/en/v2026-01-15/reference/get_list)
|
|
2620
2654
|
|
|
2621
2655
|
```ruby
|
|
2622
2656
|
KlaviyoAPI::Lists.get_list(id, opts)
|
|
@@ -2626,7 +2660,7 @@ KlaviyoAPI::Lists.get_list(id, opts)
|
|
|
2626
2660
|
|
|
2627
2661
|
|
|
2628
2662
|
|
|
2629
|
-
#### [Get Lists](https://developers.klaviyo.com/en/
|
|
2663
|
+
#### [Get Lists](https://developers.klaviyo.com/en/v2026-01-15/reference/get_lists)
|
|
2630
2664
|
|
|
2631
2665
|
```ruby
|
|
2632
2666
|
KlaviyoAPI::Lists.get_lists(opts)
|
|
@@ -2636,7 +2670,7 @@ KlaviyoAPI::Lists.get_lists(opts)
|
|
|
2636
2670
|
|
|
2637
2671
|
|
|
2638
2672
|
|
|
2639
|
-
#### [Get Profile IDs for List](https://developers.klaviyo.com/en/
|
|
2673
|
+
#### [Get Profile IDs for List](https://developers.klaviyo.com/en/v2026-01-15/reference/get_profile_ids_for_list)
|
|
2640
2674
|
|
|
2641
2675
|
```ruby
|
|
2642
2676
|
KlaviyoAPI::Lists.get_profile_ids_for_list(id, opts)
|
|
@@ -2650,7 +2684,7 @@ KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
|
|
|
2650
2684
|
|
|
2651
2685
|
|
|
2652
2686
|
|
|
2653
|
-
#### [Get Profiles for List](https://developers.klaviyo.com/en/
|
|
2687
|
+
#### [Get Profiles for List](https://developers.klaviyo.com/en/v2026-01-15/reference/get_profiles_for_list)
|
|
2654
2688
|
|
|
2655
2689
|
```ruby
|
|
2656
2690
|
KlaviyoAPI::Lists.get_profiles_for_list(id, opts)
|
|
@@ -2664,7 +2698,7 @@ KlaviyoAPI::Lists.get_list_profiles(id, opts)
|
|
|
2664
2698
|
|
|
2665
2699
|
|
|
2666
2700
|
|
|
2667
|
-
#### [Get Tag IDs for List](https://developers.klaviyo.com/en/
|
|
2701
|
+
#### [Get Tag IDs for List](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tag_ids_for_list)
|
|
2668
2702
|
|
|
2669
2703
|
```ruby
|
|
2670
2704
|
KlaviyoAPI::Lists.get_tag_ids_for_list(id)
|
|
@@ -2678,7 +2712,7 @@ KlaviyoAPI::Lists.get_list_relationships_tags(id)
|
|
|
2678
2712
|
|
|
2679
2713
|
|
|
2680
2714
|
|
|
2681
|
-
#### [Get Tags for List](https://developers.klaviyo.com/en/
|
|
2715
|
+
#### [Get Tags for List](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tags_for_list)
|
|
2682
2716
|
|
|
2683
2717
|
```ruby
|
|
2684
2718
|
KlaviyoAPI::Lists.get_tags_for_list(id, opts)
|
|
@@ -2692,7 +2726,7 @@ KlaviyoAPI::Lists.get_list_tags(id, opts)
|
|
|
2692
2726
|
|
|
2693
2727
|
|
|
2694
2728
|
|
|
2695
|
-
#### [Remove Profiles from List](https://developers.klaviyo.com/en/
|
|
2729
|
+
#### [Remove Profiles from List](https://developers.klaviyo.com/en/v2026-01-15/reference/remove_profiles_from_list)
|
|
2696
2730
|
|
|
2697
2731
|
```ruby
|
|
2698
2732
|
KlaviyoAPI::Lists.remove_profiles_from_list(id, body)
|
|
@@ -2710,7 +2744,7 @@ KlaviyoAPI::Lists.delete_list_relationships_profiles(id, body)
|
|
|
2710
2744
|
|
|
2711
2745
|
|
|
2712
2746
|
|
|
2713
|
-
#### [Update List](https://developers.klaviyo.com/en/
|
|
2747
|
+
#### [Update List](https://developers.klaviyo.com/en/v2026-01-15/reference/update_list)
|
|
2714
2748
|
|
|
2715
2749
|
```ruby
|
|
2716
2750
|
KlaviyoAPI::Lists.update_list(id, body)
|
|
@@ -2724,7 +2758,7 @@ KlaviyoAPI::Lists.update_list(id, body)
|
|
|
2724
2758
|
## Metrics
|
|
2725
2759
|
|
|
2726
2760
|
|
|
2727
|
-
#### [Create Custom Metric](https://developers.klaviyo.com/en/
|
|
2761
|
+
#### [Create Custom Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/create_custom_metric)
|
|
2728
2762
|
|
|
2729
2763
|
```ruby
|
|
2730
2764
|
KlaviyoAPI::Metrics.create_custom_metric(body)
|
|
@@ -2734,7 +2768,7 @@ KlaviyoAPI::Metrics.create_custom_metric(body)
|
|
|
2734
2768
|
|
|
2735
2769
|
|
|
2736
2770
|
|
|
2737
|
-
#### [Delete Custom Metric](https://developers.klaviyo.com/en/
|
|
2771
|
+
#### [Delete Custom Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_custom_metric)
|
|
2738
2772
|
|
|
2739
2773
|
```ruby
|
|
2740
2774
|
KlaviyoAPI::Metrics.delete_custom_metric(id)
|
|
@@ -2744,7 +2778,7 @@ KlaviyoAPI::Metrics.delete_custom_metric(id)
|
|
|
2744
2778
|
|
|
2745
2779
|
|
|
2746
2780
|
|
|
2747
|
-
#### [Get Custom Metric](https://developers.klaviyo.com/en/
|
|
2781
|
+
#### [Get Custom Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_custom_metric)
|
|
2748
2782
|
|
|
2749
2783
|
```ruby
|
|
2750
2784
|
KlaviyoAPI::Metrics.get_custom_metric(id, opts)
|
|
@@ -2754,7 +2788,7 @@ KlaviyoAPI::Metrics.get_custom_metric(id, opts)
|
|
|
2754
2788
|
|
|
2755
2789
|
|
|
2756
2790
|
|
|
2757
|
-
#### [Get Custom Metric for Mapped Metric](https://developers.klaviyo.com/en/
|
|
2791
|
+
#### [Get Custom Metric for Mapped Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_custom_metric_for_mapped_metric)
|
|
2758
2792
|
|
|
2759
2793
|
```ruby
|
|
2760
2794
|
KlaviyoAPI::Metrics.get_custom_metric_for_mapped_metric(id, opts)
|
|
@@ -2768,7 +2802,7 @@ KlaviyoAPI::Metrics.get_mapped_metric_custom_metric(id, opts)
|
|
|
2768
2802
|
|
|
2769
2803
|
|
|
2770
2804
|
|
|
2771
|
-
#### [Get Custom Metric ID for Mapped Metric](https://developers.klaviyo.com/en/
|
|
2805
|
+
#### [Get Custom Metric ID for Mapped Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_custom_metric_id_for_mapped_metric)
|
|
2772
2806
|
|
|
2773
2807
|
```ruby
|
|
2774
2808
|
KlaviyoAPI::Metrics.get_custom_metric_id_for_mapped_metric(id)
|
|
@@ -2782,7 +2816,7 @@ KlaviyoAPI::Metrics.get_mapped_metric_relationships_custom_metric(id)
|
|
|
2782
2816
|
|
|
2783
2817
|
|
|
2784
2818
|
|
|
2785
|
-
#### [Get Custom Metrics](https://developers.klaviyo.com/en/
|
|
2819
|
+
#### [Get Custom Metrics](https://developers.klaviyo.com/en/v2026-01-15/reference/get_custom_metrics)
|
|
2786
2820
|
|
|
2787
2821
|
```ruby
|
|
2788
2822
|
KlaviyoAPI::Metrics.get_custom_metrics(opts)
|
|
@@ -2792,7 +2826,7 @@ KlaviyoAPI::Metrics.get_custom_metrics(opts)
|
|
|
2792
2826
|
|
|
2793
2827
|
|
|
2794
2828
|
|
|
2795
|
-
#### [Get Flows Triggered by Metric](https://developers.klaviyo.com/en/
|
|
2829
|
+
#### [Get Flows Triggered by Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_flows_triggered_by_metric)
|
|
2796
2830
|
|
|
2797
2831
|
```ruby
|
|
2798
2832
|
KlaviyoAPI::Metrics.get_flows_triggered_by_metric(id, opts)
|
|
@@ -2810,7 +2844,7 @@ KlaviyoAPI::Metrics.get_metric_flow_triggers(id, opts)
|
|
|
2810
2844
|
|
|
2811
2845
|
|
|
2812
2846
|
|
|
2813
|
-
#### [Get IDs for Flows Triggered by Metric](https://developers.klaviyo.com/en/
|
|
2847
|
+
#### [Get IDs for Flows Triggered by Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_ids_for_flows_triggered_by_metric)
|
|
2814
2848
|
|
|
2815
2849
|
```ruby
|
|
2816
2850
|
KlaviyoAPI::Metrics.get_ids_for_flows_triggered_by_metric(id)
|
|
@@ -2828,7 +2862,7 @@ KlaviyoAPI::Metrics.get_metric_relationships_flow_triggers(id)
|
|
|
2828
2862
|
|
|
2829
2863
|
|
|
2830
2864
|
|
|
2831
|
-
#### [Get Mapped Metric](https://developers.klaviyo.com/en/
|
|
2865
|
+
#### [Get Mapped Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_mapped_metric)
|
|
2832
2866
|
|
|
2833
2867
|
```ruby
|
|
2834
2868
|
KlaviyoAPI::Metrics.get_mapped_metric(id, opts)
|
|
@@ -2838,7 +2872,7 @@ KlaviyoAPI::Metrics.get_mapped_metric(id, opts)
|
|
|
2838
2872
|
|
|
2839
2873
|
|
|
2840
2874
|
|
|
2841
|
-
#### [Get Mapped Metrics](https://developers.klaviyo.com/en/
|
|
2875
|
+
#### [Get Mapped Metrics](https://developers.klaviyo.com/en/v2026-01-15/reference/get_mapped_metrics)
|
|
2842
2876
|
|
|
2843
2877
|
```ruby
|
|
2844
2878
|
KlaviyoAPI::Metrics.get_mapped_metrics(opts)
|
|
@@ -2848,7 +2882,7 @@ KlaviyoAPI::Metrics.get_mapped_metrics(opts)
|
|
|
2848
2882
|
|
|
2849
2883
|
|
|
2850
2884
|
|
|
2851
|
-
#### [Get Metric](https://developers.klaviyo.com/en/
|
|
2885
|
+
#### [Get Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_metric)
|
|
2852
2886
|
|
|
2853
2887
|
```ruby
|
|
2854
2888
|
KlaviyoAPI::Metrics.get_metric(id, opts)
|
|
@@ -2858,7 +2892,7 @@ KlaviyoAPI::Metrics.get_metric(id, opts)
|
|
|
2858
2892
|
|
|
2859
2893
|
|
|
2860
2894
|
|
|
2861
|
-
#### [Get Metric for Mapped Metric](https://developers.klaviyo.com/en/
|
|
2895
|
+
#### [Get Metric for Mapped Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_metric_for_mapped_metric)
|
|
2862
2896
|
|
|
2863
2897
|
```ruby
|
|
2864
2898
|
KlaviyoAPI::Metrics.get_metric_for_mapped_metric(id, opts)
|
|
@@ -2872,7 +2906,7 @@ KlaviyoAPI::Metrics.get_mapped_metric_metric(id, opts)
|
|
|
2872
2906
|
|
|
2873
2907
|
|
|
2874
2908
|
|
|
2875
|
-
#### [Get Metric for Metric Property](https://developers.klaviyo.com/en/
|
|
2909
|
+
#### [Get Metric for Metric Property](https://developers.klaviyo.com/en/v2026-01-15/reference/get_metric_for_metric_property)
|
|
2876
2910
|
|
|
2877
2911
|
```ruby
|
|
2878
2912
|
KlaviyoAPI::Metrics.get_metric_for_metric_property(id, opts)
|
|
@@ -2886,7 +2920,7 @@ KlaviyoAPI::Metrics.get_metric_property_metric(id, opts)
|
|
|
2886
2920
|
|
|
2887
2921
|
|
|
2888
2922
|
|
|
2889
|
-
#### [Get Metric ID for Mapped Metric](https://developers.klaviyo.com/en/
|
|
2923
|
+
#### [Get Metric ID for Mapped Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_metric_id_for_mapped_metric)
|
|
2890
2924
|
|
|
2891
2925
|
```ruby
|
|
2892
2926
|
KlaviyoAPI::Metrics.get_metric_id_for_mapped_metric(id)
|
|
@@ -2900,7 +2934,7 @@ KlaviyoAPI::Metrics.get_mapped_metric_relationships_metric(id)
|
|
|
2900
2934
|
|
|
2901
2935
|
|
|
2902
2936
|
|
|
2903
|
-
#### [Get Metric ID for Metric Property](https://developers.klaviyo.com/en/
|
|
2937
|
+
#### [Get Metric ID for Metric Property](https://developers.klaviyo.com/en/v2026-01-15/reference/get_metric_id_for_metric_property)
|
|
2904
2938
|
|
|
2905
2939
|
```ruby
|
|
2906
2940
|
KlaviyoAPI::Metrics.get_metric_id_for_metric_property(id)
|
|
@@ -2914,7 +2948,7 @@ KlaviyoAPI::Metrics.get_metric_property_relationships_metric(id)
|
|
|
2914
2948
|
|
|
2915
2949
|
|
|
2916
2950
|
|
|
2917
|
-
#### [Get Metric IDs for Custom Metric](https://developers.klaviyo.com/en/
|
|
2951
|
+
#### [Get Metric IDs for Custom Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_metric_ids_for_custom_metric)
|
|
2918
2952
|
|
|
2919
2953
|
```ruby
|
|
2920
2954
|
KlaviyoAPI::Metrics.get_metric_ids_for_custom_metric(id)
|
|
@@ -2928,7 +2962,7 @@ KlaviyoAPI::Metrics.get_custom_metric_relationships_metrics(id)
|
|
|
2928
2962
|
|
|
2929
2963
|
|
|
2930
2964
|
|
|
2931
|
-
#### [Get Metric Property](https://developers.klaviyo.com/en/
|
|
2965
|
+
#### [Get Metric Property](https://developers.klaviyo.com/en/v2026-01-15/reference/get_metric_property)
|
|
2932
2966
|
|
|
2933
2967
|
```ruby
|
|
2934
2968
|
KlaviyoAPI::Metrics.get_metric_property(id, opts)
|
|
@@ -2938,7 +2972,7 @@ KlaviyoAPI::Metrics.get_metric_property(id, opts)
|
|
|
2938
2972
|
|
|
2939
2973
|
|
|
2940
2974
|
|
|
2941
|
-
#### [Get Metrics](https://developers.klaviyo.com/en/
|
|
2975
|
+
#### [Get Metrics](https://developers.klaviyo.com/en/v2026-01-15/reference/get_metrics)
|
|
2942
2976
|
|
|
2943
2977
|
```ruby
|
|
2944
2978
|
KlaviyoAPI::Metrics.get_metrics(opts)
|
|
@@ -2948,7 +2982,7 @@ KlaviyoAPI::Metrics.get_metrics(opts)
|
|
|
2948
2982
|
|
|
2949
2983
|
|
|
2950
2984
|
|
|
2951
|
-
#### [Get Metrics for Custom Metric](https://developers.klaviyo.com/en/
|
|
2985
|
+
#### [Get Metrics for Custom Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_metrics_for_custom_metric)
|
|
2952
2986
|
|
|
2953
2987
|
```ruby
|
|
2954
2988
|
KlaviyoAPI::Metrics.get_metrics_for_custom_metric(id, opts)
|
|
@@ -2962,7 +2996,7 @@ KlaviyoAPI::Metrics.get_custom_metric_metrics(id, opts)
|
|
|
2962
2996
|
|
|
2963
2997
|
|
|
2964
2998
|
|
|
2965
|
-
#### [Get Properties for Metric](https://developers.klaviyo.com/en/
|
|
2999
|
+
#### [Get Properties for Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_properties_for_metric)
|
|
2966
3000
|
|
|
2967
3001
|
```ruby
|
|
2968
3002
|
KlaviyoAPI::Metrics.get_properties_for_metric(id, opts)
|
|
@@ -2980,7 +3014,7 @@ KlaviyoAPI::Metrics.get_metric_properties(id, opts)
|
|
|
2980
3014
|
|
|
2981
3015
|
|
|
2982
3016
|
|
|
2983
|
-
#### [Get Property IDs for Metric](https://developers.klaviyo.com/en/
|
|
3017
|
+
#### [Get Property IDs for Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/get_property_ids_for_metric)
|
|
2984
3018
|
|
|
2985
3019
|
```ruby
|
|
2986
3020
|
KlaviyoAPI::Metrics.get_property_ids_for_metric(id)
|
|
@@ -2998,7 +3032,7 @@ KlaviyoAPI::Metrics.get_metric_relationships_properties(id)
|
|
|
2998
3032
|
|
|
2999
3033
|
|
|
3000
3034
|
|
|
3001
|
-
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/
|
|
3035
|
+
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2026-01-15/reference/query_metric_aggregates)
|
|
3002
3036
|
|
|
3003
3037
|
```ruby
|
|
3004
3038
|
KlaviyoAPI::Metrics.query_metric_aggregates(body)
|
|
@@ -3012,7 +3046,7 @@ KlaviyoAPI::Metrics.create_metric_aggregate(body)
|
|
|
3012
3046
|
|
|
3013
3047
|
|
|
3014
3048
|
|
|
3015
|
-
#### [Update Custom Metric](https://developers.klaviyo.com/en/
|
|
3049
|
+
#### [Update Custom Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/update_custom_metric)
|
|
3016
3050
|
|
|
3017
3051
|
```ruby
|
|
3018
3052
|
KlaviyoAPI::Metrics.update_custom_metric(id, body)
|
|
@@ -3022,7 +3056,7 @@ KlaviyoAPI::Metrics.update_custom_metric(id, body)
|
|
|
3022
3056
|
|
|
3023
3057
|
|
|
3024
3058
|
|
|
3025
|
-
#### [Update Mapped Metric](https://developers.klaviyo.com/en/
|
|
3059
|
+
#### [Update Mapped Metric](https://developers.klaviyo.com/en/v2026-01-15/reference/update_mapped_metric)
|
|
3026
3060
|
|
|
3027
3061
|
```ruby
|
|
3028
3062
|
KlaviyoAPI::Metrics.update_mapped_metric(id, body)
|
|
@@ -3036,7 +3070,7 @@ KlaviyoAPI::Metrics.update_mapped_metric(id, body)
|
|
|
3036
3070
|
## Profiles
|
|
3037
3071
|
|
|
3038
3072
|
|
|
3039
|
-
#### [Bulk Import Profiles](https://developers.klaviyo.com/en/
|
|
3073
|
+
#### [Bulk Import Profiles](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_import_profiles)
|
|
3040
3074
|
|
|
3041
3075
|
```ruby
|
|
3042
3076
|
KlaviyoAPI::Profiles.bulk_import_profiles(body)
|
|
@@ -3054,7 +3088,7 @@ KlaviyoAPI::Profiles.create_profile_bulk_import_job(body)
|
|
|
3054
3088
|
|
|
3055
3089
|
|
|
3056
3090
|
|
|
3057
|
-
#### [Bulk Subscribe Profiles](https://developers.klaviyo.com/en/
|
|
3091
|
+
#### [Bulk Subscribe Profiles](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_subscribe_profiles)
|
|
3058
3092
|
|
|
3059
3093
|
```ruby
|
|
3060
3094
|
KlaviyoAPI::Profiles.bulk_subscribe_profiles(body)
|
|
@@ -3072,7 +3106,7 @@ KlaviyoAPI::Profiles.create_profile_subscription_bulk_create_job(body)
|
|
|
3072
3106
|
|
|
3073
3107
|
|
|
3074
3108
|
|
|
3075
|
-
#### [Bulk Suppress Profiles](https://developers.klaviyo.com/en/
|
|
3109
|
+
#### [Bulk Suppress Profiles](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_suppress_profiles)
|
|
3076
3110
|
|
|
3077
3111
|
```ruby
|
|
3078
3112
|
KlaviyoAPI::Profiles.bulk_suppress_profiles(body)
|
|
@@ -3090,7 +3124,7 @@ KlaviyoAPI::Profiles.create_profile_suppression_bulk_create_job(body)
|
|
|
3090
3124
|
|
|
3091
3125
|
|
|
3092
3126
|
|
|
3093
|
-
#### [Bulk Unsubscribe Profiles](https://developers.klaviyo.com/en/
|
|
3127
|
+
#### [Bulk Unsubscribe Profiles](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_unsubscribe_profiles)
|
|
3094
3128
|
|
|
3095
3129
|
```ruby
|
|
3096
3130
|
KlaviyoAPI::Profiles.bulk_unsubscribe_profiles(body)
|
|
@@ -3108,7 +3142,7 @@ KlaviyoAPI::Profiles.create_profile_subscription_bulk_delete_job(body)
|
|
|
3108
3142
|
|
|
3109
3143
|
|
|
3110
3144
|
|
|
3111
|
-
#### [Bulk Unsuppress Profiles](https://developers.klaviyo.com/en/
|
|
3145
|
+
#### [Bulk Unsuppress Profiles](https://developers.klaviyo.com/en/v2026-01-15/reference/bulk_unsuppress_profiles)
|
|
3112
3146
|
|
|
3113
3147
|
```ruby
|
|
3114
3148
|
KlaviyoAPI::Profiles.bulk_unsuppress_profiles(body)
|
|
@@ -3126,7 +3160,7 @@ KlaviyoAPI::Profiles.create_profile_suppression_bulk_delete_job(body)
|
|
|
3126
3160
|
|
|
3127
3161
|
|
|
3128
3162
|
|
|
3129
|
-
#### [Create or Update Profile](https://developers.klaviyo.com/en/
|
|
3163
|
+
#### [Create or Update Profile](https://developers.klaviyo.com/en/v2026-01-15/reference/create_or_update_profile)
|
|
3130
3164
|
|
|
3131
3165
|
```ruby
|
|
3132
3166
|
KlaviyoAPI::Profiles.create_or_update_profile(body, opts)
|
|
@@ -3140,7 +3174,7 @@ KlaviyoAPI::Profiles.create_profile_import(body, opts)
|
|
|
3140
3174
|
|
|
3141
3175
|
|
|
3142
3176
|
|
|
3143
|
-
#### [Create Profile](https://developers.klaviyo.com/en/
|
|
3177
|
+
#### [Create Profile](https://developers.klaviyo.com/en/v2026-01-15/reference/create_profile)
|
|
3144
3178
|
|
|
3145
3179
|
```ruby
|
|
3146
3180
|
KlaviyoAPI::Profiles.create_profile(body, opts)
|
|
@@ -3150,7 +3184,7 @@ KlaviyoAPI::Profiles.create_profile(body, opts)
|
|
|
3150
3184
|
|
|
3151
3185
|
|
|
3152
3186
|
|
|
3153
|
-
#### [Create or Update Push Token](https://developers.klaviyo.com/en/
|
|
3187
|
+
#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2026-01-15/reference/create_push_token)
|
|
3154
3188
|
|
|
3155
3189
|
```ruby
|
|
3156
3190
|
KlaviyoAPI::Profiles.create_push_token(body)
|
|
@@ -3160,7 +3194,7 @@ KlaviyoAPI::Profiles.create_push_token(body)
|
|
|
3160
3194
|
|
|
3161
3195
|
|
|
3162
3196
|
|
|
3163
|
-
#### [Delete Push Token](https://developers.klaviyo.com/en/
|
|
3197
|
+
#### [Delete Push Token](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_push_token)
|
|
3164
3198
|
|
|
3165
3199
|
```ruby
|
|
3166
3200
|
KlaviyoAPI::Profiles.delete_push_token(id)
|
|
@@ -3170,7 +3204,7 @@ KlaviyoAPI::Profiles.delete_push_token(id)
|
|
|
3170
3204
|
|
|
3171
3205
|
|
|
3172
3206
|
|
|
3173
|
-
#### [Get Bulk Import Profiles Job](https://developers.klaviyo.com/en/
|
|
3207
|
+
#### [Get Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_import_profiles_job)
|
|
3174
3208
|
|
|
3175
3209
|
```ruby
|
|
3176
3210
|
KlaviyoAPI::Profiles.get_bulk_import_profiles_job(job_id, opts)
|
|
@@ -3188,7 +3222,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job(job_id, opts)
|
|
|
3188
3222
|
|
|
3189
3223
|
|
|
3190
3224
|
|
|
3191
|
-
#### [Get Bulk Import Profiles Jobs](https://developers.klaviyo.com/en/
|
|
3225
|
+
#### [Get Bulk Import Profiles Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_import_profiles_jobs)
|
|
3192
3226
|
|
|
3193
3227
|
```ruby
|
|
3194
3228
|
KlaviyoAPI::Profiles.get_bulk_import_profiles_jobs(opts)
|
|
@@ -3206,7 +3240,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_jobs(opts)
|
|
|
3206
3240
|
|
|
3207
3241
|
|
|
3208
3242
|
|
|
3209
|
-
#### [Get Bulk Suppress Profiles Job](https://developers.klaviyo.com/en/
|
|
3243
|
+
#### [Get Bulk Suppress Profiles Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_suppress_profiles_job)
|
|
3210
3244
|
|
|
3211
3245
|
```ruby
|
|
3212
3246
|
KlaviyoAPI::Profiles.get_bulk_suppress_profiles_job(job_id, opts)
|
|
@@ -3220,7 +3254,7 @@ KlaviyoAPI::Profiles.get_profile_suppression_bulk_create_job(job_id, opts)
|
|
|
3220
3254
|
|
|
3221
3255
|
|
|
3222
3256
|
|
|
3223
|
-
#### [Get Bulk Suppress Profiles Jobs](https://developers.klaviyo.com/en/
|
|
3257
|
+
#### [Get Bulk Suppress Profiles Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_suppress_profiles_jobs)
|
|
3224
3258
|
|
|
3225
3259
|
```ruby
|
|
3226
3260
|
KlaviyoAPI::Profiles.get_bulk_suppress_profiles_jobs(opts)
|
|
@@ -3234,7 +3268,7 @@ KlaviyoAPI::Profiles.get_profile_suppression_bulk_create_jobs(opts)
|
|
|
3234
3268
|
|
|
3235
3269
|
|
|
3236
3270
|
|
|
3237
|
-
#### [Get Bulk Unsuppress Profiles Job](https://developers.klaviyo.com/en/
|
|
3271
|
+
#### [Get Bulk Unsuppress Profiles Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_unsuppress_profiles_job)
|
|
3238
3272
|
|
|
3239
3273
|
```ruby
|
|
3240
3274
|
KlaviyoAPI::Profiles.get_bulk_unsuppress_profiles_job(job_id, opts)
|
|
@@ -3248,7 +3282,7 @@ KlaviyoAPI::Profiles.get_profile_suppression_bulk_delete_job(job_id, opts)
|
|
|
3248
3282
|
|
|
3249
3283
|
|
|
3250
3284
|
|
|
3251
|
-
#### [Get Bulk Unsuppress Profiles Jobs](https://developers.klaviyo.com/en/
|
|
3285
|
+
#### [Get Bulk Unsuppress Profiles Jobs](https://developers.klaviyo.com/en/v2026-01-15/reference/get_bulk_unsuppress_profiles_jobs)
|
|
3252
3286
|
|
|
3253
3287
|
```ruby
|
|
3254
3288
|
KlaviyoAPI::Profiles.get_bulk_unsuppress_profiles_jobs(opts)
|
|
@@ -3262,7 +3296,7 @@ KlaviyoAPI::Profiles.get_profile_suppression_bulk_delete_jobs(opts)
|
|
|
3262
3296
|
|
|
3263
3297
|
|
|
3264
3298
|
|
|
3265
|
-
#### [Get Errors for Bulk Import Profiles Job](https://developers.klaviyo.com/en/
|
|
3299
|
+
#### [Get Errors for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_errors_for_bulk_import_profiles_job)
|
|
3266
3300
|
|
|
3267
3301
|
```ruby
|
|
3268
3302
|
KlaviyoAPI::Profiles.get_errors_for_bulk_import_profiles_job(id, opts)
|
|
@@ -3284,7 +3318,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job_import_errors(id, opts)
|
|
|
3284
3318
|
|
|
3285
3319
|
|
|
3286
3320
|
|
|
3287
|
-
#### [Get List for Bulk Import Profiles Job](https://developers.klaviyo.com/en/
|
|
3321
|
+
#### [Get List for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_list_for_bulk_import_profiles_job)
|
|
3288
3322
|
|
|
3289
3323
|
```ruby
|
|
3290
3324
|
KlaviyoAPI::Profiles.get_list_for_bulk_import_profiles_job(id, opts)
|
|
@@ -3306,7 +3340,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job_lists(id, opts)
|
|
|
3306
3340
|
|
|
3307
3341
|
|
|
3308
3342
|
|
|
3309
|
-
#### [Get List IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/
|
|
3343
|
+
#### [Get List IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_list_ids_for_bulk_import_profiles_job)
|
|
3310
3344
|
|
|
3311
3345
|
```ruby
|
|
3312
3346
|
KlaviyoAPI::Profiles.get_list_ids_for_bulk_import_profiles_job(id)
|
|
@@ -3328,7 +3362,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_lists(id)
|
|
|
3328
3362
|
|
|
3329
3363
|
|
|
3330
3364
|
|
|
3331
|
-
#### [Get List IDs for Profile](https://developers.klaviyo.com/en/
|
|
3365
|
+
#### [Get List IDs for Profile](https://developers.klaviyo.com/en/v2026-01-15/reference/get_list_ids_for_profile)
|
|
3332
3366
|
|
|
3333
3367
|
```ruby
|
|
3334
3368
|
KlaviyoAPI::Profiles.get_list_ids_for_profile(id)
|
|
@@ -3342,7 +3376,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
|
|
|
3342
3376
|
|
|
3343
3377
|
|
|
3344
3378
|
|
|
3345
|
-
#### [Get Lists for Profile](https://developers.klaviyo.com/en/
|
|
3379
|
+
#### [Get Lists for Profile](https://developers.klaviyo.com/en/v2026-01-15/reference/get_lists_for_profile)
|
|
3346
3380
|
|
|
3347
3381
|
```ruby
|
|
3348
3382
|
KlaviyoAPI::Profiles.get_lists_for_profile(id, opts)
|
|
@@ -3356,7 +3390,7 @@ KlaviyoAPI::Profiles.get_profile_lists(id, opts)
|
|
|
3356
3390
|
|
|
3357
3391
|
|
|
3358
3392
|
|
|
3359
|
-
#### [Get Profile](https://developers.klaviyo.com/en/
|
|
3393
|
+
#### [Get Profile](https://developers.klaviyo.com/en/v2026-01-15/reference/get_profile)
|
|
3360
3394
|
|
|
3361
3395
|
```ruby
|
|
3362
3396
|
KlaviyoAPI::Profiles.get_profile(id, opts)
|
|
@@ -3366,7 +3400,7 @@ KlaviyoAPI::Profiles.get_profile(id, opts)
|
|
|
3366
3400
|
|
|
3367
3401
|
|
|
3368
3402
|
|
|
3369
|
-
#### [Get Profile for Push Token](https://developers.klaviyo.com/en/
|
|
3403
|
+
#### [Get Profile for Push Token](https://developers.klaviyo.com/en/v2026-01-15/reference/get_profile_for_push_token)
|
|
3370
3404
|
|
|
3371
3405
|
```ruby
|
|
3372
3406
|
KlaviyoAPI::Profiles.get_profile_for_push_token(id, opts)
|
|
@@ -3380,7 +3414,7 @@ KlaviyoAPI::Profiles.get_push_token_profile(id, opts)
|
|
|
3380
3414
|
|
|
3381
3415
|
|
|
3382
3416
|
|
|
3383
|
-
#### [Get Profile ID for Push Token](https://developers.klaviyo.com/en/
|
|
3417
|
+
#### [Get Profile ID for Push Token](https://developers.klaviyo.com/en/v2026-01-15/reference/get_profile_id_for_push_token)
|
|
3384
3418
|
|
|
3385
3419
|
```ruby
|
|
3386
3420
|
KlaviyoAPI::Profiles.get_profile_id_for_push_token(id)
|
|
@@ -3394,7 +3428,7 @@ KlaviyoAPI::Profiles.get_push_token_relationships_profile(id)
|
|
|
3394
3428
|
|
|
3395
3429
|
|
|
3396
3430
|
|
|
3397
|
-
#### [Get Profile IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/
|
|
3431
|
+
#### [Get Profile IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_profile_ids_for_bulk_import_profiles_job)
|
|
3398
3432
|
|
|
3399
3433
|
```ruby
|
|
3400
3434
|
KlaviyoAPI::Profiles.get_profile_ids_for_bulk_import_profiles_job(id, opts)
|
|
@@ -3416,7 +3450,7 @@ KlaviyoAPI::Profiles.get_profile_ids_for_profile_bulk_import_job(id, opts)
|
|
|
3416
3450
|
|
|
3417
3451
|
|
|
3418
3452
|
|
|
3419
|
-
#### [Get Profiles](https://developers.klaviyo.com/en/
|
|
3453
|
+
#### [Get Profiles](https://developers.klaviyo.com/en/v2026-01-15/reference/get_profiles)
|
|
3420
3454
|
|
|
3421
3455
|
```ruby
|
|
3422
3456
|
KlaviyoAPI::Profiles.get_profiles(opts)
|
|
@@ -3426,7 +3460,7 @@ KlaviyoAPI::Profiles.get_profiles(opts)
|
|
|
3426
3460
|
|
|
3427
3461
|
|
|
3428
3462
|
|
|
3429
|
-
#### [Get Profiles for Bulk Import Profiles Job](https://developers.klaviyo.com/en/
|
|
3463
|
+
#### [Get Profiles for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-01-15/reference/get_profiles_for_bulk_import_profiles_job)
|
|
3430
3464
|
|
|
3431
3465
|
```ruby
|
|
3432
3466
|
KlaviyoAPI::Profiles.get_profiles_for_bulk_import_profiles_job(id, opts)
|
|
@@ -3448,7 +3482,7 @@ KlaviyoAPI::Profiles.get_profiles_for_profile_bulk_import_job(id, opts)
|
|
|
3448
3482
|
|
|
3449
3483
|
|
|
3450
3484
|
|
|
3451
|
-
#### [Get Push Token](https://developers.klaviyo.com/en/
|
|
3485
|
+
#### [Get Push Token](https://developers.klaviyo.com/en/v2026-01-15/reference/get_push_token)
|
|
3452
3486
|
|
|
3453
3487
|
```ruby
|
|
3454
3488
|
KlaviyoAPI::Profiles.get_push_token(id, opts)
|
|
@@ -3458,7 +3492,7 @@ KlaviyoAPI::Profiles.get_push_token(id, opts)
|
|
|
3458
3492
|
|
|
3459
3493
|
|
|
3460
3494
|
|
|
3461
|
-
#### [Get Push Token IDs for Profile](https://developers.klaviyo.com/en/
|
|
3495
|
+
#### [Get Push Token IDs for Profile](https://developers.klaviyo.com/en/v2026-01-15/reference/get_push_token_ids_for_profile)
|
|
3462
3496
|
|
|
3463
3497
|
```ruby
|
|
3464
3498
|
KlaviyoAPI::Profiles.get_push_token_ids_for_profile(id)
|
|
@@ -3472,7 +3506,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_push_tokens(id)
|
|
|
3472
3506
|
|
|
3473
3507
|
|
|
3474
3508
|
|
|
3475
|
-
#### [Get Push Tokens](https://developers.klaviyo.com/en/
|
|
3509
|
+
#### [Get Push Tokens](https://developers.klaviyo.com/en/v2026-01-15/reference/get_push_tokens)
|
|
3476
3510
|
|
|
3477
3511
|
```ruby
|
|
3478
3512
|
KlaviyoAPI::Profiles.get_push_tokens(opts)
|
|
@@ -3482,7 +3516,7 @@ KlaviyoAPI::Profiles.get_push_tokens(opts)
|
|
|
3482
3516
|
|
|
3483
3517
|
|
|
3484
3518
|
|
|
3485
|
-
#### [Get Push Tokens for Profile](https://developers.klaviyo.com/en/
|
|
3519
|
+
#### [Get Push Tokens for Profile](https://developers.klaviyo.com/en/v2026-01-15/reference/get_push_tokens_for_profile)
|
|
3486
3520
|
|
|
3487
3521
|
```ruby
|
|
3488
3522
|
KlaviyoAPI::Profiles.get_push_tokens_for_profile(id, opts)
|
|
@@ -3496,7 +3530,7 @@ KlaviyoAPI::Profiles.get_profile_push_tokens(id, opts)
|
|
|
3496
3530
|
|
|
3497
3531
|
|
|
3498
3532
|
|
|
3499
|
-
#### [Get Segment IDs for Profile](https://developers.klaviyo.com/en/
|
|
3533
|
+
#### [Get Segment IDs for Profile](https://developers.klaviyo.com/en/v2026-01-15/reference/get_segment_ids_for_profile)
|
|
3500
3534
|
|
|
3501
3535
|
```ruby
|
|
3502
3536
|
KlaviyoAPI::Profiles.get_segment_ids_for_profile(id)
|
|
@@ -3510,7 +3544,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
|
|
|
3510
3544
|
|
|
3511
3545
|
|
|
3512
3546
|
|
|
3513
|
-
#### [Get Segments for Profile](https://developers.klaviyo.com/en/
|
|
3547
|
+
#### [Get Segments for Profile](https://developers.klaviyo.com/en/v2026-01-15/reference/get_segments_for_profile)
|
|
3514
3548
|
|
|
3515
3549
|
```ruby
|
|
3516
3550
|
KlaviyoAPI::Profiles.get_segments_for_profile(id, opts)
|
|
@@ -3524,7 +3558,7 @@ KlaviyoAPI::Profiles.get_profile_segments(id, opts)
|
|
|
3524
3558
|
|
|
3525
3559
|
|
|
3526
3560
|
|
|
3527
|
-
#### [Merge Profiles](https://developers.klaviyo.com/en/
|
|
3561
|
+
#### [Merge Profiles](https://developers.klaviyo.com/en/v2026-01-15/reference/merge_profiles)
|
|
3528
3562
|
|
|
3529
3563
|
```ruby
|
|
3530
3564
|
KlaviyoAPI::Profiles.merge_profiles(body)
|
|
@@ -3538,7 +3572,7 @@ KlaviyoAPI::Profiles.create_profile_merge(body)
|
|
|
3538
3572
|
|
|
3539
3573
|
|
|
3540
3574
|
|
|
3541
|
-
#### [Update Profile](https://developers.klaviyo.com/en/
|
|
3575
|
+
#### [Update Profile](https://developers.klaviyo.com/en/v2026-01-15/reference/update_profile)
|
|
3542
3576
|
|
|
3543
3577
|
```ruby
|
|
3544
3578
|
KlaviyoAPI::Profiles.update_profile(id, body, opts)
|
|
@@ -3552,7 +3586,7 @@ KlaviyoAPI::Profiles.update_profile(id, body, opts)
|
|
|
3552
3586
|
## Reporting
|
|
3553
3587
|
|
|
3554
3588
|
|
|
3555
|
-
#### [Query Campaign Values](https://developers.klaviyo.com/en/
|
|
3589
|
+
#### [Query Campaign Values](https://developers.klaviyo.com/en/v2026-01-15/reference/query_campaign_values)
|
|
3556
3590
|
|
|
3557
3591
|
```ruby
|
|
3558
3592
|
KlaviyoAPI::Reporting.query_campaign_values(body, opts)
|
|
@@ -3570,7 +3604,7 @@ KlaviyoAPI::Reporting.create_campaign_values_report(body, opts)
|
|
|
3570
3604
|
|
|
3571
3605
|
|
|
3572
3606
|
|
|
3573
|
-
#### [Query Flow Series](https://developers.klaviyo.com/en/
|
|
3607
|
+
#### [Query Flow Series](https://developers.klaviyo.com/en/v2026-01-15/reference/query_flow_series)
|
|
3574
3608
|
|
|
3575
3609
|
```ruby
|
|
3576
3610
|
KlaviyoAPI::Reporting.query_flow_series(body, opts)
|
|
@@ -3588,7 +3622,7 @@ KlaviyoAPI::Reporting.create_flow_series_report(body, opts)
|
|
|
3588
3622
|
|
|
3589
3623
|
|
|
3590
3624
|
|
|
3591
|
-
#### [Query Flow Values](https://developers.klaviyo.com/en/
|
|
3625
|
+
#### [Query Flow Values](https://developers.klaviyo.com/en/v2026-01-15/reference/query_flow_values)
|
|
3592
3626
|
|
|
3593
3627
|
```ruby
|
|
3594
3628
|
KlaviyoAPI::Reporting.query_flow_values(body, opts)
|
|
@@ -3606,7 +3640,7 @@ KlaviyoAPI::Reporting.create_flow_values_report(body, opts)
|
|
|
3606
3640
|
|
|
3607
3641
|
|
|
3608
3642
|
|
|
3609
|
-
#### [Query Form Series](https://developers.klaviyo.com/en/
|
|
3643
|
+
#### [Query Form Series](https://developers.klaviyo.com/en/v2026-01-15/reference/query_form_series)
|
|
3610
3644
|
|
|
3611
3645
|
```ruby
|
|
3612
3646
|
KlaviyoAPI::Reporting.query_form_series(body)
|
|
@@ -3624,7 +3658,7 @@ KlaviyoAPI::Reporting.create_form_series_report(body)
|
|
|
3624
3658
|
|
|
3625
3659
|
|
|
3626
3660
|
|
|
3627
|
-
#### [Query Form Values](https://developers.klaviyo.com/en/
|
|
3661
|
+
#### [Query Form Values](https://developers.klaviyo.com/en/v2026-01-15/reference/query_form_values)
|
|
3628
3662
|
|
|
3629
3663
|
```ruby
|
|
3630
3664
|
KlaviyoAPI::Reporting.query_form_values(body)
|
|
@@ -3642,7 +3676,7 @@ KlaviyoAPI::Reporting.create_form_values_report(body)
|
|
|
3642
3676
|
|
|
3643
3677
|
|
|
3644
3678
|
|
|
3645
|
-
#### [Query Segment Series](https://developers.klaviyo.com/en/
|
|
3679
|
+
#### [Query Segment Series](https://developers.klaviyo.com/en/v2026-01-15/reference/query_segment_series)
|
|
3646
3680
|
|
|
3647
3681
|
```ruby
|
|
3648
3682
|
KlaviyoAPI::Reporting.query_segment_series(body)
|
|
@@ -3660,7 +3694,7 @@ KlaviyoAPI::Reporting.create_segment_series_report(body)
|
|
|
3660
3694
|
|
|
3661
3695
|
|
|
3662
3696
|
|
|
3663
|
-
#### [Query Segment Values](https://developers.klaviyo.com/en/
|
|
3697
|
+
#### [Query Segment Values](https://developers.klaviyo.com/en/v2026-01-15/reference/query_segment_values)
|
|
3664
3698
|
|
|
3665
3699
|
```ruby
|
|
3666
3700
|
KlaviyoAPI::Reporting.query_segment_values(body)
|
|
@@ -3682,7 +3716,7 @@ KlaviyoAPI::Reporting.create_segment_values_report(body)
|
|
|
3682
3716
|
## Reviews
|
|
3683
3717
|
|
|
3684
3718
|
|
|
3685
|
-
#### [Get Review](https://developers.klaviyo.com/en/
|
|
3719
|
+
#### [Get Review](https://developers.klaviyo.com/en/v2026-01-15/reference/get_review)
|
|
3686
3720
|
|
|
3687
3721
|
```ruby
|
|
3688
3722
|
KlaviyoAPI::Reviews.get_review(id, opts)
|
|
@@ -3692,7 +3726,7 @@ KlaviyoAPI::Reviews.get_review(id, opts)
|
|
|
3692
3726
|
|
|
3693
3727
|
|
|
3694
3728
|
|
|
3695
|
-
#### [Get Reviews](https://developers.klaviyo.com/en/
|
|
3729
|
+
#### [Get Reviews](https://developers.klaviyo.com/en/v2026-01-15/reference/get_reviews)
|
|
3696
3730
|
|
|
3697
3731
|
```ruby
|
|
3698
3732
|
KlaviyoAPI::Reviews.get_reviews(opts)
|
|
@@ -3702,7 +3736,7 @@ KlaviyoAPI::Reviews.get_reviews(opts)
|
|
|
3702
3736
|
|
|
3703
3737
|
|
|
3704
3738
|
|
|
3705
|
-
#### [Update Review](https://developers.klaviyo.com/en/
|
|
3739
|
+
#### [Update Review](https://developers.klaviyo.com/en/v2026-01-15/reference/update_review)
|
|
3706
3740
|
|
|
3707
3741
|
```ruby
|
|
3708
3742
|
KlaviyoAPI::Reviews.update_review(id, body)
|
|
@@ -3716,7 +3750,7 @@ KlaviyoAPI::Reviews.update_review(id, body)
|
|
|
3716
3750
|
## Segments
|
|
3717
3751
|
|
|
3718
3752
|
|
|
3719
|
-
#### [Create Segment](https://developers.klaviyo.com/en/
|
|
3753
|
+
#### [Create Segment](https://developers.klaviyo.com/en/v2026-01-15/reference/create_segment)
|
|
3720
3754
|
|
|
3721
3755
|
```ruby
|
|
3722
3756
|
KlaviyoAPI::Segments.create_segment(body)
|
|
@@ -3726,7 +3760,7 @@ KlaviyoAPI::Segments.create_segment(body)
|
|
|
3726
3760
|
|
|
3727
3761
|
|
|
3728
3762
|
|
|
3729
|
-
#### [Delete Segment](https://developers.klaviyo.com/en/
|
|
3763
|
+
#### [Delete Segment](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_segment)
|
|
3730
3764
|
|
|
3731
3765
|
```ruby
|
|
3732
3766
|
KlaviyoAPI::Segments.delete_segment(id)
|
|
@@ -3736,7 +3770,7 @@ KlaviyoAPI::Segments.delete_segment(id)
|
|
|
3736
3770
|
|
|
3737
3771
|
|
|
3738
3772
|
|
|
3739
|
-
#### [Get Flows Triggered by Segment](https://developers.klaviyo.com/en/
|
|
3773
|
+
#### [Get Flows Triggered by Segment](https://developers.klaviyo.com/en/v2026-01-15/reference/get_flows_triggered_by_segment)
|
|
3740
3774
|
|
|
3741
3775
|
```ruby
|
|
3742
3776
|
KlaviyoAPI::Segments.get_flows_triggered_by_segment(id, opts)
|
|
@@ -3754,7 +3788,7 @@ KlaviyoAPI::Segments.get_segment_flow_triggers(id, opts)
|
|
|
3754
3788
|
|
|
3755
3789
|
|
|
3756
3790
|
|
|
3757
|
-
#### [Get IDs for Flows Triggered by Segment](https://developers.klaviyo.com/en/
|
|
3791
|
+
#### [Get IDs for Flows Triggered by Segment](https://developers.klaviyo.com/en/v2026-01-15/reference/get_ids_for_flows_triggered_by_segment)
|
|
3758
3792
|
|
|
3759
3793
|
```ruby
|
|
3760
3794
|
KlaviyoAPI::Segments.get_ids_for_flows_triggered_by_segment(id)
|
|
@@ -3772,7 +3806,7 @@ KlaviyoAPI::Segments.get_segment_relationships_flow_triggers(id)
|
|
|
3772
3806
|
|
|
3773
3807
|
|
|
3774
3808
|
|
|
3775
|
-
#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/
|
|
3809
|
+
#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2026-01-15/reference/get_profile_ids_for_segment)
|
|
3776
3810
|
|
|
3777
3811
|
```ruby
|
|
3778
3812
|
KlaviyoAPI::Segments.get_profile_ids_for_segment(id, opts)
|
|
@@ -3786,7 +3820,7 @@ KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
|
|
|
3786
3820
|
|
|
3787
3821
|
|
|
3788
3822
|
|
|
3789
|
-
#### [Get Profiles for Segment](https://developers.klaviyo.com/en/
|
|
3823
|
+
#### [Get Profiles for Segment](https://developers.klaviyo.com/en/v2026-01-15/reference/get_profiles_for_segment)
|
|
3790
3824
|
|
|
3791
3825
|
```ruby
|
|
3792
3826
|
KlaviyoAPI::Segments.get_profiles_for_segment(id, opts)
|
|
@@ -3800,7 +3834,7 @@ KlaviyoAPI::Segments.get_segment_profiles(id, opts)
|
|
|
3800
3834
|
|
|
3801
3835
|
|
|
3802
3836
|
|
|
3803
|
-
#### [Get Segment](https://developers.klaviyo.com/en/
|
|
3837
|
+
#### [Get Segment](https://developers.klaviyo.com/en/v2026-01-15/reference/get_segment)
|
|
3804
3838
|
|
|
3805
3839
|
```ruby
|
|
3806
3840
|
KlaviyoAPI::Segments.get_segment(id, opts)
|
|
@@ -3810,7 +3844,7 @@ KlaviyoAPI::Segments.get_segment(id, opts)
|
|
|
3810
3844
|
|
|
3811
3845
|
|
|
3812
3846
|
|
|
3813
|
-
#### [Get Segments](https://developers.klaviyo.com/en/
|
|
3847
|
+
#### [Get Segments](https://developers.klaviyo.com/en/v2026-01-15/reference/get_segments)
|
|
3814
3848
|
|
|
3815
3849
|
```ruby
|
|
3816
3850
|
KlaviyoAPI::Segments.get_segments(opts)
|
|
@@ -3820,7 +3854,7 @@ KlaviyoAPI::Segments.get_segments(opts)
|
|
|
3820
3854
|
|
|
3821
3855
|
|
|
3822
3856
|
|
|
3823
|
-
#### [Get Tag IDs for Segment](https://developers.klaviyo.com/en/
|
|
3857
|
+
#### [Get Tag IDs for Segment](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tag_ids_for_segment)
|
|
3824
3858
|
|
|
3825
3859
|
```ruby
|
|
3826
3860
|
KlaviyoAPI::Segments.get_tag_ids_for_segment(id)
|
|
@@ -3834,7 +3868,7 @@ KlaviyoAPI::Segments.get_segment_relationships_tags(id)
|
|
|
3834
3868
|
|
|
3835
3869
|
|
|
3836
3870
|
|
|
3837
|
-
#### [Get Tags for Segment](https://developers.klaviyo.com/en/
|
|
3871
|
+
#### [Get Tags for Segment](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tags_for_segment)
|
|
3838
3872
|
|
|
3839
3873
|
```ruby
|
|
3840
3874
|
KlaviyoAPI::Segments.get_tags_for_segment(id, opts)
|
|
@@ -3848,7 +3882,7 @@ KlaviyoAPI::Segments.get_segment_tags(id, opts)
|
|
|
3848
3882
|
|
|
3849
3883
|
|
|
3850
3884
|
|
|
3851
|
-
#### [Update Segment](https://developers.klaviyo.com/en/
|
|
3885
|
+
#### [Update Segment](https://developers.klaviyo.com/en/v2026-01-15/reference/update_segment)
|
|
3852
3886
|
|
|
3853
3887
|
```ruby
|
|
3854
3888
|
KlaviyoAPI::Segments.update_segment(id, body)
|
|
@@ -3862,7 +3896,7 @@ KlaviyoAPI::Segments.update_segment(id, body)
|
|
|
3862
3896
|
## Tags
|
|
3863
3897
|
|
|
3864
3898
|
|
|
3865
|
-
#### [Create Tag](https://developers.klaviyo.com/en/
|
|
3899
|
+
#### [Create Tag](https://developers.klaviyo.com/en/v2026-01-15/reference/create_tag)
|
|
3866
3900
|
|
|
3867
3901
|
```ruby
|
|
3868
3902
|
KlaviyoAPI::Tags.create_tag(body)
|
|
@@ -3872,7 +3906,7 @@ KlaviyoAPI::Tags.create_tag(body)
|
|
|
3872
3906
|
|
|
3873
3907
|
|
|
3874
3908
|
|
|
3875
|
-
#### [Create Tag Group](https://developers.klaviyo.com/en/
|
|
3909
|
+
#### [Create Tag Group](https://developers.klaviyo.com/en/v2026-01-15/reference/create_tag_group)
|
|
3876
3910
|
|
|
3877
3911
|
```ruby
|
|
3878
3912
|
KlaviyoAPI::Tags.create_tag_group(body)
|
|
@@ -3882,7 +3916,7 @@ KlaviyoAPI::Tags.create_tag_group(body)
|
|
|
3882
3916
|
|
|
3883
3917
|
|
|
3884
3918
|
|
|
3885
|
-
#### [Delete Tag](https://developers.klaviyo.com/en/
|
|
3919
|
+
#### [Delete Tag](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_tag)
|
|
3886
3920
|
|
|
3887
3921
|
```ruby
|
|
3888
3922
|
KlaviyoAPI::Tags.delete_tag(id)
|
|
@@ -3892,7 +3926,7 @@ KlaviyoAPI::Tags.delete_tag(id)
|
|
|
3892
3926
|
|
|
3893
3927
|
|
|
3894
3928
|
|
|
3895
|
-
#### [Delete Tag Group](https://developers.klaviyo.com/en/
|
|
3929
|
+
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_tag_group)
|
|
3896
3930
|
|
|
3897
3931
|
```ruby
|
|
3898
3932
|
KlaviyoAPI::Tags.delete_tag_group(id)
|
|
@@ -3902,7 +3936,7 @@ KlaviyoAPI::Tags.delete_tag_group(id)
|
|
|
3902
3936
|
|
|
3903
3937
|
|
|
3904
3938
|
|
|
3905
|
-
#### [Get Campaign IDs for Tag](https://developers.klaviyo.com/en/
|
|
3939
|
+
#### [Get Campaign IDs for Tag](https://developers.klaviyo.com/en/v2026-01-15/reference/get_campaign_ids_for_tag)
|
|
3906
3940
|
|
|
3907
3941
|
```ruby
|
|
3908
3942
|
KlaviyoAPI::Tags.get_campaign_ids_for_tag(id)
|
|
@@ -3916,7 +3950,7 @@ KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
|
|
|
3916
3950
|
|
|
3917
3951
|
|
|
3918
3952
|
|
|
3919
|
-
#### [Get Flow IDs for Tag](https://developers.klaviyo.com/en/
|
|
3953
|
+
#### [Get Flow IDs for Tag](https://developers.klaviyo.com/en/v2026-01-15/reference/get_flow_ids_for_tag)
|
|
3920
3954
|
|
|
3921
3955
|
```ruby
|
|
3922
3956
|
KlaviyoAPI::Tags.get_flow_ids_for_tag(id)
|
|
@@ -3930,7 +3964,7 @@ KlaviyoAPI::Tags.get_tag_relationships_flows(id)
|
|
|
3930
3964
|
|
|
3931
3965
|
|
|
3932
3966
|
|
|
3933
|
-
#### [Get List IDs for Tag](https://developers.klaviyo.com/en/
|
|
3967
|
+
#### [Get List IDs for Tag](https://developers.klaviyo.com/en/v2026-01-15/reference/get_list_ids_for_tag)
|
|
3934
3968
|
|
|
3935
3969
|
```ruby
|
|
3936
3970
|
KlaviyoAPI::Tags.get_list_ids_for_tag(id)
|
|
@@ -3944,7 +3978,7 @@ KlaviyoAPI::Tags.get_tag_relationships_lists(id)
|
|
|
3944
3978
|
|
|
3945
3979
|
|
|
3946
3980
|
|
|
3947
|
-
#### [Get Segment IDs for Tag](https://developers.klaviyo.com/en/
|
|
3981
|
+
#### [Get Segment IDs for Tag](https://developers.klaviyo.com/en/v2026-01-15/reference/get_segment_ids_for_tag)
|
|
3948
3982
|
|
|
3949
3983
|
```ruby
|
|
3950
3984
|
KlaviyoAPI::Tags.get_segment_ids_for_tag(id)
|
|
@@ -3958,7 +3992,7 @@ KlaviyoAPI::Tags.get_tag_relationships_segments(id)
|
|
|
3958
3992
|
|
|
3959
3993
|
|
|
3960
3994
|
|
|
3961
|
-
#### [Get Tag](https://developers.klaviyo.com/en/
|
|
3995
|
+
#### [Get Tag](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tag)
|
|
3962
3996
|
|
|
3963
3997
|
```ruby
|
|
3964
3998
|
KlaviyoAPI::Tags.get_tag(id, opts)
|
|
@@ -3968,7 +4002,7 @@ KlaviyoAPI::Tags.get_tag(id, opts)
|
|
|
3968
4002
|
|
|
3969
4003
|
|
|
3970
4004
|
|
|
3971
|
-
#### [Get Tag Group](https://developers.klaviyo.com/en/
|
|
4005
|
+
#### [Get Tag Group](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tag_group)
|
|
3972
4006
|
|
|
3973
4007
|
```ruby
|
|
3974
4008
|
KlaviyoAPI::Tags.get_tag_group(id, opts)
|
|
@@ -3978,7 +4012,7 @@ KlaviyoAPI::Tags.get_tag_group(id, opts)
|
|
|
3978
4012
|
|
|
3979
4013
|
|
|
3980
4014
|
|
|
3981
|
-
#### [Get Tag Group for Tag](https://developers.klaviyo.com/en/
|
|
4015
|
+
#### [Get Tag Group for Tag](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tag_group_for_tag)
|
|
3982
4016
|
|
|
3983
4017
|
```ruby
|
|
3984
4018
|
KlaviyoAPI::Tags.get_tag_group_for_tag(id, opts)
|
|
@@ -3996,7 +4030,7 @@ KlaviyoAPI::Tags.get_group_for_tag(id, opts)
|
|
|
3996
4030
|
|
|
3997
4031
|
|
|
3998
4032
|
|
|
3999
|
-
#### [Get Tag Group ID for Tag](https://developers.klaviyo.com/en/
|
|
4033
|
+
#### [Get Tag Group ID for Tag](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tag_group_id_for_tag)
|
|
4000
4034
|
|
|
4001
4035
|
```ruby
|
|
4002
4036
|
KlaviyoAPI::Tags.get_tag_group_id_for_tag(id)
|
|
@@ -4018,7 +4052,7 @@ KlaviyoAPI::Tags.get_tag_relationships_group(id)
|
|
|
4018
4052
|
|
|
4019
4053
|
|
|
4020
4054
|
|
|
4021
|
-
#### [Get Tag Groups](https://developers.klaviyo.com/en/
|
|
4055
|
+
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tag_groups)
|
|
4022
4056
|
|
|
4023
4057
|
```ruby
|
|
4024
4058
|
KlaviyoAPI::Tags.get_tag_groups(opts)
|
|
@@ -4028,7 +4062,7 @@ KlaviyoAPI::Tags.get_tag_groups(opts)
|
|
|
4028
4062
|
|
|
4029
4063
|
|
|
4030
4064
|
|
|
4031
|
-
#### [Get Tag IDs for Tag Group](https://developers.klaviyo.com/en/
|
|
4065
|
+
#### [Get Tag IDs for Tag Group](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tag_ids_for_tag_group)
|
|
4032
4066
|
|
|
4033
4067
|
```ruby
|
|
4034
4068
|
KlaviyoAPI::Tags.get_tag_ids_for_tag_group(id)
|
|
@@ -4042,7 +4076,7 @@ KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
|
|
|
4042
4076
|
|
|
4043
4077
|
|
|
4044
4078
|
|
|
4045
|
-
#### [Get Tags](https://developers.klaviyo.com/en/
|
|
4079
|
+
#### [Get Tags](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tags)
|
|
4046
4080
|
|
|
4047
4081
|
```ruby
|
|
4048
4082
|
KlaviyoAPI::Tags.get_tags(opts)
|
|
@@ -4052,7 +4086,7 @@ KlaviyoAPI::Tags.get_tags(opts)
|
|
|
4052
4086
|
|
|
4053
4087
|
|
|
4054
4088
|
|
|
4055
|
-
#### [Get Tags for Tag Group](https://developers.klaviyo.com/en/
|
|
4089
|
+
#### [Get Tags for Tag Group](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tags_for_tag_group)
|
|
4056
4090
|
|
|
4057
4091
|
```ruby
|
|
4058
4092
|
KlaviyoAPI::Tags.get_tags_for_tag_group(id, opts)
|
|
@@ -4066,7 +4100,7 @@ KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
|
|
|
4066
4100
|
|
|
4067
4101
|
|
|
4068
4102
|
|
|
4069
|
-
#### [Remove Tag from Campaigns](https://developers.klaviyo.com/en/
|
|
4103
|
+
#### [Remove Tag from Campaigns](https://developers.klaviyo.com/en/v2026-01-15/reference/remove_tag_from_campaigns)
|
|
4070
4104
|
|
|
4071
4105
|
```ruby
|
|
4072
4106
|
KlaviyoAPI::Tags.remove_tag_from_campaigns(id, body)
|
|
@@ -4084,7 +4118,7 @@ KlaviyoAPI::Tags.remove_campaigns_from_tag(id, body)
|
|
|
4084
4118
|
|
|
4085
4119
|
|
|
4086
4120
|
|
|
4087
|
-
#### [Remove Tag from Flows](https://developers.klaviyo.com/en/
|
|
4121
|
+
#### [Remove Tag from Flows](https://developers.klaviyo.com/en/v2026-01-15/reference/remove_tag_from_flows)
|
|
4088
4122
|
|
|
4089
4123
|
```ruby
|
|
4090
4124
|
KlaviyoAPI::Tags.remove_tag_from_flows(id, body)
|
|
@@ -4102,7 +4136,7 @@ KlaviyoAPI::Tags.remove_flows_from_tag(id, body)
|
|
|
4102
4136
|
|
|
4103
4137
|
|
|
4104
4138
|
|
|
4105
|
-
#### [Remove Tag from Lists](https://developers.klaviyo.com/en/
|
|
4139
|
+
#### [Remove Tag from Lists](https://developers.klaviyo.com/en/v2026-01-15/reference/remove_tag_from_lists)
|
|
4106
4140
|
|
|
4107
4141
|
```ruby
|
|
4108
4142
|
KlaviyoAPI::Tags.remove_tag_from_lists(id, body)
|
|
@@ -4120,7 +4154,7 @@ KlaviyoAPI::Tags.remove_lists_from_tag(id, body)
|
|
|
4120
4154
|
|
|
4121
4155
|
|
|
4122
4156
|
|
|
4123
|
-
#### [Remove Tag from Segments](https://developers.klaviyo.com/en/
|
|
4157
|
+
#### [Remove Tag from Segments](https://developers.klaviyo.com/en/v2026-01-15/reference/remove_tag_from_segments)
|
|
4124
4158
|
|
|
4125
4159
|
```ruby
|
|
4126
4160
|
KlaviyoAPI::Tags.remove_tag_from_segments(id, body)
|
|
@@ -4138,7 +4172,7 @@ KlaviyoAPI::Tags.remove_segments_from_tag(id, body)
|
|
|
4138
4172
|
|
|
4139
4173
|
|
|
4140
4174
|
|
|
4141
|
-
#### [Tag Campaigns](https://developers.klaviyo.com/en/
|
|
4175
|
+
#### [Tag Campaigns](https://developers.klaviyo.com/en/v2026-01-15/reference/tag_campaigns)
|
|
4142
4176
|
|
|
4143
4177
|
```ruby
|
|
4144
4178
|
KlaviyoAPI::Tags.tag_campaigns(id, body)
|
|
@@ -4160,7 +4194,7 @@ KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
|
|
|
4160
4194
|
|
|
4161
4195
|
|
|
4162
4196
|
|
|
4163
|
-
#### [Tag Flows](https://developers.klaviyo.com/en/
|
|
4197
|
+
#### [Tag Flows](https://developers.klaviyo.com/en/v2026-01-15/reference/tag_flows)
|
|
4164
4198
|
|
|
4165
4199
|
```ruby
|
|
4166
4200
|
KlaviyoAPI::Tags.tag_flows(id, body)
|
|
@@ -4182,7 +4216,7 @@ KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
|
|
|
4182
4216
|
|
|
4183
4217
|
|
|
4184
4218
|
|
|
4185
|
-
#### [Tag Lists](https://developers.klaviyo.com/en/
|
|
4219
|
+
#### [Tag Lists](https://developers.klaviyo.com/en/v2026-01-15/reference/tag_lists)
|
|
4186
4220
|
|
|
4187
4221
|
```ruby
|
|
4188
4222
|
KlaviyoAPI::Tags.tag_lists(id, body)
|
|
@@ -4204,7 +4238,7 @@ KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
|
|
|
4204
4238
|
|
|
4205
4239
|
|
|
4206
4240
|
|
|
4207
|
-
#### [Tag Segments](https://developers.klaviyo.com/en/
|
|
4241
|
+
#### [Tag Segments](https://developers.klaviyo.com/en/v2026-01-15/reference/tag_segments)
|
|
4208
4242
|
|
|
4209
4243
|
```ruby
|
|
4210
4244
|
KlaviyoAPI::Tags.tag_segments(id, body)
|
|
@@ -4226,7 +4260,7 @@ KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
|
|
|
4226
4260
|
|
|
4227
4261
|
|
|
4228
4262
|
|
|
4229
|
-
#### [Update Tag](https://developers.klaviyo.com/en/
|
|
4263
|
+
#### [Update Tag](https://developers.klaviyo.com/en/v2026-01-15/reference/update_tag)
|
|
4230
4264
|
|
|
4231
4265
|
```ruby
|
|
4232
4266
|
KlaviyoAPI::Tags.update_tag(id, body)
|
|
@@ -4236,7 +4270,7 @@ KlaviyoAPI::Tags.update_tag(id, body)
|
|
|
4236
4270
|
|
|
4237
4271
|
|
|
4238
4272
|
|
|
4239
|
-
#### [Update Tag Group](https://developers.klaviyo.com/en/
|
|
4273
|
+
#### [Update Tag Group](https://developers.klaviyo.com/en/v2026-01-15/reference/update_tag_group)
|
|
4240
4274
|
|
|
4241
4275
|
```ruby
|
|
4242
4276
|
KlaviyoAPI::Tags.update_tag_group(id, body)
|
|
@@ -4250,7 +4284,7 @@ KlaviyoAPI::Tags.update_tag_group(id, body)
|
|
|
4250
4284
|
## Templates
|
|
4251
4285
|
|
|
4252
4286
|
|
|
4253
|
-
#### [Clone Template](https://developers.klaviyo.com/en/
|
|
4287
|
+
#### [Clone Template](https://developers.klaviyo.com/en/v2026-01-15/reference/clone_template)
|
|
4254
4288
|
|
|
4255
4289
|
```ruby
|
|
4256
4290
|
KlaviyoAPI::Templates.clone_template(body)
|
|
@@ -4264,7 +4298,7 @@ KlaviyoAPI::Templates.create_template_clone(body)
|
|
|
4264
4298
|
|
|
4265
4299
|
|
|
4266
4300
|
|
|
4267
|
-
#### [Create Template](https://developers.klaviyo.com/en/
|
|
4301
|
+
#### [Create Template](https://developers.klaviyo.com/en/v2026-01-15/reference/create_template)
|
|
4268
4302
|
|
|
4269
4303
|
```ruby
|
|
4270
4304
|
KlaviyoAPI::Templates.create_template(body)
|
|
@@ -4274,7 +4308,7 @@ KlaviyoAPI::Templates.create_template(body)
|
|
|
4274
4308
|
|
|
4275
4309
|
|
|
4276
4310
|
|
|
4277
|
-
#### [Create Universal Content](https://developers.klaviyo.com/en/
|
|
4311
|
+
#### [Create Universal Content](https://developers.klaviyo.com/en/v2026-01-15/reference/create_universal_content)
|
|
4278
4312
|
|
|
4279
4313
|
```ruby
|
|
4280
4314
|
KlaviyoAPI::Templates.create_universal_content(body)
|
|
@@ -4288,7 +4322,7 @@ KlaviyoAPI::Templates.create_template_universal_content(body)
|
|
|
4288
4322
|
|
|
4289
4323
|
|
|
4290
4324
|
|
|
4291
|
-
#### [Delete Template](https://developers.klaviyo.com/en/
|
|
4325
|
+
#### [Delete Template](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_template)
|
|
4292
4326
|
|
|
4293
4327
|
```ruby
|
|
4294
4328
|
KlaviyoAPI::Templates.delete_template(id)
|
|
@@ -4298,7 +4332,7 @@ KlaviyoAPI::Templates.delete_template(id)
|
|
|
4298
4332
|
|
|
4299
4333
|
|
|
4300
4334
|
|
|
4301
|
-
#### [Delete Universal Content](https://developers.klaviyo.com/en/
|
|
4335
|
+
#### [Delete Universal Content](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_universal_content)
|
|
4302
4336
|
|
|
4303
4337
|
```ruby
|
|
4304
4338
|
KlaviyoAPI::Templates.delete_universal_content(id)
|
|
@@ -4312,7 +4346,7 @@ KlaviyoAPI::Templates.delete_template_universal_content(id)
|
|
|
4312
4346
|
|
|
4313
4347
|
|
|
4314
4348
|
|
|
4315
|
-
#### [Get All Universal Content](https://developers.klaviyo.com/en/
|
|
4349
|
+
#### [Get All Universal Content](https://developers.klaviyo.com/en/v2026-01-15/reference/get_all_universal_content)
|
|
4316
4350
|
|
|
4317
4351
|
```ruby
|
|
4318
4352
|
KlaviyoAPI::Templates.get_all_universal_content(opts)
|
|
@@ -4326,7 +4360,7 @@ KlaviyoAPI::Templates.get_template_universal_content(opts)
|
|
|
4326
4360
|
|
|
4327
4361
|
|
|
4328
4362
|
|
|
4329
|
-
#### [Get Template](https://developers.klaviyo.com/en/
|
|
4363
|
+
#### [Get Template](https://developers.klaviyo.com/en/v2026-01-15/reference/get_template)
|
|
4330
4364
|
|
|
4331
4365
|
```ruby
|
|
4332
4366
|
KlaviyoAPI::Templates.get_template(id, opts)
|
|
@@ -4336,7 +4370,7 @@ KlaviyoAPI::Templates.get_template(id, opts)
|
|
|
4336
4370
|
|
|
4337
4371
|
|
|
4338
4372
|
|
|
4339
|
-
#### [Get Templates](https://developers.klaviyo.com/en/
|
|
4373
|
+
#### [Get Templates](https://developers.klaviyo.com/en/v2026-01-15/reference/get_templates)
|
|
4340
4374
|
|
|
4341
4375
|
```ruby
|
|
4342
4376
|
KlaviyoAPI::Templates.get_templates(opts)
|
|
@@ -4346,7 +4380,7 @@ KlaviyoAPI::Templates.get_templates(opts)
|
|
|
4346
4380
|
|
|
4347
4381
|
|
|
4348
4382
|
|
|
4349
|
-
#### [Get Universal Content](https://developers.klaviyo.com/en/
|
|
4383
|
+
#### [Get Universal Content](https://developers.klaviyo.com/en/v2026-01-15/reference/get_universal_content)
|
|
4350
4384
|
|
|
4351
4385
|
```ruby
|
|
4352
4386
|
KlaviyoAPI::Templates.get_universal_content(id, opts)
|
|
@@ -4356,7 +4390,7 @@ KlaviyoAPI::Templates.get_universal_content(id, opts)
|
|
|
4356
4390
|
|
|
4357
4391
|
|
|
4358
4392
|
|
|
4359
|
-
#### [Render Template](https://developers.klaviyo.com/en/
|
|
4393
|
+
#### [Render Template](https://developers.klaviyo.com/en/v2026-01-15/reference/render_template)
|
|
4360
4394
|
|
|
4361
4395
|
```ruby
|
|
4362
4396
|
KlaviyoAPI::Templates.render_template(body)
|
|
@@ -4370,7 +4404,7 @@ KlaviyoAPI::Templates.create_template_render(body)
|
|
|
4370
4404
|
|
|
4371
4405
|
|
|
4372
4406
|
|
|
4373
|
-
#### [Update Template](https://developers.klaviyo.com/en/
|
|
4407
|
+
#### [Update Template](https://developers.klaviyo.com/en/v2026-01-15/reference/update_template)
|
|
4374
4408
|
|
|
4375
4409
|
```ruby
|
|
4376
4410
|
KlaviyoAPI::Templates.update_template(id, body)
|
|
@@ -4380,7 +4414,7 @@ KlaviyoAPI::Templates.update_template(id, body)
|
|
|
4380
4414
|
|
|
4381
4415
|
|
|
4382
4416
|
|
|
4383
|
-
#### [Update Universal Content](https://developers.klaviyo.com/en/
|
|
4417
|
+
#### [Update Universal Content](https://developers.klaviyo.com/en/v2026-01-15/reference/update_universal_content)
|
|
4384
4418
|
|
|
4385
4419
|
```ruby
|
|
4386
4420
|
KlaviyoAPI::Templates.update_universal_content(id, body)
|
|
@@ -4398,7 +4432,7 @@ KlaviyoAPI::Templates.update_template_universal_content(id, body)
|
|
|
4398
4432
|
## Tracking Settings
|
|
4399
4433
|
|
|
4400
4434
|
|
|
4401
|
-
#### [Get Tracking Setting](https://developers.klaviyo.com/en/
|
|
4435
|
+
#### [Get Tracking Setting](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tracking_setting)
|
|
4402
4436
|
|
|
4403
4437
|
```ruby
|
|
4404
4438
|
KlaviyoAPI::TrackingSettings.get_tracking_setting(id, opts)
|
|
@@ -4408,7 +4442,7 @@ KlaviyoAPI::TrackingSettings.get_tracking_setting(id, opts)
|
|
|
4408
4442
|
|
|
4409
4443
|
|
|
4410
4444
|
|
|
4411
|
-
#### [Get Tracking Settings](https://developers.klaviyo.com/en/
|
|
4445
|
+
#### [Get Tracking Settings](https://developers.klaviyo.com/en/v2026-01-15/reference/get_tracking_settings)
|
|
4412
4446
|
|
|
4413
4447
|
```ruby
|
|
4414
4448
|
KlaviyoAPI::TrackingSettings.get_tracking_settings(opts)
|
|
@@ -4418,7 +4452,7 @@ KlaviyoAPI::TrackingSettings.get_tracking_settings(opts)
|
|
|
4418
4452
|
|
|
4419
4453
|
|
|
4420
4454
|
|
|
4421
|
-
#### [Update Tracking Setting](https://developers.klaviyo.com/en/
|
|
4455
|
+
#### [Update Tracking Setting](https://developers.klaviyo.com/en/v2026-01-15/reference/update_tracking_setting)
|
|
4422
4456
|
|
|
4423
4457
|
```ruby
|
|
4424
4458
|
KlaviyoAPI::TrackingSettings.update_tracking_setting(id, body)
|
|
@@ -4432,7 +4466,7 @@ KlaviyoAPI::TrackingSettings.update_tracking_setting(id, body)
|
|
|
4432
4466
|
## Web Feeds
|
|
4433
4467
|
|
|
4434
4468
|
|
|
4435
|
-
#### [Create Web Feed](https://developers.klaviyo.com/en/
|
|
4469
|
+
#### [Create Web Feed](https://developers.klaviyo.com/en/v2026-01-15/reference/create_web_feed)
|
|
4436
4470
|
|
|
4437
4471
|
```ruby
|
|
4438
4472
|
KlaviyoAPI::WebFeeds.create_web_feed(body)
|
|
@@ -4442,7 +4476,7 @@ KlaviyoAPI::WebFeeds.create_web_feed(body)
|
|
|
4442
4476
|
|
|
4443
4477
|
|
|
4444
4478
|
|
|
4445
|
-
#### [Delete Web Feed](https://developers.klaviyo.com/en/
|
|
4479
|
+
#### [Delete Web Feed](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_web_feed)
|
|
4446
4480
|
|
|
4447
4481
|
```ruby
|
|
4448
4482
|
KlaviyoAPI::WebFeeds.delete_web_feed(id)
|
|
@@ -4452,7 +4486,7 @@ KlaviyoAPI::WebFeeds.delete_web_feed(id)
|
|
|
4452
4486
|
|
|
4453
4487
|
|
|
4454
4488
|
|
|
4455
|
-
#### [Get Web Feed](https://developers.klaviyo.com/en/
|
|
4489
|
+
#### [Get Web Feed](https://developers.klaviyo.com/en/v2026-01-15/reference/get_web_feed)
|
|
4456
4490
|
|
|
4457
4491
|
```ruby
|
|
4458
4492
|
KlaviyoAPI::WebFeeds.get_web_feed(id, opts)
|
|
@@ -4462,7 +4496,7 @@ KlaviyoAPI::WebFeeds.get_web_feed(id, opts)
|
|
|
4462
4496
|
|
|
4463
4497
|
|
|
4464
4498
|
|
|
4465
|
-
#### [Get Web Feeds](https://developers.klaviyo.com/en/
|
|
4499
|
+
#### [Get Web Feeds](https://developers.klaviyo.com/en/v2026-01-15/reference/get_web_feeds)
|
|
4466
4500
|
|
|
4467
4501
|
```ruby
|
|
4468
4502
|
KlaviyoAPI::WebFeeds.get_web_feeds(opts)
|
|
@@ -4472,7 +4506,7 @@ KlaviyoAPI::WebFeeds.get_web_feeds(opts)
|
|
|
4472
4506
|
|
|
4473
4507
|
|
|
4474
4508
|
|
|
4475
|
-
#### [Update Web Feed](https://developers.klaviyo.com/en/
|
|
4509
|
+
#### [Update Web Feed](https://developers.klaviyo.com/en/v2026-01-15/reference/update_web_feed)
|
|
4476
4510
|
|
|
4477
4511
|
```ruby
|
|
4478
4512
|
KlaviyoAPI::WebFeeds.update_web_feed(id, body)
|
|
@@ -4486,7 +4520,7 @@ KlaviyoAPI::WebFeeds.update_web_feed(id, body)
|
|
|
4486
4520
|
## Webhooks
|
|
4487
4521
|
|
|
4488
4522
|
|
|
4489
|
-
#### [Create Webhook](https://developers.klaviyo.com/en/
|
|
4523
|
+
#### [Create Webhook](https://developers.klaviyo.com/en/v2026-01-15/reference/create_webhook)
|
|
4490
4524
|
|
|
4491
4525
|
```ruby
|
|
4492
4526
|
KlaviyoAPI::Webhooks.create_webhook(body)
|
|
@@ -4496,7 +4530,7 @@ KlaviyoAPI::Webhooks.create_webhook(body)
|
|
|
4496
4530
|
|
|
4497
4531
|
|
|
4498
4532
|
|
|
4499
|
-
#### [Delete Webhook](https://developers.klaviyo.com/en/
|
|
4533
|
+
#### [Delete Webhook](https://developers.klaviyo.com/en/v2026-01-15/reference/delete_webhook)
|
|
4500
4534
|
|
|
4501
4535
|
```ruby
|
|
4502
4536
|
KlaviyoAPI::Webhooks.delete_webhook(id)
|
|
@@ -4506,7 +4540,7 @@ KlaviyoAPI::Webhooks.delete_webhook(id)
|
|
|
4506
4540
|
|
|
4507
4541
|
|
|
4508
4542
|
|
|
4509
|
-
#### [Get Webhook](https://developers.klaviyo.com/en/
|
|
4543
|
+
#### [Get Webhook](https://developers.klaviyo.com/en/v2026-01-15/reference/get_webhook)
|
|
4510
4544
|
|
|
4511
4545
|
```ruby
|
|
4512
4546
|
KlaviyoAPI::Webhooks.get_webhook(id, opts)
|
|
@@ -4516,7 +4550,7 @@ KlaviyoAPI::Webhooks.get_webhook(id, opts)
|
|
|
4516
4550
|
|
|
4517
4551
|
|
|
4518
4552
|
|
|
4519
|
-
#### [Get Webhook Topic](https://developers.klaviyo.com/en/
|
|
4553
|
+
#### [Get Webhook Topic](https://developers.klaviyo.com/en/v2026-01-15/reference/get_webhook_topic)
|
|
4520
4554
|
|
|
4521
4555
|
```ruby
|
|
4522
4556
|
KlaviyoAPI::Webhooks.get_webhook_topic(id)
|
|
@@ -4526,7 +4560,7 @@ KlaviyoAPI::Webhooks.get_webhook_topic(id)
|
|
|
4526
4560
|
|
|
4527
4561
|
|
|
4528
4562
|
|
|
4529
|
-
#### [Get Webhook Topics](https://developers.klaviyo.com/en/
|
|
4563
|
+
#### [Get Webhook Topics](https://developers.klaviyo.com/en/v2026-01-15/reference/get_webhook_topics)
|
|
4530
4564
|
|
|
4531
4565
|
```ruby
|
|
4532
4566
|
KlaviyoAPI::Webhooks.get_webhook_topics
|
|
@@ -4536,7 +4570,7 @@ KlaviyoAPI::Webhooks.get_webhook_topics
|
|
|
4536
4570
|
|
|
4537
4571
|
|
|
4538
4572
|
|
|
4539
|
-
#### [Get Webhooks](https://developers.klaviyo.com/en/
|
|
4573
|
+
#### [Get Webhooks](https://developers.klaviyo.com/en/v2026-01-15/reference/get_webhooks)
|
|
4540
4574
|
|
|
4541
4575
|
```ruby
|
|
4542
4576
|
KlaviyoAPI::Webhooks.get_webhooks(opts)
|
|
@@ -4546,7 +4580,7 @@ KlaviyoAPI::Webhooks.get_webhooks(opts)
|
|
|
4546
4580
|
|
|
4547
4581
|
|
|
4548
4582
|
|
|
4549
|
-
#### [Update Webhook](https://developers.klaviyo.com/en/
|
|
4583
|
+
#### [Update Webhook](https://developers.klaviyo.com/en/v2026-01-15/reference/update_webhook)
|
|
4550
4584
|
|
|
4551
4585
|
```ruby
|
|
4552
4586
|
KlaviyoAPI::Webhooks.update_webhook(id, body)
|