klaviyo-api-sdk 18.0.0 → 19.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 +44 -0
- data/README.md +1525 -459
- data/klaviyo-api-sdk.gemspec +2 -2
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -6
- data/lib/klaviyo-api-sdk/api/billing_api.rb +162 -0
- data/lib/klaviyo-api-sdk/api/brands_api.rb +1933 -0
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +3298 -653
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +265 -265
- data/lib/klaviyo-api-sdk/api/client_api.rb +9 -13
- data/lib/klaviyo-api-sdk/api/conversations_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +80 -80
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +120 -117
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/events_api.rb +39 -39
- data/lib/klaviyo-api-sdk/api/flows_api.rb +190 -113
- data/lib/klaviyo-api-sdk/api/forms_api.rb +292 -43
- data/lib/klaviyo-api-sdk/api/images_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api/lists_api.rb +64 -64
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +94 -94
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +163 -163
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +27 -27
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +23 -23
- data/lib/klaviyo-api-sdk/api/segments_api.rb +58 -58
- data/lib/klaviyo-api-sdk/api/tags_api.rb +62 -62
- data/lib/klaviyo-api-sdk/api/templates_api.rb +236 -76
- data/lib/klaviyo-api-sdk/api/text_messaging_api.rb +774 -0
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +11 -11
- data/lib/klaviyo-api-sdk/api/translations_api.rb +1102 -0
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +19 -19
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +27 -27
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/{push_on_open_app.rb → ab_test_action_link_only.rb} +23 -9
- data/lib/klaviyo-api-sdk/models/{sms_message_definition_create.rb → ab_test_settings.rb} +36 -35
- data/lib/klaviyo-api-sdk/models/action_output_split_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/address.rb +295 -0
- data/lib/klaviyo-api-sdk/models/age_gate_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/age_gate_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{dynamic_tracking_param.rb → animation.rb} +56 -44
- data/lib/klaviyo-api-sdk/models/api_schema_property.rb +2 -2
- data/lib/klaviyo-api-sdk/models/audience_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object.rb → audience_clone_query_resource_object.rb} +7 -7
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_clone_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes.rb → audience_create_query_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{html_block_data_v0.rb → audience_create_query_resource_object_relationships.rb} +19 -24
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages.rb +220 -0
- data/lib/klaviyo-api-sdk/models/audience_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{audiences_update.rb → audience_definition.rb} +32 -10
- data/lib/klaviyo-api-sdk/models/audience_inline_create.rb +261 -0
- data/lib/klaviyo-api-sdk/models/audience_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/audience_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query_resource_object_attributes.rb → audience_update_query_resource_object_attributes.rb} +4 -5
- data/lib/klaviyo-api-sdk/models/back_in_stock_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/back_in_stock_email_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/border_styles.rb +297 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_button_create_query_resource_object_attributes.rb +298 -0
- data/lib/klaviyo-api-sdk/models/brand_button_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_button_partial_update_query_resource_object_attributes.rb +275 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_color_create_query_resource_object_attributes.rb +233 -0
- data/lib/klaviyo-api-sdk/models/brand_color_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_color_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options.rb → brand_email_body_patch_attributes.rb} +68 -38
- data/lib/klaviyo-api-sdk/models/brand_email_default_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object.rb +261 -0
- data/lib/klaviyo-api-sdk/models/{audiences.rb → brand_email_default_partial_update_query_resource_object_attributes.rb} +25 -28
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships.rb +236 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_button.rb +218 -0
- data/lib/klaviyo-api-sdk/models/{content_repeat_v0.rb → brand_email_default_partial_update_query_resource_object_relationships_brand_button_data.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_logo_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_query_resource_object_relationships_brand_social_group.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_email_default_partial_update_rels_brand_social_group_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_email_footer_patch_attributes.rb +283 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_content_update.rb → brand_email_header_patch_attributes.rb} +36 -38
- data/lib/klaviyo-api-sdk/models/brand_library_button_styles.rb +262 -0
- data/lib/klaviyo-api-sdk/models/brand_library_text_styles.rb +368 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_options_badge.rb → brand_library_text_styles_letter_spacing.rb} +3 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object.rb → brand_logo_create_query_resource_object.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_attributes.rb +264 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships.rb → brand_logo_create_query_resource_object_relationships.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image.rb +218 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_create_query_resource_object_relationships_image_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query.rb → brand_logo_partial_update_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object.rb +261 -0
- data/lib/klaviyo-api-sdk/models/brand_logo_partial_update_query_resource_object_attributes.rb +259 -0
- data/lib/klaviyo-api-sdk/models/brand_social_group_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object.rb → brand_social_group_create_query_resource_object.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/brand_social_group_create_query_resource_object_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_badge_badge_options.rb → brand_social_group_create_query_resource_object_attributes_social_links_inner.rb} +3 -5
- data/lib/klaviyo-api-sdk/models/brand_social_group_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query.rb → brand_social_group_partial_update_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query_resource_object.rb → brand_social_group_partial_update_query_resource_object.rb} +6 -6
- data/lib/klaviyo-api-sdk/models/brand_social_group_partial_update_query_resource_object_attributes.rb +231 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_descriptor.rb +248 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/brand_voice_partial_update_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/button_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/button_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/button_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/campaign_audience_clone_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_audience_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_clone_query_resource_object_attributes.rb +9 -9
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_attributes.rb +30 -63
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships.rb +236 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_audiences_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_campaign_messages_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags.rb +220 -0
- data/lib/klaviyo-api-sdk/models/campaign_create_query_resource_object_relationships_tags_data_inner.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{push_action_button_definition.rb → campaign_definition.rb} +56 -44
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_attributes.rb +298 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_query_resource_object_relationships_campaign_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_message_schedule_update_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/{non_local_static_send.rb → campaign_message_schedule_update_query_resource_object_attributes.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes.rb +12 -48
- data/lib/klaviyo-api-sdk/models/campaign_schedule_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_attributes.rb +226 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/campaign_schedule_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/campaign_tracking_setting_dynamic_param.rb +2 -2
- data/lib/klaviyo-api-sdk/models/campaign_variation_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/checkboxes_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/checkboxes_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{mobile_push_no_badge.rb → click_tracking_subscription_parameters.rb} +22 -22
- data/lib/klaviyo-api-sdk/models/{campaign_message_increment.rb → click_tracking_unsubscription_parameters.rb} +22 -21
- data/lib/klaviyo-api-sdk/models/close_button_style.rb +49 -4
- data/lib/klaviyo-api-sdk/models/{push_on_open_web_url.rb → code_action_link_only.rb} +17 -14
- data/lib/klaviyo-api-sdk/models/color.rb +237 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/consent_page_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/content_experiment_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{push_on_open_deep_link.rb → continue_with_shop.rb} +29 -22
- data/lib/klaviyo-api-sdk/models/{text_block_data_v0.rb → continue_with_shop_autofill.rb} +50 -37
- data/lib/klaviyo-api-sdk/models/continue_with_shop_phone_consent.rb +262 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_update.rb → continue_with_shop_properties.rb} +76 -59
- data/lib/klaviyo-api-sdk/models/continue_with_shop_styles.rb +298 -0
- data/lib/klaviyo-api-sdk/models/conversation_message_create_query_resource_object_attributes.rb +17 -4
- data/lib/klaviyo-api-sdk/models/countdown_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/countdown_timer_properties.rb +33 -1
- data/lib/klaviyo-api-sdk/models/{horizontal_rule_block_v0.rb → coupon_assigner_configuration.rb} +40 -48
- data/lib/klaviyo-api-sdk/models/coupon_block_data.rb +1 -5
- data/lib/klaviyo-api-sdk/models/coupon_create_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/coupon_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/coupon_update_query_resource_object_attributes.rb +14 -5
- data/lib/klaviyo-api-sdk/models/custom_html_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger.rb +11 -1
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger_trigger_filter.rb +225 -0
- data/lib/klaviyo-api-sdk/models/custom_object_date_trigger_trigger_filter_condition_groups_inner.rb +225 -0
- data/lib/klaviyo-api-sdk/models/{local_static_send.rb → custom_social_link.rb} +72 -31
- data/lib/klaviyo-api-sdk/models/customer_hub_block_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object.rb +5 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_attributes.rb +5 -1
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships.rb +5 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_create_job_create_query_resource_object.rb +5 -0
- data/lib/klaviyo-api-sdk/models/date_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/date_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/dropdown_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/dropdown_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{mobile_push_badge.rb → dynamic_sms_image.rb} +29 -28
- data/lib/klaviyo-api-sdk/models/{email_content.rb → email_channel_details.rb} +97 -42
- data/lib/klaviyo-api-sdk/models/{push_send_options.rb → email_header_link.rb} +29 -14
- data/lib/klaviyo-api-sdk/models/email_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/email_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/email_subscription_parameters.rb +13 -4
- data/lib/klaviyo-api-sdk/models/email_unsubscription_parameters.rb +13 -4
- data/lib/klaviyo-api-sdk/models/enroll_form_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/event_profile_create_query_resource_object_attributes.rb +5 -14
- data/lib/klaviyo-api-sdk/models/{smart_send_time_strategy.rb → first_party_social_link.rb} +30 -31
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/flow_action_anchor_query_resource_object_attributes_definition.rb +126 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes.rb +245 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_campaign_messages.rb → flow_action_insert_query_resource_object_attributes_anchor_action.rb} +6 -8
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_attributes_definition.rb +124 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow.rb +218 -0
- data/lib/klaviyo-api-sdk/models/flow_action_insert_query_resource_object_relationships_flow_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/flow_action_update_query_resource_object_attributes_definition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_definition_actions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_message_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_sms.rb +2 -2
- data/lib/klaviyo-api-sdk/models/{mobile_push_options_on_open.rb → flow_sms_message_hierarchy_inner.rb} +3 -4
- data/lib/klaviyo-api-sdk/models/flow_whats_app.rb +25 -5
- data/lib/klaviyo-api-sdk/models/{campaigns_sms_tracking_options.rb → flow_whats_app_with_ac.rb} +86 -16
- data/lib/klaviyo-api-sdk/models/form_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/form_partial_update_query_resource_object_attributes.rb +229 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form.rb +218 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_create_query_resource_object_relationships_form_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/form_publish_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships_image.rb → form_unpublish_job_create_query_resource_object_relationships_form.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_relationships_image_data.rb → form_unpublish_job_create_query_resource_object_relationships_form_data.rb} +5 -5
- data/lib/klaviyo-api-sdk/models/form_unpublish_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/html_text_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/iaf_deeplink_to_screen_properties.rb +36 -4
- data/lib/klaviyo-api-sdk/models/{html_block_v0.rb → iaf_open_url.rb} +42 -34
- data/lib/klaviyo-api-sdk/models/{sms_content_create.rb → iaf_open_url_properties.rb} +12 -12
- data/lib/klaviyo-api-sdk/models/image_action.rb +1 -0
- data/lib/klaviyo-api-sdk/models/image_asset.rb +409 -0
- data/lib/klaviyo-api-sdk/models/image_block_styles.rb +11 -1
- data/lib/klaviyo-api-sdk/models/image_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{throttled_send_strategy.rb → inline_message_schedule.rb} +69 -55
- data/lib/klaviyo-api-sdk/models/input_style_overrides.rb +307 -0
- data/lib/klaviyo-api-sdk/models/internal_service_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/link_text_styles.rb +352 -0
- data/lib/klaviyo-api-sdk/models/{campaigns_email_tracking_options_custom_tracking_params_inner.rb → link_text_styles_letter_spacing.rb} +3 -3
- data/lib/klaviyo-api-sdk/models/list_update_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox.rb +291 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_properties.rb +372 -0
- data/lib/klaviyo-api-sdk/models/marketing_tracking_consent_checkbox_styles.rb +283 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_static_count.rb → marketing_tracking_consent_configuration.rb} +31 -30
- data/lib/klaviyo-api-sdk/models/media_asset.rb +318 -0
- data/lib/klaviyo-api-sdk/models/media_asset_reference.rb +240 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object.rb +266 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/message_clone_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_attributes.rb +236 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships.rb +237 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_audience_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/message_create_query_resource_object_relationships_campaign_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/{static_send_strategy.rb → message_definition.rb} +52 -42
- data/lib/klaviyo-api-sdk/models/{text_block_v0.rb → message_hierarchy_rcs_item.rb} +56 -57
- data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item.rb +301 -0
- data/lib/klaviyo-api-sdk/models/message_hierarchy_sms_item_image.rb +105 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_tracking_options.rb → message_hierarchy_sms_item_media.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{block_display_options.rb → message_inline_create.rb} +64 -33
- data/lib/klaviyo-api-sdk/models/message_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/message_partial_update_query_resource_object_attributes.rb +218 -0
- data/lib/klaviyo-api-sdk/models/message_send_options.rb +344 -0
- data/lib/klaviyo-api-sdk/models/message_tracking_options.rb +239 -0
- data/lib/klaviyo-api-sdk/models/{static_tracking_param.rb → multi_branch_split_action_link_only.rb} +15 -32
- data/lib/klaviyo-api-sdk/models/multi_branch_split_action_link_only_data.rb +225 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_branch_filter_condition_groups_inner_conditions_inner.rb +4 -0
- data/lib/klaviyo-api-sdk/models/multi_branch_split_branch_link_only.rb +237 -0
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object.rb +1 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/opt_in_code_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/phone_number_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/phone_number_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/profile_event_tracked_properties.rb +15 -5
- data/lib/klaviyo-api-sdk/models/profile_has_custom_object_filter_filter.rb +2 -0
- data/lib/klaviyo-api-sdk/models/profile_metric_property_filter.rb +5 -1
- data/lib/klaviyo-api-sdk/models/profile_permissions_condition.rb +2 -2
- data/lib/klaviyo-api-sdk/models/profile_property_condition.rb +1 -0
- data/lib/klaviyo-api-sdk/models/push_action_button_v0.rb +322 -0
- data/lib/klaviyo-api-sdk/models/{push_action_button.rb → push_action_button_v2.rb} +28 -8
- data/lib/klaviyo-api-sdk/models/push_channel_details.rb +512 -0
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object.rb +13 -4
- data/lib/klaviyo-api-sdk/models/push_profile_upsert_query_resource_object_attributes.rb +1 -10
- data/lib/klaviyo-api-sdk/models/radio_buttons_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/radio_buttons_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/rcs_card.rb +290 -0
- data/lib/klaviyo-api-sdk/models/rcs_card_image.rb +105 -0
- data/lib/klaviyo-api-sdk/models/rcs_card_video.rb +105 -0
- data/lib/klaviyo-api-sdk/models/{sms_send_options.rb → rcs_rich_content.rb} +36 -14
- data/lib/klaviyo-api-sdk/models/{spacer_block_v0.rb → rcs_suggestion.rb} +63 -34
- data/lib/klaviyo-api-sdk/models/review_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/review_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/row_v0_blocks_inner.rb +2 -0
- data/lib/klaviyo-api-sdk/models/send_email_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_internal_alert_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_push_notification_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_settings.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_sms_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_webhook_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{image_block_v0.rb → send_whats_app_with_ac_action.rb} +35 -31
- data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_data.rb +264 -0
- data/lib/klaviyo-api-sdk/models/send_whats_app_with_ac_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/signup_counter_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/slim_image_reference.rb +242 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_update.rb → sms_channel_details.rb} +135 -34
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/sms_consent_checkbox_styles.rb +10 -1
- data/lib/klaviyo-api-sdk/models/sms_disclosure_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{render_options.rb → spacing_styles.rb} +48 -40
- data/lib/klaviyo-api-sdk/models/spin_to_win_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/static_sms_image.rb +270 -0
- data/lib/klaviyo-api-sdk/models/target_date_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{campaign_message_partial_update_query.rb → template_preview_send_job_create_query.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_attributes.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_options.rb → template_preview_send_job_create_query_resource_object_relationships.rb} +21 -31
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile.rb +218 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_profile_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template.rb +218 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_create_query_resource_object_relationships_template_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/template_preview_send_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_create_query_resource_object_attributes.rb +224 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_configuration_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_attrs_text_messaging_sender_registration.rb +224 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_standard_definition_create.rb → text_messaging_sender_create_query_resource_object_attributes.rb} +50 -68
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_attributes.rb +440 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender.rb +218 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_create_rels_text_messaging_sender_data.rb +237 -0
- data/lib/klaviyo-api-sdk/models/text_messaging_sender_registration_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/text_properties.rb +10 -1
- data/lib/klaviyo-api-sdk/models/{button_block_v0.rb → text_style_overrides.rb} +54 -53
- data/lib/klaviyo-api-sdk/models/text_style_overrides_font_family.rb +103 -0
- data/lib/klaviyo-api-sdk/models/text_styles.rb +14 -5
- data/lib/klaviyo-api-sdk/models/{campaign_message_property.rb → throttled_options.rb} +31 -32
- data/lib/klaviyo-api-sdk/models/time_delay_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/{email_send_options.rb → timezone_options.rb} +13 -13
- data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/toll_free_registration_details_resource_object_attributes.rb +440 -0
- data/lib/klaviyo-api-sdk/models/{immediate_send_strategy.rb → toll_free_sender_details.rb} +22 -21
- data/lib/klaviyo-api-sdk/models/translation_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_message_silent_definition_create.rb → translation_create_query_resource_object_attributes.rb} +54 -41
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships.rb +254 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_campaign_variation_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_consent_page_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_flow_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content.rb +218 -0
- data/lib/klaviyo-api-sdk/models/translation_create_query_resource_object_relationships_template_universal_content_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/translation_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/translation_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/translation_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{mobile_push_content_create.rb → translation_partial_update_query_resource_object_attributes.rb} +39 -41
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/universal_content_clone_query_resource_object_attributes.rb +235 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_v1_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_create_query_resource_object_attributes.rb → universal_content_create_query_v1_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_strategy.rb → universal_content_create_query_v1_resource_object_attributes_definition.rb} +17 -6
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1.rb +223 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_v1_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/{universal_content_partial_update_query_resource_object_attributes.rb → universal_content_partial_update_query_v1_resource_object_attributes.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/{campaign_message_create_query_resource_object_attributes_definition.rb → universal_content_partial_update_query_v1_resource_object_attributes_definition.rb} +18 -5
- data/lib/klaviyo-api-sdk/models/update_profile_action_link_only.rb +271 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object.rb +251 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message.rb +218 -0
- data/lib/klaviyo-api-sdk/models/variation_create_query_resource_object_relationships_campaign_message_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/variation_definition.rb +230 -0
- data/lib/klaviyo-api-sdk/models/{campaign_create_query_resource_object_attributes_send_options.rb → variation_definition_details.rb} +6 -5
- data/lib/klaviyo-api-sdk/models/variation_inline_create.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/variation_partial_update_query_resource_object.rb +252 -0
- data/lib/klaviyo-api-sdk/models/verified_badge_style.rb +266 -0
- data/lib/klaviyo-api-sdk/models/{email_message_definition.rb → whatsapp_channel_details.rb} +23 -25
- data/lib/klaviyo-api-sdk.rb +305 -78
- data/lib/klaviyo-api-sdk.rb.bak +306 -79
- metadata +315 -82
- data/lib/klaviyo-api-sdk/models/campaign_message_partial_update_query_resource_object_attributes_definition.rb +0 -107
- data/lib/klaviyo-api-sdk/models/campaign_partial_update_query_resource_object_attributes_send_strategy.rb +0 -107
- data/lib/klaviyo-api-sdk/models/drop_shadow_block_v0.rb +0 -293
- data/lib/klaviyo-api-sdk/models/onsite_profile_create_query_resource_object_attributes.rb +0 -349
- data/lib/klaviyo-api-sdk/models/static_send_strategy_options.rb +0 -105
- data/lib/klaviyo-api-sdk/models/text_block_styles_v0.rb +0 -533
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +0 -109
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +0 -109
data/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# Klaviyo Ruby SDK
|
|
2
2
|
|
|
3
|
-
- SDK version:
|
|
4
|
-
- API revision: 2026-
|
|
3
|
+
- SDK version: 19.0.0
|
|
4
|
+
- API revision: 2026-10-15
|
|
5
5
|
|
|
6
6
|
## Helpful Resources
|
|
7
7
|
|
|
8
|
-
- [API Reference](https://developers.klaviyo.com/en/v2026-
|
|
9
|
-
- [API Guides](https://developers.klaviyo.com/en/v2026-
|
|
8
|
+
- [API Reference](https://developers.klaviyo.com/en/v2026-10-15/reference)
|
|
9
|
+
- [API Guides](https://developers.klaviyo.com/en/v2026-10-15/docs)
|
|
10
10
|
- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)
|
|
11
11
|
|
|
12
12
|
## Design & Approach
|
|
@@ -23,6 +23,14 @@ This SDK is organized into the following resources:
|
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
26
|
+
- Billing
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
- Brands
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
26
34
|
- Campaigns
|
|
27
35
|
|
|
28
36
|
|
|
@@ -99,10 +107,18 @@ This SDK is organized into the following resources:
|
|
|
99
107
|
|
|
100
108
|
|
|
101
109
|
|
|
110
|
+
- Text Messaging
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
102
114
|
- Tracking Settings
|
|
103
115
|
|
|
104
116
|
|
|
105
117
|
|
|
118
|
+
- Translations
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
106
122
|
- Web Feeds
|
|
107
123
|
|
|
108
124
|
|
|
@@ -126,13 +142,13 @@ gem build klaviyo-api-sdk.gemspec
|
|
|
126
142
|
Then install the gem locally:
|
|
127
143
|
|
|
128
144
|
```shell
|
|
129
|
-
gem install ./klaviyo-api-sdk-
|
|
145
|
+
gem install ./klaviyo-api-sdk-19.0.0.gem
|
|
130
146
|
```
|
|
131
147
|
|
|
132
148
|
|
|
133
149
|
Finally add this to the Gemfile:
|
|
134
150
|
|
|
135
|
-
gem 'klaviyo-api-sdk', '~>
|
|
151
|
+
gem 'klaviyo-api-sdk', '~> 19.0.0'
|
|
136
152
|
|
|
137
153
|
To install directly from rubygems:
|
|
138
154
|
|
|
@@ -446,407 +462,1087 @@ pp(response[:data])
|
|
|
446
462
|
pp(response[:included])
|
|
447
463
|
```
|
|
448
464
|
|
|
449
|
-
*Note about sparse fields and relationships:* you can request only specific fields of the included object as well.
|
|
465
|
+
*Note about sparse fields and relationships:* you can request only specific fields of the included object as well.
|
|
466
|
+
|
|
467
|
+
```ruby
|
|
468
|
+
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
|
|
469
|
+
opts = {
|
|
470
|
+
fields_list: ["name"],
|
|
471
|
+
include: ["lists"]
|
|
472
|
+
}
|
|
473
|
+
|
|
474
|
+
response = KlaviyoAPI::Profiles.get_profile(profile_id,opts)
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
# Profile information is accessed the same way with
|
|
479
|
+
pp(response[:data])
|
|
480
|
+
# Lists related to the profile with be accessible via the included array
|
|
481
|
+
pp(response[:included])
|
|
482
|
+
```
|
|
483
|
+
|
|
484
|
+
### Relationships
|
|
485
|
+
|
|
486
|
+
The Klaviyo Api has a series of endpoints to expose the relationships between your different Klaviyo Items. You can read more about relationships in [our documentation](https://developers.klaviyo.com/en/v2023-02-22/docs/relationships_).
|
|
487
|
+
|
|
488
|
+
Here are some use cases and their examples:
|
|
489
|
+
|
|
490
|
+
How to get the list memberships for a profile with the given profile ID.
|
|
491
|
+
|
|
492
|
+
Via the URL:
|
|
493
|
+
|
|
494
|
+
```
|
|
495
|
+
https://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/relationships/lists/
|
|
496
|
+
```
|
|
497
|
+
|
|
498
|
+
and for the SDK:
|
|
499
|
+
|
|
500
|
+
```ruby
|
|
501
|
+
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
|
|
502
|
+
|
|
503
|
+
response = KlaviyoAPI::Profiles.get_profile_relationships_lists(profile_id)
|
|
504
|
+
```
|
|
505
|
+
|
|
506
|
+
For another example:
|
|
507
|
+
|
|
508
|
+
Get all campaigns associated with the given `tag_id`.
|
|
509
|
+
|
|
510
|
+
the URL:
|
|
511
|
+
|
|
512
|
+
```
|
|
513
|
+
https://a.klaviyo.com/api/tags/9c8db7a0-5ab5-4e3c-9a37-a3224fd14382/relationships/campaigns/
|
|
514
|
+
```
|
|
515
|
+
|
|
516
|
+
Through the SDK:
|
|
517
|
+
|
|
518
|
+
```ruby
|
|
519
|
+
tag_id = '9c8db7a0-5ab5-4e3c-9a37-a3224fd14382'
|
|
520
|
+
|
|
521
|
+
response = KlaviyoAPI::Tags.get_tag_relationships_campaigns(tag_id)
|
|
522
|
+
```
|
|
523
|
+
### Combining
|
|
524
|
+
|
|
525
|
+
You can use any combination of the features outlines above in conjunction with one another.
|
|
526
|
+
|
|
527
|
+
#### Get events associated with a specific metric, then return just the event properties sorted by oldest to newest datetime.
|
|
528
|
+
|
|
529
|
+
```
|
|
530
|
+
https://a.klaviyo.com/api/events/?fields[event]=event_properties&filter=equals(metric_id,"URDbLg")&sort=-datetime
|
|
531
|
+
```
|
|
532
|
+
or
|
|
533
|
+
```ruby
|
|
534
|
+
opts = {
|
|
535
|
+
filter: 'equals(metric_id,"URDbLg")',
|
|
536
|
+
fields_event: ["event_properties"]
|
|
537
|
+
}
|
|
538
|
+
|
|
539
|
+
response = KlaviyoAPI::Events.get_events(opts)
|
|
540
|
+
```
|
|
541
|
+
|
|
542
|
+
## Comprehensive list of Operations & Parameters
|
|
543
|
+
|
|
544
|
+
_**NOTE:**_
|
|
545
|
+
- 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-10-15/reference/get_events).
|
|
546
|
+
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
|
547
|
+
- Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
## Accounts
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
#### [Get Account](https://developers.klaviyo.com/en/v2026-10-15/reference/get_account)
|
|
558
|
+
|
|
559
|
+
```ruby
|
|
560
|
+
KlaviyoAPI::Accounts.get_account(id, opts)
|
|
561
|
+
```
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
#### [Get Accounts](https://developers.klaviyo.com/en/v2026-10-15/reference/get_accounts)
|
|
568
|
+
|
|
569
|
+
```ruby
|
|
570
|
+
KlaviyoAPI::Accounts.get_accounts(opts)
|
|
571
|
+
```
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
## Billing
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
#### [Get Billing Usage](https://developers.klaviyo.com/en/v2026-10-15/reference/get_billing_usage)
|
|
582
|
+
|
|
583
|
+
```ruby
|
|
584
|
+
KlaviyoAPI::Billing.get_billing_usage(id, opts)
|
|
585
|
+
```
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
#### [List Billing Usage](https://developers.klaviyo.com/en/v2026-10-15/reference/list_billing_usage)
|
|
592
|
+
|
|
593
|
+
```ruby
|
|
594
|
+
KlaviyoAPI::Billing.list_billing_usage(opts)
|
|
595
|
+
```
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
## Brands
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
#### [Create Brand Button](https://developers.klaviyo.com/en/v2026-10-15/reference/create_brand_button)
|
|
606
|
+
|
|
607
|
+
```ruby
|
|
608
|
+
KlaviyoAPI::Brands.create_brand_button(body, opts)
|
|
609
|
+
```
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
#### [Create Brand Color](https://developers.klaviyo.com/en/v2026-10-15/reference/create_brand_color)
|
|
616
|
+
|
|
617
|
+
```ruby
|
|
618
|
+
KlaviyoAPI::Brands.create_brand_color(body, opts)
|
|
619
|
+
```
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
#### [Create Brand Logo](https://developers.klaviyo.com/en/v2026-10-15/reference/create_brand_logo)
|
|
626
|
+
|
|
627
|
+
```ruby
|
|
628
|
+
KlaviyoAPI::Brands.create_brand_logo(body, opts)
|
|
629
|
+
```
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
#### [Create Brand Social Group](https://developers.klaviyo.com/en/v2026-10-15/reference/create_brand_social_group)
|
|
636
|
+
|
|
637
|
+
```ruby
|
|
638
|
+
KlaviyoAPI::Brands.create_brand_social_group(body, opts)
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
#### [Delete Brand Button](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_brand_button)
|
|
646
|
+
|
|
647
|
+
```ruby
|
|
648
|
+
KlaviyoAPI::Brands.delete_brand_button(id)
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
#### [Delete Brand Color](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_brand_color)
|
|
656
|
+
|
|
657
|
+
```ruby
|
|
658
|
+
KlaviyoAPI::Brands.delete_brand_color(id)
|
|
659
|
+
```
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
#### [Delete Brand Logo](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_brand_logo)
|
|
666
|
+
|
|
667
|
+
```ruby
|
|
668
|
+
KlaviyoAPI::Brands.delete_brand_logo(id)
|
|
669
|
+
```
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
#### [Delete Brand Social Group](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_brand_social_group)
|
|
676
|
+
|
|
677
|
+
```ruby
|
|
678
|
+
KlaviyoAPI::Brands.delete_brand_social_group(id)
|
|
679
|
+
```
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
#### [Get Brand Button](https://developers.klaviyo.com/en/v2026-10-15/reference/get_brand_button)
|
|
686
|
+
|
|
687
|
+
```ruby
|
|
688
|
+
KlaviyoAPI::Brands.get_brand_button(id, opts)
|
|
689
|
+
```
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
#### [Get Brand Buttons](https://developers.klaviyo.com/en/v2026-10-15/reference/get_brand_buttons)
|
|
696
|
+
|
|
697
|
+
```ruby
|
|
698
|
+
KlaviyoAPI::Brands.get_brand_buttons(opts)
|
|
699
|
+
```
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
#### [Get Brand Color](https://developers.klaviyo.com/en/v2026-10-15/reference/get_brand_color)
|
|
706
|
+
|
|
707
|
+
```ruby
|
|
708
|
+
KlaviyoAPI::Brands.get_brand_color(id, opts)
|
|
709
|
+
```
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
#### [Get Brand Colors](https://developers.klaviyo.com/en/v2026-10-15/reference/get_brand_colors)
|
|
716
|
+
|
|
717
|
+
```ruby
|
|
718
|
+
KlaviyoAPI::Brands.get_brand_colors(opts)
|
|
719
|
+
```
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
#### [Get Brand Email Default](https://developers.klaviyo.com/en/v2026-10-15/reference/get_brand_email_default)
|
|
726
|
+
|
|
727
|
+
```ruby
|
|
728
|
+
KlaviyoAPI::Brands.get_brand_email_default(id, opts)
|
|
729
|
+
```
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
#### [Get Brand Email Defaults](https://developers.klaviyo.com/en/v2026-10-15/reference/get_brand_email_defaults)
|
|
736
|
+
|
|
737
|
+
```ruby
|
|
738
|
+
KlaviyoAPI::Brands.get_brand_email_defaults(opts)
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
#### [Get Brand Logo](https://developers.klaviyo.com/en/v2026-10-15/reference/get_brand_logo)
|
|
746
|
+
|
|
747
|
+
```ruby
|
|
748
|
+
KlaviyoAPI::Brands.get_brand_logo(id, opts)
|
|
749
|
+
```
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
#### [Get Brand Logos](https://developers.klaviyo.com/en/v2026-10-15/reference/get_brand_logos)
|
|
756
|
+
|
|
757
|
+
```ruby
|
|
758
|
+
KlaviyoAPI::Brands.get_brand_logos(opts)
|
|
759
|
+
```
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
#### [Get Brand Social Group](https://developers.klaviyo.com/en/v2026-10-15/reference/get_brand_social_group)
|
|
766
|
+
|
|
767
|
+
```ruby
|
|
768
|
+
KlaviyoAPI::Brands.get_brand_social_group(id, opts)
|
|
769
|
+
```
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
#### [Get Brand Social Groups](https://developers.klaviyo.com/en/v2026-10-15/reference/get_brand_social_groups)
|
|
776
|
+
|
|
777
|
+
```ruby
|
|
778
|
+
KlaviyoAPI::Brands.get_brand_social_groups(opts)
|
|
779
|
+
```
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
#### [Get Brand Voice](https://developers.klaviyo.com/en/v2026-10-15/reference/get_brand_voice)
|
|
786
|
+
|
|
787
|
+
```ruby
|
|
788
|
+
KlaviyoAPI::Brands.get_brand_voice(id, opts)
|
|
789
|
+
```
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
#### [Update Brand Button](https://developers.klaviyo.com/en/v2026-10-15/reference/update_brand_button)
|
|
796
|
+
|
|
797
|
+
```ruby
|
|
798
|
+
KlaviyoAPI::Brands.update_brand_button(id, body, opts)
|
|
799
|
+
```
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
#### [Update Brand Color](https://developers.klaviyo.com/en/v2026-10-15/reference/update_brand_color)
|
|
806
|
+
|
|
807
|
+
```ruby
|
|
808
|
+
KlaviyoAPI::Brands.update_brand_color(id, body, opts)
|
|
809
|
+
```
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
#### [Update Brand Email Default](https://developers.klaviyo.com/en/v2026-10-15/reference/update_brand_email_default)
|
|
816
|
+
|
|
817
|
+
```ruby
|
|
818
|
+
KlaviyoAPI::Brands.update_brand_email_default(id, body, opts)
|
|
819
|
+
```
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
#### [Update Brand Logo](https://developers.klaviyo.com/en/v2026-10-15/reference/update_brand_logo)
|
|
826
|
+
|
|
827
|
+
```ruby
|
|
828
|
+
KlaviyoAPI::Brands.update_brand_logo(id, body, opts)
|
|
829
|
+
```
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
#### [Update Brand Social Group](https://developers.klaviyo.com/en/v2026-10-15/reference/update_brand_social_group)
|
|
836
|
+
|
|
837
|
+
```ruby
|
|
838
|
+
KlaviyoAPI::Brands.update_brand_social_group(id, body, opts)
|
|
839
|
+
```
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
#### [Update Brand Voice](https://developers.klaviyo.com/en/v2026-10-15/reference/update_brand_voice)
|
|
846
|
+
|
|
847
|
+
```ruby
|
|
848
|
+
KlaviyoAPI::Brands.update_brand_voice(id, body, opts)
|
|
849
|
+
```
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
## Campaigns
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
#### [Assign Template to Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/assign_template_to_campaign_message)
|
|
860
|
+
|
|
861
|
+
```ruby
|
|
862
|
+
KlaviyoAPI::Campaigns.assign_template_to_campaign_message(body, opts)
|
|
863
|
+
```
|
|
864
|
+
##### Method alias:
|
|
865
|
+
```ruby
|
|
866
|
+
KlaviyoAPI::Campaigns.create_campaign_message_assign_template(body, opts)
|
|
867
|
+
```
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
#### [Cancel Campaign Send](https://developers.klaviyo.com/en/v2026-10-15/reference/cancel_campaign_send)
|
|
874
|
+
|
|
875
|
+
```ruby
|
|
876
|
+
KlaviyoAPI::Campaigns.cancel_campaign_send(id, body)
|
|
877
|
+
```
|
|
878
|
+
##### Method alias:
|
|
879
|
+
```ruby
|
|
880
|
+
KlaviyoAPI::Campaigns.update_campaign_send_job(id, body)
|
|
881
|
+
```
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
#### [Clone Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/clone_campaign)
|
|
888
|
+
|
|
889
|
+
```ruby
|
|
890
|
+
KlaviyoAPI::Campaigns.clone_campaign(body, opts)
|
|
891
|
+
```
|
|
892
|
+
##### Method alias:
|
|
893
|
+
```ruby
|
|
894
|
+
KlaviyoAPI::Campaigns.create_campaign_clone(body, opts)
|
|
895
|
+
```
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
#### [Clone Campaign Audience](https://developers.klaviyo.com/en/v2026-10-15/reference/clone_campaign_audience)
|
|
902
|
+
|
|
903
|
+
```ruby
|
|
904
|
+
KlaviyoAPI::Campaigns.clone_campaign_audience(body, opts)
|
|
905
|
+
```
|
|
906
|
+
##### Method alias:
|
|
907
|
+
```ruby
|
|
908
|
+
KlaviyoAPI::Campaigns.create_campaign_audience_clone(body, opts)
|
|
909
|
+
```
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
#### [Clone Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/clone_campaign_message)
|
|
916
|
+
|
|
917
|
+
```ruby
|
|
918
|
+
KlaviyoAPI::Campaigns.clone_campaign_message(body, opts)
|
|
919
|
+
```
|
|
920
|
+
##### Method alias:
|
|
921
|
+
```ruby
|
|
922
|
+
KlaviyoAPI::Campaigns.create_campaign_message_clone(body, opts)
|
|
923
|
+
```
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
#### [Create Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/create_campaign)
|
|
930
|
+
|
|
931
|
+
```ruby
|
|
932
|
+
KlaviyoAPI::Campaigns.create_campaign(body, opts)
|
|
933
|
+
```
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
#### [Create Campaign Audience](https://developers.klaviyo.com/en/v2026-10-15/reference/create_campaign_audience)
|
|
940
|
+
|
|
941
|
+
```ruby
|
|
942
|
+
KlaviyoAPI::Campaigns.create_campaign_audience(body, opts)
|
|
943
|
+
```
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
#### [Create Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/create_campaign_message)
|
|
950
|
+
|
|
951
|
+
```ruby
|
|
952
|
+
KlaviyoAPI::Campaigns.create_campaign_message(body, opts)
|
|
953
|
+
```
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
#### [Create Campaign Variation](https://developers.klaviyo.com/en/v2026-10-15/reference/create_campaign_variation)
|
|
960
|
+
|
|
961
|
+
```ruby
|
|
962
|
+
KlaviyoAPI::Campaigns.create_campaign_variation(body, opts)
|
|
963
|
+
```
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
#### [Delete Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_campaign)
|
|
970
|
+
|
|
971
|
+
```ruby
|
|
972
|
+
KlaviyoAPI::Campaigns.delete_campaign(id)
|
|
973
|
+
```
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
#### [Delete Campaign Audience](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_campaign_audience)
|
|
980
|
+
|
|
981
|
+
```ruby
|
|
982
|
+
KlaviyoAPI::Campaigns.delete_campaign_audience(id)
|
|
983
|
+
```
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
#### [Delete Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_campaign_message)
|
|
990
|
+
|
|
991
|
+
```ruby
|
|
992
|
+
KlaviyoAPI::Campaigns.delete_campaign_message(id)
|
|
993
|
+
```
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
#### [Delete Campaign Variation](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_campaign_variation)
|
|
1000
|
+
|
|
1001
|
+
```ruby
|
|
1002
|
+
KlaviyoAPI::Campaigns.delete_campaign_variation(id)
|
|
1003
|
+
```
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
#### [Get Audience for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_audience_for_campaign_message)
|
|
1010
|
+
|
|
1011
|
+
```ruby
|
|
1012
|
+
KlaviyoAPI::Campaigns.get_audience_for_campaign_message(id, opts)
|
|
1013
|
+
```
|
|
1014
|
+
##### Method alias:
|
|
1015
|
+
```ruby
|
|
1016
|
+
KlaviyoAPI::Campaigns.get_campaign_message_audience(id, opts)
|
|
1017
|
+
```
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
#### [Get Audience ID for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_audience_id_for_campaign_message)
|
|
1024
|
+
|
|
1025
|
+
```ruby
|
|
1026
|
+
KlaviyoAPI::Campaigns.get_audience_id_for_campaign_message(id)
|
|
1027
|
+
```
|
|
1028
|
+
##### Method alias:
|
|
1029
|
+
```ruby
|
|
1030
|
+
KlaviyoAPI::Campaigns.get_campaign_message_relationships_audience(id)
|
|
1031
|
+
```
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
#### [Get Audience IDs for Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/get_audience_ids_for_campaign)
|
|
1038
|
+
|
|
1039
|
+
```ruby
|
|
1040
|
+
KlaviyoAPI::Campaigns.get_audience_ids_for_campaign(id)
|
|
1041
|
+
```
|
|
1042
|
+
##### Method alias:
|
|
1043
|
+
```ruby
|
|
1044
|
+
KlaviyoAPI::Campaigns.get_campaign_relationships_audiences(id)
|
|
1045
|
+
```
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
#### [Get Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign)
|
|
1052
|
+
|
|
1053
|
+
```ruby
|
|
1054
|
+
KlaviyoAPI::Campaigns.get_campaign(id, opts)
|
|
1055
|
+
```
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
#### [Get Campaign Audience](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_audience)
|
|
1062
|
+
|
|
1063
|
+
```ruby
|
|
1064
|
+
KlaviyoAPI::Campaigns.get_campaign_audience(id, opts)
|
|
1065
|
+
```
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
#### [Get Campaign Audiences for Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_audiences_for_campaign)
|
|
1072
|
+
|
|
1073
|
+
```ruby
|
|
1074
|
+
KlaviyoAPI::Campaigns.get_campaign_audiences_for_campaign(id, opts)
|
|
1075
|
+
```
|
|
1076
|
+
##### Method alias:
|
|
1077
|
+
```ruby
|
|
1078
|
+
KlaviyoAPI::Campaigns.get_audiences_for_campaign(id, opts)
|
|
1079
|
+
```
|
|
1080
|
+
##### Method alias:
|
|
1081
|
+
```ruby
|
|
1082
|
+
KlaviyoAPI::Campaigns.get_campaign_audiences(id, opts)
|
|
1083
|
+
```
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
#### [Get Campaign for Campaign Audience](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_for_campaign_audience)
|
|
1090
|
+
|
|
1091
|
+
```ruby
|
|
1092
|
+
KlaviyoAPI::Campaigns.get_campaign_for_campaign_audience(id, opts)
|
|
1093
|
+
```
|
|
1094
|
+
##### Method alias:
|
|
1095
|
+
```ruby
|
|
1096
|
+
KlaviyoAPI::Campaigns.get_campaign_audience_campaign(id, opts)
|
|
1097
|
+
```
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
#### [Get Campaign for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_for_campaign_message)
|
|
1104
|
+
|
|
1105
|
+
```ruby
|
|
1106
|
+
KlaviyoAPI::Campaigns.get_campaign_for_campaign_message(id, opts)
|
|
1107
|
+
```
|
|
1108
|
+
##### Method alias:
|
|
1109
|
+
```ruby
|
|
1110
|
+
KlaviyoAPI::Campaigns.get_campaign_message_campaign(id, opts)
|
|
1111
|
+
```
|
|
1112
|
+
|
|
450
1113
|
|
|
451
|
-
```ruby
|
|
452
|
-
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
|
|
453
|
-
opts = {
|
|
454
|
-
fields_list: ["name"],
|
|
455
|
-
include: ["lists"]
|
|
456
|
-
}
|
|
457
1114
|
|
|
458
|
-
response = KlaviyoAPI::Profiles.get_profile(profile_id,opts)
|
|
459
1115
|
|
|
460
1116
|
|
|
1117
|
+
#### [Get Campaign ID for Campaign Audience](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_id_for_campaign_audience)
|
|
461
1118
|
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
1119
|
+
```ruby
|
|
1120
|
+
KlaviyoAPI::Campaigns.get_campaign_id_for_campaign_audience(id)
|
|
1121
|
+
```
|
|
1122
|
+
##### Method alias:
|
|
1123
|
+
```ruby
|
|
1124
|
+
KlaviyoAPI::Campaigns.get_campaign_audience_relationships_campaign(id)
|
|
466
1125
|
```
|
|
467
1126
|
|
|
468
|
-
### Relationships
|
|
469
1127
|
|
|
470
|
-
The Klaviyo Api has a series of endpoints to expose the relationships between your different Klaviyo Items. You can read more about relationships in [our documentation](https://developers.klaviyo.com/en/v2023-02-22/docs/relationships_).
|
|
471
1128
|
|
|
472
|
-
Here are some use cases and their examples:
|
|
473
1129
|
|
|
474
|
-
How to get the list memberships for a profile with the given profile ID.
|
|
475
1130
|
|
|
476
|
-
|
|
1131
|
+
#### [Get Campaign ID for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_id_for_campaign_message)
|
|
477
1132
|
|
|
1133
|
+
```ruby
|
|
1134
|
+
KlaviyoAPI::Campaigns.get_campaign_id_for_campaign_message(id)
|
|
478
1135
|
```
|
|
479
|
-
|
|
1136
|
+
##### Method alias:
|
|
1137
|
+
```ruby
|
|
1138
|
+
KlaviyoAPI::Campaigns.get_campaign_message_relationships_campaign(id)
|
|
480
1139
|
```
|
|
481
1140
|
|
|
482
|
-
and for the SDK:
|
|
483
1141
|
|
|
484
|
-
```ruby
|
|
485
|
-
profile_id = '01GDDKASAP8TKDDA2GRZDSVP4H'
|
|
486
1142
|
|
|
487
|
-
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
#### [Get Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_message)
|
|
1146
|
+
|
|
1147
|
+
```ruby
|
|
1148
|
+
KlaviyoAPI::Campaigns.get_campaign_message(id, opts)
|
|
488
1149
|
```
|
|
489
1150
|
|
|
490
|
-
For another example:
|
|
491
1151
|
|
|
492
|
-
Get all campaigns associated with the given `tag_id`.
|
|
493
1152
|
|
|
494
|
-
the URL:
|
|
495
1153
|
|
|
496
|
-
```
|
|
497
|
-
https://a.klaviyo.com/api/tags/9c8db7a0-5ab5-4e3c-9a37-a3224fd14382/relationships/campaigns/
|
|
498
|
-
```
|
|
499
1154
|
|
|
500
|
-
|
|
1155
|
+
#### [Get Campaign Messages](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_messages)
|
|
501
1156
|
|
|
502
1157
|
```ruby
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
response = KlaviyoAPI::Tags.get_tag_relationships_campaigns(tag_id)
|
|
1158
|
+
KlaviyoAPI::Campaigns.get_campaign_messages(opts)
|
|
506
1159
|
```
|
|
507
|
-
### Combining
|
|
508
1160
|
|
|
509
|
-
You can use any combination of the features outlines above in conjunction with one another.
|
|
510
1161
|
|
|
511
|
-
#### Get events associated with a specific metric, then return just the event properties sorted by oldest to newest datetime.
|
|
512
1162
|
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
#### [Get Campaign Messages for Campaign Audience](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_messages_for_campaign_audience)
|
|
1166
|
+
|
|
1167
|
+
```ruby
|
|
1168
|
+
KlaviyoAPI::Campaigns.get_campaign_messages_for_campaign_audience(id, opts)
|
|
513
1169
|
```
|
|
514
|
-
|
|
1170
|
+
##### Method alias:
|
|
1171
|
+
```ruby
|
|
1172
|
+
KlaviyoAPI::Campaigns.get_campaign_audience_messages(id, opts)
|
|
515
1173
|
```
|
|
516
|
-
|
|
1174
|
+
##### Method alias:
|
|
517
1175
|
```ruby
|
|
518
|
-
opts
|
|
519
|
-
|
|
520
|
-
fields_event: ["event_properties"]
|
|
521
|
-
}
|
|
1176
|
+
KlaviyoAPI::Campaigns.get_messages_for_campaign_audience(id, opts)
|
|
1177
|
+
```
|
|
522
1178
|
|
|
523
|
-
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
#### [Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_recipient_estimation)
|
|
1184
|
+
|
|
1185
|
+
```ruby
|
|
1186
|
+
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation(id, opts)
|
|
524
1187
|
```
|
|
525
1188
|
|
|
526
|
-
## Comprehensive list of Operations & Parameters
|
|
527
1189
|
|
|
528
|
-
_**NOTE:**_
|
|
529
|
-
- Organization: Resource groups and operation_ids are listed in alphabetical order, first by Resource name, then by **OpenAPI Summary**. Operation summaries are those listed in the right side bar of the [API Reference](https://developers.klaviyo.com/en/v2026-07-15/reference/get_events).
|
|
530
|
-
- For example values / data types, as well as whether parameters are required/optional, please reference the corresponding API Reference link.
|
|
531
|
-
- Some args are required for the API call to succeed, the API docs above are the source of truth regarding which params are required.
|
|
532
1190
|
|
|
533
1191
|
|
|
534
1192
|
|
|
1193
|
+
#### [Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_recipient_estimation_job)
|
|
1194
|
+
|
|
1195
|
+
```ruby
|
|
1196
|
+
KlaviyoAPI::Campaigns.get_campaign_recipient_estimation_job(id, opts)
|
|
1197
|
+
```
|
|
535
1198
|
|
|
536
1199
|
|
|
537
1200
|
|
|
538
|
-
## Accounts
|
|
539
1201
|
|
|
540
1202
|
|
|
541
|
-
#### [Get
|
|
1203
|
+
#### [Get Campaign Send Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_send_job)
|
|
542
1204
|
|
|
543
1205
|
```ruby
|
|
544
|
-
KlaviyoAPI::
|
|
1206
|
+
KlaviyoAPI::Campaigns.get_campaign_send_job(id, opts)
|
|
545
1207
|
```
|
|
546
1208
|
|
|
547
1209
|
|
|
548
1210
|
|
|
549
1211
|
|
|
550
1212
|
|
|
551
|
-
#### [Get
|
|
1213
|
+
#### [Get Campaign Variation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_variation)
|
|
552
1214
|
|
|
553
1215
|
```ruby
|
|
554
|
-
KlaviyoAPI::
|
|
1216
|
+
KlaviyoAPI::Campaigns.get_campaign_variation(id, opts)
|
|
555
1217
|
```
|
|
556
1218
|
|
|
557
1219
|
|
|
558
1220
|
|
|
559
1221
|
|
|
560
1222
|
|
|
1223
|
+
#### [Get Campaigns](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaigns)
|
|
561
1224
|
|
|
562
|
-
|
|
1225
|
+
```ruby
|
|
1226
|
+
KlaviyoAPI::Campaigns.get_campaigns(opts)
|
|
1227
|
+
```
|
|
563
1228
|
|
|
564
1229
|
|
|
565
|
-
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
#### [Get Image for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_image_for_campaign_message)
|
|
566
1234
|
|
|
567
1235
|
```ruby
|
|
568
|
-
KlaviyoAPI::Campaigns.
|
|
1236
|
+
KlaviyoAPI::Campaigns.get_image_for_campaign_message(id, opts)
|
|
569
1237
|
```
|
|
570
1238
|
##### Method alias:
|
|
571
1239
|
```ruby
|
|
572
|
-
KlaviyoAPI::Campaigns.
|
|
1240
|
+
KlaviyoAPI::Campaigns.get_campaign_message_image(id, opts)
|
|
573
1241
|
```
|
|
574
1242
|
|
|
575
1243
|
|
|
576
1244
|
|
|
577
1245
|
|
|
578
1246
|
|
|
579
|
-
#### [
|
|
1247
|
+
#### [Get Image for Campaign Variation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_image_for_campaign_variation)
|
|
580
1248
|
|
|
581
1249
|
```ruby
|
|
582
|
-
KlaviyoAPI::Campaigns.
|
|
1250
|
+
KlaviyoAPI::Campaigns.get_image_for_campaign_variation(id, opts)
|
|
583
1251
|
```
|
|
584
1252
|
##### Method alias:
|
|
585
1253
|
```ruby
|
|
586
|
-
KlaviyoAPI::Campaigns.
|
|
1254
|
+
KlaviyoAPI::Campaigns.get_campaign_variation_image(id, opts)
|
|
587
1255
|
```
|
|
588
1256
|
|
|
589
1257
|
|
|
590
1258
|
|
|
591
1259
|
|
|
592
1260
|
|
|
593
|
-
#### [
|
|
1261
|
+
#### [Get Image ID for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_image_id_for_campaign_message)
|
|
594
1262
|
|
|
595
1263
|
```ruby
|
|
596
|
-
KlaviyoAPI::Campaigns.
|
|
1264
|
+
KlaviyoAPI::Campaigns.get_image_id_for_campaign_message(id)
|
|
1265
|
+
```
|
|
1266
|
+
##### Method alias:
|
|
1267
|
+
```ruby
|
|
1268
|
+
KlaviyoAPI::Campaigns.get_campaign_message_relationships_image(id)
|
|
597
1269
|
```
|
|
598
1270
|
|
|
599
1271
|
|
|
600
1272
|
|
|
601
1273
|
|
|
602
1274
|
|
|
603
|
-
#### [
|
|
1275
|
+
#### [Get Image ID for Campaign Variation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_image_id_for_campaign_variation)
|
|
604
1276
|
|
|
605
1277
|
```ruby
|
|
606
|
-
KlaviyoAPI::Campaigns.
|
|
1278
|
+
KlaviyoAPI::Campaigns.get_image_id_for_campaign_variation(id)
|
|
607
1279
|
```
|
|
608
1280
|
##### Method alias:
|
|
609
1281
|
```ruby
|
|
610
|
-
KlaviyoAPI::Campaigns.
|
|
1282
|
+
KlaviyoAPI::Campaigns.get_campaign_variation_relationships_image(id)
|
|
611
1283
|
```
|
|
612
1284
|
|
|
613
1285
|
|
|
614
1286
|
|
|
615
1287
|
|
|
616
1288
|
|
|
617
|
-
#### [
|
|
1289
|
+
#### [Get Message for Campaign Variation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_message_for_campaign_variation)
|
|
618
1290
|
|
|
619
1291
|
```ruby
|
|
620
|
-
KlaviyoAPI::Campaigns.
|
|
1292
|
+
KlaviyoAPI::Campaigns.get_message_for_campaign_variation(id, opts)
|
|
1293
|
+
```
|
|
1294
|
+
##### Method alias:
|
|
1295
|
+
```ruby
|
|
1296
|
+
KlaviyoAPI::Campaigns.get_campaign_variation_message(id, opts)
|
|
621
1297
|
```
|
|
622
1298
|
|
|
623
1299
|
|
|
624
1300
|
|
|
625
1301
|
|
|
626
1302
|
|
|
627
|
-
#### [Get Campaign](https://developers.klaviyo.com/en/v2026-
|
|
1303
|
+
#### [Get Message ID for Campaign Variation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_message_id_for_campaign_variation)
|
|
628
1304
|
|
|
629
1305
|
```ruby
|
|
630
|
-
KlaviyoAPI::Campaigns.
|
|
1306
|
+
KlaviyoAPI::Campaigns.get_message_id_for_campaign_variation(id)
|
|
1307
|
+
```
|
|
1308
|
+
##### Method alias:
|
|
1309
|
+
```ruby
|
|
1310
|
+
KlaviyoAPI::Campaigns.get_campaign_variation_relationships_message(id)
|
|
631
1311
|
```
|
|
632
1312
|
|
|
633
1313
|
|
|
634
1314
|
|
|
635
1315
|
|
|
636
1316
|
|
|
637
|
-
#### [Get
|
|
1317
|
+
#### [Get Message IDs for Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/get_message_ids_for_campaign)
|
|
638
1318
|
|
|
639
1319
|
```ruby
|
|
640
|
-
KlaviyoAPI::Campaigns.
|
|
1320
|
+
KlaviyoAPI::Campaigns.get_message_ids_for_campaign(id, opts)
|
|
641
1321
|
```
|
|
642
1322
|
##### Method alias:
|
|
643
1323
|
```ruby
|
|
644
|
-
KlaviyoAPI::Campaigns.
|
|
1324
|
+
KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id, opts)
|
|
1325
|
+
```
|
|
1326
|
+
##### Method alias:
|
|
1327
|
+
```ruby
|
|
1328
|
+
KlaviyoAPI::Campaigns.get_campaign_relationships_messages(id, opts)
|
|
645
1329
|
```
|
|
646
1330
|
|
|
647
1331
|
|
|
648
1332
|
|
|
649
1333
|
|
|
650
1334
|
|
|
651
|
-
#### [Get
|
|
1335
|
+
#### [Get Message IDs for Campaign Audience](https://developers.klaviyo.com/en/v2026-10-15/reference/get_message_ids_for_campaign_audience)
|
|
652
1336
|
|
|
653
1337
|
```ruby
|
|
654
|
-
KlaviyoAPI::Campaigns.
|
|
1338
|
+
KlaviyoAPI::Campaigns.get_message_ids_for_campaign_audience(id, opts)
|
|
655
1339
|
```
|
|
656
1340
|
##### Method alias:
|
|
657
1341
|
```ruby
|
|
658
|
-
KlaviyoAPI::Campaigns.
|
|
1342
|
+
KlaviyoAPI::Campaigns.get_campaign_audience_relationships_messages(id, opts)
|
|
659
1343
|
```
|
|
660
1344
|
|
|
661
1345
|
|
|
662
1346
|
|
|
663
1347
|
|
|
664
1348
|
|
|
665
|
-
#### [Get Campaign
|
|
1349
|
+
#### [Get Messages for Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/get_messages_for_campaign)
|
|
666
1350
|
|
|
667
1351
|
```ruby
|
|
668
|
-
KlaviyoAPI::Campaigns.
|
|
1352
|
+
KlaviyoAPI::Campaigns.get_messages_for_campaign(id, opts)
|
|
1353
|
+
```
|
|
1354
|
+
##### Method alias:
|
|
1355
|
+
```ruby
|
|
1356
|
+
KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts)
|
|
669
1357
|
```
|
|
670
1358
|
|
|
671
1359
|
|
|
672
1360
|
|
|
673
1361
|
|
|
674
1362
|
|
|
675
|
-
#### [Get
|
|
1363
|
+
#### [Get Tag IDs for Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tag_ids_for_campaign)
|
|
676
1364
|
|
|
677
1365
|
```ruby
|
|
678
|
-
KlaviyoAPI::Campaigns.
|
|
1366
|
+
KlaviyoAPI::Campaigns.get_tag_ids_for_campaign(id)
|
|
1367
|
+
```
|
|
1368
|
+
##### Method alias:
|
|
1369
|
+
```ruby
|
|
1370
|
+
KlaviyoAPI::Campaigns.get_campaign_relationships_tags(id)
|
|
679
1371
|
```
|
|
680
1372
|
|
|
681
1373
|
|
|
682
1374
|
|
|
683
1375
|
|
|
684
1376
|
|
|
685
|
-
#### [Get
|
|
1377
|
+
#### [Get Tag IDs for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tag_ids_for_campaign_message)
|
|
686
1378
|
|
|
687
1379
|
```ruby
|
|
688
|
-
KlaviyoAPI::Campaigns.
|
|
1380
|
+
KlaviyoAPI::Campaigns.get_tag_ids_for_campaign_message(id)
|
|
1381
|
+
```
|
|
1382
|
+
##### Method alias:
|
|
1383
|
+
```ruby
|
|
1384
|
+
KlaviyoAPI::Campaigns.get_campaign_message_relationships_tags(id)
|
|
689
1385
|
```
|
|
690
1386
|
|
|
691
1387
|
|
|
692
1388
|
|
|
693
1389
|
|
|
694
1390
|
|
|
695
|
-
#### [Get
|
|
1391
|
+
#### [Get Tags for Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tags_for_campaign)
|
|
696
1392
|
|
|
697
1393
|
```ruby
|
|
698
|
-
KlaviyoAPI::Campaigns.
|
|
1394
|
+
KlaviyoAPI::Campaigns.get_tags_for_campaign(id, opts)
|
|
1395
|
+
```
|
|
1396
|
+
##### Method alias:
|
|
1397
|
+
```ruby
|
|
1398
|
+
KlaviyoAPI::Campaigns.get_campaign_tags(id, opts)
|
|
699
1399
|
```
|
|
700
1400
|
|
|
701
1401
|
|
|
702
1402
|
|
|
703
1403
|
|
|
704
1404
|
|
|
705
|
-
#### [Get
|
|
1405
|
+
#### [Get Tags for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tags_for_campaign_message)
|
|
706
1406
|
|
|
707
1407
|
```ruby
|
|
708
|
-
KlaviyoAPI::Campaigns.
|
|
1408
|
+
KlaviyoAPI::Campaigns.get_tags_for_campaign_message(id, opts)
|
|
1409
|
+
```
|
|
1410
|
+
##### Method alias:
|
|
1411
|
+
```ruby
|
|
1412
|
+
KlaviyoAPI::Campaigns.get_campaign_message_tags(id, opts)
|
|
709
1413
|
```
|
|
710
1414
|
|
|
711
1415
|
|
|
712
1416
|
|
|
713
1417
|
|
|
714
1418
|
|
|
715
|
-
#### [Get
|
|
1419
|
+
#### [Get Template for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_template_for_campaign_message)
|
|
716
1420
|
|
|
717
1421
|
```ruby
|
|
718
|
-
KlaviyoAPI::Campaigns.
|
|
1422
|
+
KlaviyoAPI::Campaigns.get_template_for_campaign_message(id, opts)
|
|
719
1423
|
```
|
|
720
1424
|
##### Method alias:
|
|
721
1425
|
```ruby
|
|
722
|
-
KlaviyoAPI::Campaigns.
|
|
1426
|
+
KlaviyoAPI::Campaigns.get_campaign_message_template(id, opts)
|
|
723
1427
|
```
|
|
724
1428
|
|
|
725
1429
|
|
|
726
1430
|
|
|
727
1431
|
|
|
728
1432
|
|
|
729
|
-
#### [Get
|
|
1433
|
+
#### [Get Template ID for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_template_id_for_campaign_message)
|
|
730
1434
|
|
|
731
1435
|
```ruby
|
|
732
|
-
KlaviyoAPI::Campaigns.
|
|
1436
|
+
KlaviyoAPI::Campaigns.get_template_id_for_campaign_message(id)
|
|
733
1437
|
```
|
|
734
1438
|
##### Method alias:
|
|
735
1439
|
```ruby
|
|
736
|
-
KlaviyoAPI::Campaigns.
|
|
1440
|
+
KlaviyoAPI::Campaigns.get_campaign_message_relationships_template(id)
|
|
737
1441
|
```
|
|
738
1442
|
|
|
739
1443
|
|
|
740
1444
|
|
|
741
1445
|
|
|
742
1446
|
|
|
743
|
-
#### [Get
|
|
1447
|
+
#### [Get Translation for Campaign Variation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_translation_for_campaign_variation)
|
|
744
1448
|
|
|
745
1449
|
```ruby
|
|
746
|
-
KlaviyoAPI::Campaigns.
|
|
747
|
-
```
|
|
748
|
-
##### Method alias:
|
|
749
|
-
```ruby
|
|
750
|
-
KlaviyoAPI::Campaigns.get_campaign_relationships_campaign_messages(id)
|
|
1450
|
+
KlaviyoAPI::Campaigns.get_translation_for_campaign_variation(id, opts)
|
|
751
1451
|
```
|
|
752
1452
|
##### Method alias:
|
|
753
1453
|
```ruby
|
|
754
|
-
KlaviyoAPI::Campaigns.
|
|
1454
|
+
KlaviyoAPI::Campaigns.get_campaign_variation_translation(id, opts)
|
|
755
1455
|
```
|
|
756
1456
|
|
|
757
1457
|
|
|
758
1458
|
|
|
759
1459
|
|
|
760
1460
|
|
|
761
|
-
#### [Get
|
|
1461
|
+
#### [Get Translation ID for Campaign Variation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_translation_id_for_campaign_variation)
|
|
762
1462
|
|
|
763
1463
|
```ruby
|
|
764
|
-
KlaviyoAPI::Campaigns.
|
|
765
|
-
```
|
|
766
|
-
##### Method alias:
|
|
767
|
-
```ruby
|
|
768
|
-
KlaviyoAPI::Campaigns.get_campaign_campaign_messages(id, opts)
|
|
1464
|
+
KlaviyoAPI::Campaigns.get_translation_id_for_campaign_variation(id)
|
|
769
1465
|
```
|
|
770
1466
|
##### Method alias:
|
|
771
1467
|
```ruby
|
|
772
|
-
KlaviyoAPI::Campaigns.
|
|
1468
|
+
KlaviyoAPI::Campaigns.get_campaign_variation_relationships_translation(id)
|
|
773
1469
|
```
|
|
774
1470
|
|
|
775
1471
|
|
|
776
1472
|
|
|
777
1473
|
|
|
778
1474
|
|
|
779
|
-
#### [Get
|
|
1475
|
+
#### [Get Variation IDs for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_variation_ids_for_campaign_message)
|
|
780
1476
|
|
|
781
1477
|
```ruby
|
|
782
|
-
KlaviyoAPI::Campaigns.
|
|
1478
|
+
KlaviyoAPI::Campaigns.get_variation_ids_for_campaign_message(id)
|
|
783
1479
|
```
|
|
784
1480
|
##### Method alias:
|
|
785
1481
|
```ruby
|
|
786
|
-
KlaviyoAPI::Campaigns.
|
|
1482
|
+
KlaviyoAPI::Campaigns.get_campaign_message_relationships_variations(id)
|
|
787
1483
|
```
|
|
788
1484
|
|
|
789
1485
|
|
|
790
1486
|
|
|
791
1487
|
|
|
792
1488
|
|
|
793
|
-
#### [Get
|
|
1489
|
+
#### [Get Variations for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_variations_for_campaign_message)
|
|
794
1490
|
|
|
795
1491
|
```ruby
|
|
796
|
-
KlaviyoAPI::Campaigns.
|
|
1492
|
+
KlaviyoAPI::Campaigns.get_variations_for_campaign_message(id, opts)
|
|
797
1493
|
```
|
|
798
1494
|
##### Method alias:
|
|
799
1495
|
```ruby
|
|
800
|
-
KlaviyoAPI::Campaigns.
|
|
1496
|
+
KlaviyoAPI::Campaigns.get_campaign_message_variations(id, opts)
|
|
801
1497
|
```
|
|
802
1498
|
|
|
803
1499
|
|
|
804
1500
|
|
|
805
1501
|
|
|
806
1502
|
|
|
807
|
-
#### [
|
|
1503
|
+
#### [Refresh Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2026-10-15/reference/refresh_campaign_recipient_estimation)
|
|
808
1504
|
|
|
809
1505
|
```ruby
|
|
810
|
-
KlaviyoAPI::Campaigns.
|
|
1506
|
+
KlaviyoAPI::Campaigns.refresh_campaign_recipient_estimation(body, opts)
|
|
811
1507
|
```
|
|
812
1508
|
##### Method alias:
|
|
813
1509
|
```ruby
|
|
814
|
-
KlaviyoAPI::Campaigns.
|
|
1510
|
+
KlaviyoAPI::Campaigns.create_campaign_recipient_estimation_job(body, opts)
|
|
815
1511
|
```
|
|
816
1512
|
|
|
817
1513
|
|
|
818
1514
|
|
|
819
1515
|
|
|
820
1516
|
|
|
821
|
-
#### [
|
|
1517
|
+
#### [Schedule Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/schedule_campaign)
|
|
822
1518
|
|
|
823
1519
|
```ruby
|
|
824
|
-
KlaviyoAPI::Campaigns.
|
|
1520
|
+
KlaviyoAPI::Campaigns.schedule_campaign(body, opts)
|
|
825
1521
|
```
|
|
826
1522
|
##### Method alias:
|
|
827
1523
|
```ruby
|
|
828
|
-
KlaviyoAPI::Campaigns.
|
|
1524
|
+
KlaviyoAPI::Campaigns.create_campaign_schedule(body, opts)
|
|
829
1525
|
```
|
|
830
1526
|
|
|
831
1527
|
|
|
832
1528
|
|
|
833
1529
|
|
|
834
1530
|
|
|
835
|
-
#### [
|
|
1531
|
+
#### [Schedule Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/schedule_campaign_message)
|
|
836
1532
|
|
|
837
1533
|
```ruby
|
|
838
|
-
KlaviyoAPI::Campaigns.
|
|
1534
|
+
KlaviyoAPI::Campaigns.schedule_campaign_message(body, opts)
|
|
839
1535
|
```
|
|
840
1536
|
##### Method alias:
|
|
841
1537
|
```ruby
|
|
842
|
-
KlaviyoAPI::Campaigns.
|
|
1538
|
+
KlaviyoAPI::Campaigns.create_campaign_message_schedule(body, opts)
|
|
843
1539
|
```
|
|
844
1540
|
|
|
845
1541
|
|
|
846
1542
|
|
|
847
1543
|
|
|
848
1544
|
|
|
849
|
-
#### [Send Campaign](https://developers.klaviyo.com/en/v2026-
|
|
1545
|
+
#### [Send Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/send_campaign)
|
|
850
1546
|
|
|
851
1547
|
```ruby
|
|
852
1548
|
KlaviyoAPI::Campaigns.send_campaign(body, opts)
|
|
@@ -860,7 +1556,7 @@ KlaviyoAPI::Campaigns.create_campaign_send_job(body, opts)
|
|
|
860
1556
|
|
|
861
1557
|
|
|
862
1558
|
|
|
863
|
-
#### [Update Campaign](https://developers.klaviyo.com/en/v2026-
|
|
1559
|
+
#### [Update Campaign](https://developers.klaviyo.com/en/v2026-10-15/reference/update_campaign)
|
|
864
1560
|
|
|
865
1561
|
```ruby
|
|
866
1562
|
KlaviyoAPI::Campaigns.update_campaign(id, body, opts)
|
|
@@ -870,7 +1566,17 @@ KlaviyoAPI::Campaigns.update_campaign(id, body, opts)
|
|
|
870
1566
|
|
|
871
1567
|
|
|
872
1568
|
|
|
873
|
-
#### [Update Campaign
|
|
1569
|
+
#### [Update Campaign Audience](https://developers.klaviyo.com/en/v2026-10-15/reference/update_campaign_audience)
|
|
1570
|
+
|
|
1571
|
+
```ruby
|
|
1572
|
+
KlaviyoAPI::Campaigns.update_campaign_audience(id, body, opts)
|
|
1573
|
+
```
|
|
1574
|
+
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
|
|
1579
|
+
#### [Update Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/update_campaign_message)
|
|
874
1580
|
|
|
875
1581
|
```ruby
|
|
876
1582
|
KlaviyoAPI::Campaigns.update_campaign_message(id, body, opts)
|
|
@@ -880,7 +1586,27 @@ KlaviyoAPI::Campaigns.update_campaign_message(id, body, opts)
|
|
|
880
1586
|
|
|
881
1587
|
|
|
882
1588
|
|
|
883
|
-
#### [Update
|
|
1589
|
+
#### [Update Campaign Message Schedule](https://developers.klaviyo.com/en/v2026-10-15/reference/update_campaign_message_schedule)
|
|
1590
|
+
|
|
1591
|
+
```ruby
|
|
1592
|
+
KlaviyoAPI::Campaigns.update_campaign_message_schedule(id, body)
|
|
1593
|
+
```
|
|
1594
|
+
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
#### [Update Campaign Variation](https://developers.klaviyo.com/en/v2026-10-15/reference/update_campaign_variation)
|
|
1600
|
+
|
|
1601
|
+
```ruby
|
|
1602
|
+
KlaviyoAPI::Campaigns.update_campaign_variation(id, body, opts)
|
|
1603
|
+
```
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
#### [Update Image for Campaign Message](https://developers.klaviyo.com/en/v2026-10-15/reference/update_image_for_campaign_message)
|
|
884
1610
|
|
|
885
1611
|
```ruby
|
|
886
1612
|
KlaviyoAPI::Campaigns.update_image_for_campaign_message(id, body)
|
|
@@ -898,7 +1624,7 @@ KlaviyoAPI::Campaigns.update_campaign_message_relationships_image(id, body)
|
|
|
898
1624
|
## Catalogs
|
|
899
1625
|
|
|
900
1626
|
|
|
901
|
-
#### [Add Categories to Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1627
|
+
#### [Add Categories to Catalog Item](https://developers.klaviyo.com/en/v2026-10-15/reference/add_categories_to_catalog_item)
|
|
902
1628
|
|
|
903
1629
|
```ruby
|
|
904
1630
|
KlaviyoAPI::Catalogs.add_categories_to_catalog_item(id, body)
|
|
@@ -920,7 +1646,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_relationships_categories(id, body)
|
|
|
920
1646
|
|
|
921
1647
|
|
|
922
1648
|
|
|
923
|
-
#### [Add Items to Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
1649
|
+
#### [Add Items to Catalog Category](https://developers.klaviyo.com/en/v2026-10-15/reference/add_items_to_catalog_category)
|
|
924
1650
|
|
|
925
1651
|
```ruby
|
|
926
1652
|
KlaviyoAPI::Catalogs.add_items_to_catalog_category(id, body)
|
|
@@ -938,7 +1664,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_relationships_items(id, body)
|
|
|
938
1664
|
|
|
939
1665
|
|
|
940
1666
|
|
|
941
|
-
#### [Bulk Create Catalog Categories](https://developers.klaviyo.com/en/v2026-
|
|
1667
|
+
#### [Bulk Create Catalog Categories](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_create_catalog_categories)
|
|
942
1668
|
|
|
943
1669
|
```ruby
|
|
944
1670
|
KlaviyoAPI::Catalogs.bulk_create_catalog_categories(body, opts)
|
|
@@ -956,7 +1682,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_bulk_create_job(body, opts)
|
|
|
956
1682
|
|
|
957
1683
|
|
|
958
1684
|
|
|
959
|
-
#### [Bulk Create Catalog Items](https://developers.klaviyo.com/en/v2026-
|
|
1685
|
+
#### [Bulk Create Catalog Items](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_create_catalog_items)
|
|
960
1686
|
|
|
961
1687
|
```ruby
|
|
962
1688
|
KlaviyoAPI::Catalogs.bulk_create_catalog_items(body, opts)
|
|
@@ -974,7 +1700,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_bulk_create_job(body, opts)
|
|
|
974
1700
|
|
|
975
1701
|
|
|
976
1702
|
|
|
977
|
-
#### [Bulk Create Catalog Variants](https://developers.klaviyo.com/en/v2026-
|
|
1703
|
+
#### [Bulk Create Catalog Variants](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_create_catalog_variants)
|
|
978
1704
|
|
|
979
1705
|
```ruby
|
|
980
1706
|
KlaviyoAPI::Catalogs.bulk_create_catalog_variants(body, opts)
|
|
@@ -992,7 +1718,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant_bulk_create_job(body, opts)
|
|
|
992
1718
|
|
|
993
1719
|
|
|
994
1720
|
|
|
995
|
-
#### [Bulk Delete Catalog Categories](https://developers.klaviyo.com/en/v2026-
|
|
1721
|
+
#### [Bulk Delete Catalog Categories](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_delete_catalog_categories)
|
|
996
1722
|
|
|
997
1723
|
```ruby
|
|
998
1724
|
KlaviyoAPI::Catalogs.bulk_delete_catalog_categories(body, opts)
|
|
@@ -1010,7 +1736,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_bulk_delete_job(body, opts)
|
|
|
1010
1736
|
|
|
1011
1737
|
|
|
1012
1738
|
|
|
1013
|
-
#### [Bulk Delete Catalog Items](https://developers.klaviyo.com/en/v2026-
|
|
1739
|
+
#### [Bulk Delete Catalog Items](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_delete_catalog_items)
|
|
1014
1740
|
|
|
1015
1741
|
```ruby
|
|
1016
1742
|
KlaviyoAPI::Catalogs.bulk_delete_catalog_items(body, opts)
|
|
@@ -1028,7 +1754,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_bulk_delete_job(body, opts)
|
|
|
1028
1754
|
|
|
1029
1755
|
|
|
1030
1756
|
|
|
1031
|
-
#### [Bulk Delete Catalog Variants](https://developers.klaviyo.com/en/v2026-
|
|
1757
|
+
#### [Bulk Delete Catalog Variants](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_delete_catalog_variants)
|
|
1032
1758
|
|
|
1033
1759
|
```ruby
|
|
1034
1760
|
KlaviyoAPI::Catalogs.bulk_delete_catalog_variants(body, opts)
|
|
@@ -1046,7 +1772,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant_bulk_delete_job(body, opts)
|
|
|
1046
1772
|
|
|
1047
1773
|
|
|
1048
1774
|
|
|
1049
|
-
#### [Bulk Update Catalog Categories](https://developers.klaviyo.com/en/v2026-
|
|
1775
|
+
#### [Bulk Update Catalog Categories](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_update_catalog_categories)
|
|
1050
1776
|
|
|
1051
1777
|
```ruby
|
|
1052
1778
|
KlaviyoAPI::Catalogs.bulk_update_catalog_categories(body, opts)
|
|
@@ -1064,7 +1790,7 @@ KlaviyoAPI::Catalogs.create_catalog_category_bulk_update_job(body, opts)
|
|
|
1064
1790
|
|
|
1065
1791
|
|
|
1066
1792
|
|
|
1067
|
-
#### [Bulk Update Catalog Items](https://developers.klaviyo.com/en/v2026-
|
|
1793
|
+
#### [Bulk Update Catalog Items](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_update_catalog_items)
|
|
1068
1794
|
|
|
1069
1795
|
```ruby
|
|
1070
1796
|
KlaviyoAPI::Catalogs.bulk_update_catalog_items(body, opts)
|
|
@@ -1082,7 +1808,7 @@ KlaviyoAPI::Catalogs.create_catalog_item_bulk_update_job(body, opts)
|
|
|
1082
1808
|
|
|
1083
1809
|
|
|
1084
1810
|
|
|
1085
|
-
#### [Bulk Update Catalog Variants](https://developers.klaviyo.com/en/v2026-
|
|
1811
|
+
#### [Bulk Update Catalog Variants](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_update_catalog_variants)
|
|
1086
1812
|
|
|
1087
1813
|
```ruby
|
|
1088
1814
|
KlaviyoAPI::Catalogs.bulk_update_catalog_variants(body, opts)
|
|
@@ -1100,7 +1826,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant_bulk_update_job(body, opts)
|
|
|
1100
1826
|
|
|
1101
1827
|
|
|
1102
1828
|
|
|
1103
|
-
#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2026-
|
|
1829
|
+
#### [Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2026-10-15/reference/create_back_in_stock_subscription)
|
|
1104
1830
|
|
|
1105
1831
|
```ruby
|
|
1106
1832
|
KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
|
|
@@ -1110,7 +1836,7 @@ KlaviyoAPI::Catalogs.create_back_in_stock_subscription(body)
|
|
|
1110
1836
|
|
|
1111
1837
|
|
|
1112
1838
|
|
|
1113
|
-
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
1839
|
+
#### [Create Catalog Category](https://developers.klaviyo.com/en/v2026-10-15/reference/create_catalog_category)
|
|
1114
1840
|
|
|
1115
1841
|
```ruby
|
|
1116
1842
|
KlaviyoAPI::Catalogs.create_catalog_category(body, opts)
|
|
@@ -1120,7 +1846,7 @@ KlaviyoAPI::Catalogs.create_catalog_category(body, opts)
|
|
|
1120
1846
|
|
|
1121
1847
|
|
|
1122
1848
|
|
|
1123
|
-
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1849
|
+
#### [Create Catalog Item](https://developers.klaviyo.com/en/v2026-10-15/reference/create_catalog_item)
|
|
1124
1850
|
|
|
1125
1851
|
```ruby
|
|
1126
1852
|
KlaviyoAPI::Catalogs.create_catalog_item(body, opts)
|
|
@@ -1130,7 +1856,7 @@ KlaviyoAPI::Catalogs.create_catalog_item(body, opts)
|
|
|
1130
1856
|
|
|
1131
1857
|
|
|
1132
1858
|
|
|
1133
|
-
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2026-
|
|
1859
|
+
#### [Create Catalog Variant](https://developers.klaviyo.com/en/v2026-10-15/reference/create_catalog_variant)
|
|
1134
1860
|
|
|
1135
1861
|
```ruby
|
|
1136
1862
|
KlaviyoAPI::Catalogs.create_catalog_variant(body, opts)
|
|
@@ -1140,7 +1866,7 @@ KlaviyoAPI::Catalogs.create_catalog_variant(body, opts)
|
|
|
1140
1866
|
|
|
1141
1867
|
|
|
1142
1868
|
|
|
1143
|
-
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
1869
|
+
#### [Delete Catalog Category](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_catalog_category)
|
|
1144
1870
|
|
|
1145
1871
|
```ruby
|
|
1146
1872
|
KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
|
@@ -1150,7 +1876,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category(id)
|
|
|
1150
1876
|
|
|
1151
1877
|
|
|
1152
1878
|
|
|
1153
|
-
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
1879
|
+
#### [Delete Catalog Item](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_catalog_item)
|
|
1154
1880
|
|
|
1155
1881
|
```ruby
|
|
1156
1882
|
KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
|
@@ -1160,7 +1886,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item(id)
|
|
|
1160
1886
|
|
|
1161
1887
|
|
|
1162
1888
|
|
|
1163
|
-
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2026-
|
|
1889
|
+
#### [Delete Catalog Variant](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_catalog_variant)
|
|
1164
1890
|
|
|
1165
1891
|
```ruby
|
|
1166
1892
|
KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
|
@@ -1170,7 +1896,7 @@ KlaviyoAPI::Catalogs.delete_catalog_variant(id)
|
|
|
1170
1896
|
|
|
1171
1897
|
|
|
1172
1898
|
|
|
1173
|
-
#### [Get Bulk Create Catalog Items Job](https://developers.klaviyo.com/en/v2026-
|
|
1899
|
+
#### [Get Bulk Create Catalog Items Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_create_catalog_items_job)
|
|
1174
1900
|
|
|
1175
1901
|
```ruby
|
|
1176
1902
|
KlaviyoAPI::Catalogs.get_bulk_create_catalog_items_job(job_id, opts)
|
|
@@ -1188,7 +1914,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_job(job_id, opts)
|
|
|
1188
1914
|
|
|
1189
1915
|
|
|
1190
1916
|
|
|
1191
|
-
#### [Get Bulk Create Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1917
|
+
#### [Get Bulk Create Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_create_catalog_items_jobs)
|
|
1192
1918
|
|
|
1193
1919
|
```ruby
|
|
1194
1920
|
KlaviyoAPI::Catalogs.get_bulk_create_catalog_items_jobs(opts)
|
|
@@ -1206,7 +1932,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_create_jobs(opts)
|
|
|
1206
1932
|
|
|
1207
1933
|
|
|
1208
1934
|
|
|
1209
|
-
#### [Get Bulk Create Categories Job](https://developers.klaviyo.com/en/v2026-
|
|
1935
|
+
#### [Get Bulk Create Categories Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_create_categories_job)
|
|
1210
1936
|
|
|
1211
1937
|
```ruby
|
|
1212
1938
|
KlaviyoAPI::Catalogs.get_bulk_create_categories_job(job_id, opts)
|
|
@@ -1224,7 +1950,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_job(job_id, opts)
|
|
|
1224
1950
|
|
|
1225
1951
|
|
|
1226
1952
|
|
|
1227
|
-
#### [Get Bulk Create Categories Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1953
|
+
#### [Get Bulk Create Categories Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_create_categories_jobs)
|
|
1228
1954
|
|
|
1229
1955
|
```ruby
|
|
1230
1956
|
KlaviyoAPI::Catalogs.get_bulk_create_categories_jobs(opts)
|
|
@@ -1242,7 +1968,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_create_jobs(opts)
|
|
|
1242
1968
|
|
|
1243
1969
|
|
|
1244
1970
|
|
|
1245
|
-
#### [Get Bulk Create Variants Job](https://developers.klaviyo.com/en/v2026-
|
|
1971
|
+
#### [Get Bulk Create Variants Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_create_variants_job)
|
|
1246
1972
|
|
|
1247
1973
|
```ruby
|
|
1248
1974
|
KlaviyoAPI::Catalogs.get_bulk_create_variants_job(job_id, opts)
|
|
@@ -1260,7 +1986,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_job(job_id, opts)
|
|
|
1260
1986
|
|
|
1261
1987
|
|
|
1262
1988
|
|
|
1263
|
-
#### [Get Bulk Create Variants Jobs](https://developers.klaviyo.com/en/v2026-
|
|
1989
|
+
#### [Get Bulk Create Variants Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_create_variants_jobs)
|
|
1264
1990
|
|
|
1265
1991
|
```ruby
|
|
1266
1992
|
KlaviyoAPI::Catalogs.get_bulk_create_variants_jobs(opts)
|
|
@@ -1278,7 +2004,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_create_jobs(opts)
|
|
|
1278
2004
|
|
|
1279
2005
|
|
|
1280
2006
|
|
|
1281
|
-
#### [Get Bulk Delete Catalog Items Job](https://developers.klaviyo.com/en/v2026-
|
|
2007
|
+
#### [Get Bulk Delete Catalog Items Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_delete_catalog_items_job)
|
|
1282
2008
|
|
|
1283
2009
|
```ruby
|
|
1284
2010
|
KlaviyoAPI::Catalogs.get_bulk_delete_catalog_items_job(job_id, opts)
|
|
@@ -1296,7 +2022,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_job(job_id, opts)
|
|
|
1296
2022
|
|
|
1297
2023
|
|
|
1298
2024
|
|
|
1299
|
-
#### [Get Bulk Delete Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-
|
|
2025
|
+
#### [Get Bulk Delete Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_delete_catalog_items_jobs)
|
|
1300
2026
|
|
|
1301
2027
|
```ruby
|
|
1302
2028
|
KlaviyoAPI::Catalogs.get_bulk_delete_catalog_items_jobs(opts)
|
|
@@ -1314,7 +2040,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_delete_jobs(opts)
|
|
|
1314
2040
|
|
|
1315
2041
|
|
|
1316
2042
|
|
|
1317
|
-
#### [Get Bulk Delete Categories Job](https://developers.klaviyo.com/en/v2026-
|
|
2043
|
+
#### [Get Bulk Delete Categories Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_delete_categories_job)
|
|
1318
2044
|
|
|
1319
2045
|
```ruby
|
|
1320
2046
|
KlaviyoAPI::Catalogs.get_bulk_delete_categories_job(job_id, opts)
|
|
@@ -1332,7 +2058,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_job(job_id, opts)
|
|
|
1332
2058
|
|
|
1333
2059
|
|
|
1334
2060
|
|
|
1335
|
-
#### [Get Bulk Delete Categories Jobs](https://developers.klaviyo.com/en/v2026-
|
|
2061
|
+
#### [Get Bulk Delete Categories Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_delete_categories_jobs)
|
|
1336
2062
|
|
|
1337
2063
|
```ruby
|
|
1338
2064
|
KlaviyoAPI::Catalogs.get_bulk_delete_categories_jobs(opts)
|
|
@@ -1350,7 +2076,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_delete_jobs(opts)
|
|
|
1350
2076
|
|
|
1351
2077
|
|
|
1352
2078
|
|
|
1353
|
-
#### [Get Bulk Delete Variants Job](https://developers.klaviyo.com/en/v2026-
|
|
2079
|
+
#### [Get Bulk Delete Variants Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_delete_variants_job)
|
|
1354
2080
|
|
|
1355
2081
|
```ruby
|
|
1356
2082
|
KlaviyoAPI::Catalogs.get_bulk_delete_variants_job(job_id, opts)
|
|
@@ -1368,7 +2094,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_job(job_id, opts)
|
|
|
1368
2094
|
|
|
1369
2095
|
|
|
1370
2096
|
|
|
1371
|
-
#### [Get Bulk Delete Variants Jobs](https://developers.klaviyo.com/en/v2026-
|
|
2097
|
+
#### [Get Bulk Delete Variants Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_delete_variants_jobs)
|
|
1372
2098
|
|
|
1373
2099
|
```ruby
|
|
1374
2100
|
KlaviyoAPI::Catalogs.get_bulk_delete_variants_jobs(opts)
|
|
@@ -1386,7 +2112,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_delete_jobs(opts)
|
|
|
1386
2112
|
|
|
1387
2113
|
|
|
1388
2114
|
|
|
1389
|
-
#### [Get Bulk Update Catalog Items Job](https://developers.klaviyo.com/en/v2026-
|
|
2115
|
+
#### [Get Bulk Update Catalog Items Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_update_catalog_items_job)
|
|
1390
2116
|
|
|
1391
2117
|
```ruby
|
|
1392
2118
|
KlaviyoAPI::Catalogs.get_bulk_update_catalog_items_job(job_id, opts)
|
|
@@ -1404,7 +2130,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_job(job_id, opts)
|
|
|
1404
2130
|
|
|
1405
2131
|
|
|
1406
2132
|
|
|
1407
|
-
#### [Get Bulk Update Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-
|
|
2133
|
+
#### [Get Bulk Update Catalog Items Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_update_catalog_items_jobs)
|
|
1408
2134
|
|
|
1409
2135
|
```ruby
|
|
1410
2136
|
KlaviyoAPI::Catalogs.get_bulk_update_catalog_items_jobs(opts)
|
|
@@ -1422,7 +2148,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_bulk_update_jobs(opts)
|
|
|
1422
2148
|
|
|
1423
2149
|
|
|
1424
2150
|
|
|
1425
|
-
#### [Get Bulk Update Categories Job](https://developers.klaviyo.com/en/v2026-
|
|
2151
|
+
#### [Get Bulk Update Categories Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_update_categories_job)
|
|
1426
2152
|
|
|
1427
2153
|
```ruby
|
|
1428
2154
|
KlaviyoAPI::Catalogs.get_bulk_update_categories_job(job_id, opts)
|
|
@@ -1440,7 +2166,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_job(job_id, opts)
|
|
|
1440
2166
|
|
|
1441
2167
|
|
|
1442
2168
|
|
|
1443
|
-
#### [Get Bulk Update Categories Jobs](https://developers.klaviyo.com/en/v2026-
|
|
2169
|
+
#### [Get Bulk Update Categories Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_update_categories_jobs)
|
|
1444
2170
|
|
|
1445
2171
|
```ruby
|
|
1446
2172
|
KlaviyoAPI::Catalogs.get_bulk_update_categories_jobs(opts)
|
|
@@ -1458,7 +2184,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_bulk_update_jobs(opts)
|
|
|
1458
2184
|
|
|
1459
2185
|
|
|
1460
2186
|
|
|
1461
|
-
#### [Get Bulk Update Variants Job](https://developers.klaviyo.com/en/v2026-
|
|
2187
|
+
#### [Get Bulk Update Variants Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_update_variants_job)
|
|
1462
2188
|
|
|
1463
2189
|
```ruby
|
|
1464
2190
|
KlaviyoAPI::Catalogs.get_bulk_update_variants_job(job_id, opts)
|
|
@@ -1476,7 +2202,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_job(job_id, opts)
|
|
|
1476
2202
|
|
|
1477
2203
|
|
|
1478
2204
|
|
|
1479
|
-
#### [Get Bulk Update Variants Jobs](https://developers.klaviyo.com/en/v2026-
|
|
2205
|
+
#### [Get Bulk Update Variants Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_update_variants_jobs)
|
|
1480
2206
|
|
|
1481
2207
|
```ruby
|
|
1482
2208
|
KlaviyoAPI::Catalogs.get_bulk_update_variants_jobs(opts)
|
|
@@ -1494,7 +2220,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant_bulk_update_jobs(opts)
|
|
|
1494
2220
|
|
|
1495
2221
|
|
|
1496
2222
|
|
|
1497
|
-
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2026-
|
|
2223
|
+
#### [Get Catalog Categories](https://developers.klaviyo.com/en/v2026-10-15/reference/get_catalog_categories)
|
|
1498
2224
|
|
|
1499
2225
|
```ruby
|
|
1500
2226
|
KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
|
@@ -1504,7 +2230,7 @@ KlaviyoAPI::Catalogs.get_catalog_categories(opts)
|
|
|
1504
2230
|
|
|
1505
2231
|
|
|
1506
2232
|
|
|
1507
|
-
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
2233
|
+
#### [Get Catalog Category](https://developers.klaviyo.com/en/v2026-10-15/reference/get_catalog_category)
|
|
1508
2234
|
|
|
1509
2235
|
```ruby
|
|
1510
2236
|
KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
|
@@ -1514,7 +2240,7 @@ KlaviyoAPI::Catalogs.get_catalog_category(id, opts)
|
|
|
1514
2240
|
|
|
1515
2241
|
|
|
1516
2242
|
|
|
1517
|
-
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
2243
|
+
#### [Get Catalog Item](https://developers.klaviyo.com/en/v2026-10-15/reference/get_catalog_item)
|
|
1518
2244
|
|
|
1519
2245
|
```ruby
|
|
1520
2246
|
KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
|
@@ -1524,7 +2250,7 @@ KlaviyoAPI::Catalogs.get_catalog_item(id, opts)
|
|
|
1524
2250
|
|
|
1525
2251
|
|
|
1526
2252
|
|
|
1527
|
-
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2026-
|
|
2253
|
+
#### [Get Catalog Items](https://developers.klaviyo.com/en/v2026-10-15/reference/get_catalog_items)
|
|
1528
2254
|
|
|
1529
2255
|
```ruby
|
|
1530
2256
|
KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
|
@@ -1534,7 +2260,7 @@ KlaviyoAPI::Catalogs.get_catalog_items(opts)
|
|
|
1534
2260
|
|
|
1535
2261
|
|
|
1536
2262
|
|
|
1537
|
-
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2026-
|
|
2263
|
+
#### [Get Catalog Variant](https://developers.klaviyo.com/en/v2026-10-15/reference/get_catalog_variant)
|
|
1538
2264
|
|
|
1539
2265
|
```ruby
|
|
1540
2266
|
KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
|
@@ -1544,7 +2270,7 @@ KlaviyoAPI::Catalogs.get_catalog_variant(id, opts)
|
|
|
1544
2270
|
|
|
1545
2271
|
|
|
1546
2272
|
|
|
1547
|
-
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2026-
|
|
2273
|
+
#### [Get Catalog Variants](https://developers.klaviyo.com/en/v2026-10-15/reference/get_catalog_variants)
|
|
1548
2274
|
|
|
1549
2275
|
```ruby
|
|
1550
2276
|
KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
|
@@ -1554,7 +2280,7 @@ KlaviyoAPI::Catalogs.get_catalog_variants(opts)
|
|
|
1554
2280
|
|
|
1555
2281
|
|
|
1556
2282
|
|
|
1557
|
-
#### [Get Categories for Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
2283
|
+
#### [Get Categories for Catalog Item](https://developers.klaviyo.com/en/v2026-10-15/reference/get_categories_for_catalog_item)
|
|
1558
2284
|
|
|
1559
2285
|
```ruby
|
|
1560
2286
|
KlaviyoAPI::Catalogs.get_categories_for_catalog_item(id, opts)
|
|
@@ -1568,7 +2294,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_categories(id, opts)
|
|
|
1568
2294
|
|
|
1569
2295
|
|
|
1570
2296
|
|
|
1571
|
-
#### [Get Category IDs for Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
2297
|
+
#### [Get Category IDs for Catalog Item](https://developers.klaviyo.com/en/v2026-10-15/reference/get_category_ids_for_catalog_item)
|
|
1572
2298
|
|
|
1573
2299
|
```ruby
|
|
1574
2300
|
KlaviyoAPI::Catalogs.get_category_ids_for_catalog_item(id, opts)
|
|
@@ -1582,7 +2308,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships_categories(id, opts)
|
|
|
1582
2308
|
|
|
1583
2309
|
|
|
1584
2310
|
|
|
1585
|
-
#### [Get Item IDs for Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
2311
|
+
#### [Get Item IDs for Catalog Category](https://developers.klaviyo.com/en/v2026-10-15/reference/get_item_ids_for_catalog_category)
|
|
1586
2312
|
|
|
1587
2313
|
```ruby
|
|
1588
2314
|
KlaviyoAPI::Catalogs.get_item_ids_for_catalog_category(id, opts)
|
|
@@ -1596,7 +2322,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_relationships_items(id, opts)
|
|
|
1596
2322
|
|
|
1597
2323
|
|
|
1598
2324
|
|
|
1599
|
-
#### [Get Items for Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
2325
|
+
#### [Get Items for Catalog Category](https://developers.klaviyo.com/en/v2026-10-15/reference/get_items_for_catalog_category)
|
|
1600
2326
|
|
|
1601
2327
|
```ruby
|
|
1602
2328
|
KlaviyoAPI::Catalogs.get_items_for_catalog_category(id, opts)
|
|
@@ -1610,7 +2336,7 @@ KlaviyoAPI::Catalogs.get_catalog_category_items(id, opts)
|
|
|
1610
2336
|
|
|
1611
2337
|
|
|
1612
2338
|
|
|
1613
|
-
#### [Get Variant IDs for Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
2339
|
+
#### [Get Variant IDs for Catalog Item](https://developers.klaviyo.com/en/v2026-10-15/reference/get_variant_ids_for_catalog_item)
|
|
1614
2340
|
|
|
1615
2341
|
```ruby
|
|
1616
2342
|
KlaviyoAPI::Catalogs.get_variant_ids_for_catalog_item(id, opts)
|
|
@@ -1624,7 +2350,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_relationships_variants(id, opts)
|
|
|
1624
2350
|
|
|
1625
2351
|
|
|
1626
2352
|
|
|
1627
|
-
#### [Get Variants for Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
2353
|
+
#### [Get Variants for Catalog Item](https://developers.klaviyo.com/en/v2026-10-15/reference/get_variants_for_catalog_item)
|
|
1628
2354
|
|
|
1629
2355
|
```ruby
|
|
1630
2356
|
KlaviyoAPI::Catalogs.get_variants_for_catalog_item(id, opts)
|
|
@@ -1638,7 +2364,7 @@ KlaviyoAPI::Catalogs.get_catalog_item_variants(id, opts)
|
|
|
1638
2364
|
|
|
1639
2365
|
|
|
1640
2366
|
|
|
1641
|
-
#### [Remove Categories from Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
2367
|
+
#### [Remove Categories from Catalog Item](https://developers.klaviyo.com/en/v2026-10-15/reference/remove_categories_from_catalog_item)
|
|
1642
2368
|
|
|
1643
2369
|
```ruby
|
|
1644
2370
|
KlaviyoAPI::Catalogs.remove_categories_from_catalog_item(id, body)
|
|
@@ -1652,7 +2378,7 @@ KlaviyoAPI::Catalogs.delete_catalog_item_relationships_categories(id, body)
|
|
|
1652
2378
|
|
|
1653
2379
|
|
|
1654
2380
|
|
|
1655
|
-
#### [Remove Items from Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
2381
|
+
#### [Remove Items from Catalog Category](https://developers.klaviyo.com/en/v2026-10-15/reference/remove_items_from_catalog_category)
|
|
1656
2382
|
|
|
1657
2383
|
```ruby
|
|
1658
2384
|
KlaviyoAPI::Catalogs.remove_items_from_catalog_category(id, body)
|
|
@@ -1666,7 +2392,7 @@ KlaviyoAPI::Catalogs.delete_catalog_category_relationships_items(id, body)
|
|
|
1666
2392
|
|
|
1667
2393
|
|
|
1668
2394
|
|
|
1669
|
-
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
2395
|
+
#### [Update Catalog Category](https://developers.klaviyo.com/en/v2026-10-15/reference/update_catalog_category)
|
|
1670
2396
|
|
|
1671
2397
|
```ruby
|
|
1672
2398
|
KlaviyoAPI::Catalogs.update_catalog_category(id, body, opts)
|
|
@@ -1676,7 +2402,7 @@ KlaviyoAPI::Catalogs.update_catalog_category(id, body, opts)
|
|
|
1676
2402
|
|
|
1677
2403
|
|
|
1678
2404
|
|
|
1679
|
-
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
2405
|
+
#### [Update Catalog Item](https://developers.klaviyo.com/en/v2026-10-15/reference/update_catalog_item)
|
|
1680
2406
|
|
|
1681
2407
|
```ruby
|
|
1682
2408
|
KlaviyoAPI::Catalogs.update_catalog_item(id, body, opts)
|
|
@@ -1686,7 +2412,7 @@ KlaviyoAPI::Catalogs.update_catalog_item(id, body, opts)
|
|
|
1686
2412
|
|
|
1687
2413
|
|
|
1688
2414
|
|
|
1689
|
-
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2026-
|
|
2415
|
+
#### [Update Catalog Variant](https://developers.klaviyo.com/en/v2026-10-15/reference/update_catalog_variant)
|
|
1690
2416
|
|
|
1691
2417
|
```ruby
|
|
1692
2418
|
KlaviyoAPI::Catalogs.update_catalog_variant(id, body, opts)
|
|
@@ -1696,7 +2422,7 @@ KlaviyoAPI::Catalogs.update_catalog_variant(id, body, opts)
|
|
|
1696
2422
|
|
|
1697
2423
|
|
|
1698
2424
|
|
|
1699
|
-
#### [Update Categories for Catalog Item](https://developers.klaviyo.com/en/v2026-
|
|
2425
|
+
#### [Update Categories for Catalog Item](https://developers.klaviyo.com/en/v2026-10-15/reference/update_categories_for_catalog_item)
|
|
1700
2426
|
|
|
1701
2427
|
```ruby
|
|
1702
2428
|
KlaviyoAPI::Catalogs.update_categories_for_catalog_item(id, body)
|
|
@@ -1710,7 +2436,7 @@ KlaviyoAPI::Catalogs.update_catalog_item_relationships_categories(id, body)
|
|
|
1710
2436
|
|
|
1711
2437
|
|
|
1712
2438
|
|
|
1713
|
-
#### [Update Items for Catalog Category](https://developers.klaviyo.com/en/v2026-
|
|
2439
|
+
#### [Update Items for Catalog Category](https://developers.klaviyo.com/en/v2026-10-15/reference/update_items_for_catalog_category)
|
|
1714
2440
|
|
|
1715
2441
|
```ruby
|
|
1716
2442
|
KlaviyoAPI::Catalogs.update_items_for_catalog_category(id, body)
|
|
@@ -1728,10 +2454,10 @@ KlaviyoAPI::Catalogs.update_catalog_category_relationships_items(id, body)
|
|
|
1728
2454
|
## Client
|
|
1729
2455
|
|
|
1730
2456
|
|
|
1731
|
-
#### [Get Client IP Allowlist](https://developers.klaviyo.com/en/v2026-
|
|
2457
|
+
#### [Get Client IP Allowlist](https://developers.klaviyo.com/en/v2026-10-15/reference/get_client_ip_allowlist)
|
|
1732
2458
|
|
|
1733
2459
|
```ruby
|
|
1734
|
-
KlaviyoAPI::Client.get_client_ip_allowlist(id,
|
|
2460
|
+
KlaviyoAPI::Client.get_client_ip_allowlist(id, opts)
|
|
1735
2461
|
```
|
|
1736
2462
|
|
|
1737
2463
|
|
|
@@ -1742,7 +2468,7 @@ KlaviyoAPI::Client.get_client_ip_allowlist(id, company_id, opts)
|
|
|
1742
2468
|
## Conversations
|
|
1743
2469
|
|
|
1744
2470
|
|
|
1745
|
-
#### [Create Conversation Message](https://developers.klaviyo.com/en/v2026-
|
|
2471
|
+
#### [Create Conversation Message](https://developers.klaviyo.com/en/v2026-10-15/reference/create_conversation_message)
|
|
1746
2472
|
|
|
1747
2473
|
```ruby
|
|
1748
2474
|
KlaviyoAPI::Conversations.create_conversation_message(body)
|
|
@@ -1756,7 +2482,7 @@ KlaviyoAPI::Conversations.create_conversation_message(body)
|
|
|
1756
2482
|
## Coupons
|
|
1757
2483
|
|
|
1758
2484
|
|
|
1759
|
-
#### [Bulk Create Coupon Codes](https://developers.klaviyo.com/en/v2026-
|
|
2485
|
+
#### [Bulk Create Coupon Codes](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_create_coupon_codes)
|
|
1760
2486
|
|
|
1761
2487
|
```ruby
|
|
1762
2488
|
KlaviyoAPI::Coupons.bulk_create_coupon_codes(body, opts)
|
|
@@ -1774,7 +2500,7 @@ KlaviyoAPI::Coupons.create_coupon_code_bulk_create_job(body, opts)
|
|
|
1774
2500
|
|
|
1775
2501
|
|
|
1776
2502
|
|
|
1777
|
-
#### [Create Coupon](https://developers.klaviyo.com/en/v2026-
|
|
2503
|
+
#### [Create Coupon](https://developers.klaviyo.com/en/v2026-10-15/reference/create_coupon)
|
|
1778
2504
|
|
|
1779
2505
|
```ruby
|
|
1780
2506
|
KlaviyoAPI::Coupons.create_coupon(body, opts)
|
|
@@ -1784,7 +2510,7 @@ KlaviyoAPI::Coupons.create_coupon(body, opts)
|
|
|
1784
2510
|
|
|
1785
2511
|
|
|
1786
2512
|
|
|
1787
|
-
#### [Create Coupon Code](https://developers.klaviyo.com/en/v2026-
|
|
2513
|
+
#### [Create Coupon Code](https://developers.klaviyo.com/en/v2026-10-15/reference/create_coupon_code)
|
|
1788
2514
|
|
|
1789
2515
|
```ruby
|
|
1790
2516
|
KlaviyoAPI::Coupons.create_coupon_code(body, opts)
|
|
@@ -1794,7 +2520,7 @@ KlaviyoAPI::Coupons.create_coupon_code(body, opts)
|
|
|
1794
2520
|
|
|
1795
2521
|
|
|
1796
2522
|
|
|
1797
|
-
#### [Delete Coupon](https://developers.klaviyo.com/en/v2026-
|
|
2523
|
+
#### [Delete Coupon](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_coupon)
|
|
1798
2524
|
|
|
1799
2525
|
```ruby
|
|
1800
2526
|
KlaviyoAPI::Coupons.delete_coupon(id)
|
|
@@ -1804,7 +2530,7 @@ KlaviyoAPI::Coupons.delete_coupon(id)
|
|
|
1804
2530
|
|
|
1805
2531
|
|
|
1806
2532
|
|
|
1807
|
-
#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2026-
|
|
2533
|
+
#### [Delete Coupon Code](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_coupon_code)
|
|
1808
2534
|
|
|
1809
2535
|
```ruby
|
|
1810
2536
|
KlaviyoAPI::Coupons.delete_coupon_code(id)
|
|
@@ -1814,7 +2540,7 @@ KlaviyoAPI::Coupons.delete_coupon_code(id)
|
|
|
1814
2540
|
|
|
1815
2541
|
|
|
1816
2542
|
|
|
1817
|
-
#### [Get Bulk Create Coupon Code Jobs](https://developers.klaviyo.com/en/v2026-
|
|
2543
|
+
#### [Get Bulk Create Coupon Code Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_create_coupon_code_jobs)
|
|
1818
2544
|
|
|
1819
2545
|
```ruby
|
|
1820
2546
|
KlaviyoAPI::Coupons.get_bulk_create_coupon_code_jobs(opts)
|
|
@@ -1828,7 +2554,7 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_jobs(opts)
|
|
|
1828
2554
|
|
|
1829
2555
|
|
|
1830
2556
|
|
|
1831
|
-
#### [Get Bulk Create Coupon Codes Job](https://developers.klaviyo.com/en/v2026-
|
|
2557
|
+
#### [Get Bulk Create Coupon Codes Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_create_coupon_codes_job)
|
|
1832
2558
|
|
|
1833
2559
|
```ruby
|
|
1834
2560
|
KlaviyoAPI::Coupons.get_bulk_create_coupon_codes_job(job_id, opts)
|
|
@@ -1842,7 +2568,7 @@ KlaviyoAPI::Coupons.get_coupon_code_bulk_create_job(job_id, opts)
|
|
|
1842
2568
|
|
|
1843
2569
|
|
|
1844
2570
|
|
|
1845
|
-
#### [Get Coupon](https://developers.klaviyo.com/en/v2026-
|
|
2571
|
+
#### [Get Coupon](https://developers.klaviyo.com/en/v2026-10-15/reference/get_coupon)
|
|
1846
2572
|
|
|
1847
2573
|
```ruby
|
|
1848
2574
|
KlaviyoAPI::Coupons.get_coupon(id, opts)
|
|
@@ -1852,7 +2578,7 @@ KlaviyoAPI::Coupons.get_coupon(id, opts)
|
|
|
1852
2578
|
|
|
1853
2579
|
|
|
1854
2580
|
|
|
1855
|
-
#### [Get Coupon Code](https://developers.klaviyo.com/en/v2026-
|
|
2581
|
+
#### [Get Coupon Code](https://developers.klaviyo.com/en/v2026-10-15/reference/get_coupon_code)
|
|
1856
2582
|
|
|
1857
2583
|
```ruby
|
|
1858
2584
|
KlaviyoAPI::Coupons.get_coupon_code(id, opts)
|
|
@@ -1862,7 +2588,7 @@ KlaviyoAPI::Coupons.get_coupon_code(id, opts)
|
|
|
1862
2588
|
|
|
1863
2589
|
|
|
1864
2590
|
|
|
1865
|
-
#### [Get Coupon Code IDs for Coupon](https://developers.klaviyo.com/en/v2026-
|
|
2591
|
+
#### [Get Coupon Code IDs for Coupon](https://developers.klaviyo.com/en/v2026-10-15/reference/get_coupon_code_ids_for_coupon)
|
|
1866
2592
|
|
|
1867
2593
|
```ruby
|
|
1868
2594
|
KlaviyoAPI::Coupons.get_coupon_code_ids_for_coupon(id, opts)
|
|
@@ -1884,7 +2610,7 @@ KlaviyoAPI::Coupons.get_coupon_relationships_codes(id, opts)
|
|
|
1884
2610
|
|
|
1885
2611
|
|
|
1886
2612
|
|
|
1887
|
-
#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2026-
|
|
2613
|
+
#### [Get Coupon Codes](https://developers.klaviyo.com/en/v2026-10-15/reference/get_coupon_codes)
|
|
1888
2614
|
|
|
1889
2615
|
```ruby
|
|
1890
2616
|
KlaviyoAPI::Coupons.get_coupon_codes(filter, opts)
|
|
@@ -1894,7 +2620,7 @@ KlaviyoAPI::Coupons.get_coupon_codes(filter, opts)
|
|
|
1894
2620
|
|
|
1895
2621
|
|
|
1896
2622
|
|
|
1897
|
-
#### [Get Coupon Codes for Coupon](https://developers.klaviyo.com/en/v2026-
|
|
2623
|
+
#### [Get Coupon Codes for Coupon](https://developers.klaviyo.com/en/v2026-10-15/reference/get_coupon_codes_for_coupon)
|
|
1898
2624
|
|
|
1899
2625
|
```ruby
|
|
1900
2626
|
KlaviyoAPI::Coupons.get_coupon_codes_for_coupon(id, opts)
|
|
@@ -1912,7 +2638,7 @@ KlaviyoAPI::Coupons.get_codes_for_coupon(id, opts)
|
|
|
1912
2638
|
|
|
1913
2639
|
|
|
1914
2640
|
|
|
1915
|
-
#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2026-
|
|
2641
|
+
#### [Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2026-10-15/reference/get_coupon_for_coupon_code)
|
|
1916
2642
|
|
|
1917
2643
|
```ruby
|
|
1918
2644
|
KlaviyoAPI::Coupons.get_coupon_for_coupon_code(id, opts)
|
|
@@ -1926,7 +2652,7 @@ KlaviyoAPI::Coupons.get_coupon_code_coupon(id, opts)
|
|
|
1926
2652
|
|
|
1927
2653
|
|
|
1928
2654
|
|
|
1929
|
-
#### [Get Coupon ID for Coupon Code](https://developers.klaviyo.com/en/v2026-
|
|
2655
|
+
#### [Get Coupon ID for Coupon Code](https://developers.klaviyo.com/en/v2026-10-15/reference/get_coupon_id_for_coupon_code)
|
|
1930
2656
|
|
|
1931
2657
|
```ruby
|
|
1932
2658
|
KlaviyoAPI::Coupons.get_coupon_id_for_coupon_code(id)
|
|
@@ -1940,7 +2666,7 @@ KlaviyoAPI::Coupons.get_coupon_relationships_coupon_codes(id)
|
|
|
1940
2666
|
|
|
1941
2667
|
|
|
1942
2668
|
|
|
1943
|
-
#### [Get Coupons](https://developers.klaviyo.com/en/v2026-
|
|
2669
|
+
#### [Get Coupons](https://developers.klaviyo.com/en/v2026-10-15/reference/get_coupons)
|
|
1944
2670
|
|
|
1945
2671
|
```ruby
|
|
1946
2672
|
KlaviyoAPI::Coupons.get_coupons(opts)
|
|
@@ -1950,7 +2676,7 @@ KlaviyoAPI::Coupons.get_coupons(opts)
|
|
|
1950
2676
|
|
|
1951
2677
|
|
|
1952
2678
|
|
|
1953
|
-
#### [Update Coupon](https://developers.klaviyo.com/en/v2026-
|
|
2679
|
+
#### [Update Coupon](https://developers.klaviyo.com/en/v2026-10-15/reference/update_coupon)
|
|
1954
2680
|
|
|
1955
2681
|
```ruby
|
|
1956
2682
|
KlaviyoAPI::Coupons.update_coupon(id, body, opts)
|
|
@@ -1960,7 +2686,7 @@ KlaviyoAPI::Coupons.update_coupon(id, body, opts)
|
|
|
1960
2686
|
|
|
1961
2687
|
|
|
1962
2688
|
|
|
1963
|
-
#### [Update Coupon Code](https://developers.klaviyo.com/en/v2026-
|
|
2689
|
+
#### [Update Coupon Code](https://developers.klaviyo.com/en/v2026-10-15/reference/update_coupon_code)
|
|
1964
2690
|
|
|
1965
2691
|
```ruby
|
|
1966
2692
|
KlaviyoAPI::Coupons.update_coupon_code(id, body, opts)
|
|
@@ -1974,7 +2700,7 @@ KlaviyoAPI::Coupons.update_coupon_code(id, body, opts)
|
|
|
1974
2700
|
## Custom Objects
|
|
1975
2701
|
|
|
1976
2702
|
|
|
1977
|
-
#### [Bulk Create Data Source Records](https://developers.klaviyo.com/en/v2026-
|
|
2703
|
+
#### [Bulk Create Data Source Records](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_create_data_source_records)
|
|
1978
2704
|
|
|
1979
2705
|
```ruby
|
|
1980
2706
|
KlaviyoAPI::CustomObjects.bulk_create_data_source_records(body)
|
|
@@ -1988,7 +2714,7 @@ KlaviyoAPI::CustomObjects.create_data_source_record_bulk_create_job(body)
|
|
|
1988
2714
|
|
|
1989
2715
|
|
|
1990
2716
|
|
|
1991
|
-
#### [Bulk Delete Object Records](https://developers.klaviyo.com/en/v2026-
|
|
2717
|
+
#### [Bulk Delete Object Records](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_delete_object_records)
|
|
1992
2718
|
|
|
1993
2719
|
```ruby
|
|
1994
2720
|
KlaviyoAPI::CustomObjects.bulk_delete_object_records(body)
|
|
@@ -2002,7 +2728,7 @@ KlaviyoAPI::CustomObjects.create_object_record_bulk_delete_job(body)
|
|
|
2002
2728
|
|
|
2003
2729
|
|
|
2004
2730
|
|
|
2005
|
-
#### [Create Data Source](https://developers.klaviyo.com/en/v2026-
|
|
2731
|
+
#### [Create Data Source](https://developers.klaviyo.com/en/v2026-10-15/reference/create_data_source)
|
|
2006
2732
|
|
|
2007
2733
|
```ruby
|
|
2008
2734
|
KlaviyoAPI::CustomObjects.create_data_source(body, opts)
|
|
@@ -2012,7 +2738,7 @@ KlaviyoAPI::CustomObjects.create_data_source(body, opts)
|
|
|
2012
2738
|
|
|
2013
2739
|
|
|
2014
2740
|
|
|
2015
|
-
#### [Create Data Source Record](https://developers.klaviyo.com/en/v2026-
|
|
2741
|
+
#### [Create Data Source Record](https://developers.klaviyo.com/en/v2026-10-15/reference/create_data_source_record)
|
|
2016
2742
|
|
|
2017
2743
|
```ruby
|
|
2018
2744
|
KlaviyoAPI::CustomObjects.create_data_source_record(body)
|
|
@@ -2026,7 +2752,7 @@ KlaviyoAPI::CustomObjects.create_data_source_record_create_job(body)
|
|
|
2026
2752
|
|
|
2027
2753
|
|
|
2028
2754
|
|
|
2029
|
-
#### [Create Object Schema](https://developers.klaviyo.com/en/v2026-
|
|
2755
|
+
#### [Create Object Schema](https://developers.klaviyo.com/en/v2026-10-15/reference/create_object_schema)
|
|
2030
2756
|
|
|
2031
2757
|
```ruby
|
|
2032
2758
|
KlaviyoAPI::CustomObjects.create_object_schema(body, opts)
|
|
@@ -2036,7 +2762,7 @@ KlaviyoAPI::CustomObjects.create_object_schema(body, opts)
|
|
|
2036
2762
|
|
|
2037
2763
|
|
|
2038
2764
|
|
|
2039
|
-
#### [Create Object Schema Relationship](https://developers.klaviyo.com/en/v2026-
|
|
2765
|
+
#### [Create Object Schema Relationship](https://developers.klaviyo.com/en/v2026-10-15/reference/create_object_schema_relationship)
|
|
2040
2766
|
|
|
2041
2767
|
```ruby
|
|
2042
2768
|
KlaviyoAPI::CustomObjects.create_object_schema_relationship(id, body)
|
|
@@ -2054,7 +2780,7 @@ KlaviyoAPI::CustomObjects.create_object_schema_relationships_schemas(id, body)
|
|
|
2054
2780
|
|
|
2055
2781
|
|
|
2056
2782
|
|
|
2057
|
-
#### [Create Object Type](https://developers.klaviyo.com/en/v2026-
|
|
2783
|
+
#### [Create Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/create_object_type)
|
|
2058
2784
|
|
|
2059
2785
|
```ruby
|
|
2060
2786
|
KlaviyoAPI::CustomObjects.create_object_type(body, opts)
|
|
@@ -2064,7 +2790,7 @@ KlaviyoAPI::CustomObjects.create_object_type(body, opts)
|
|
|
2064
2790
|
|
|
2065
2791
|
|
|
2066
2792
|
|
|
2067
|
-
#### [Create Profile Schema Relationship](https://developers.klaviyo.com/en/v2026-
|
|
2793
|
+
#### [Create Profile Schema Relationship](https://developers.klaviyo.com/en/v2026-10-15/reference/create_profile_schema_relationship)
|
|
2068
2794
|
|
|
2069
2795
|
```ruby
|
|
2070
2796
|
KlaviyoAPI::CustomObjects.create_profile_schema_relationship(id, body)
|
|
@@ -2082,7 +2808,7 @@ KlaviyoAPI::CustomObjects.create_object_schema_relationships_profile_object_sche
|
|
|
2082
2808
|
|
|
2083
2809
|
|
|
2084
2810
|
|
|
2085
|
-
#### [Delete Data Source](https://developers.klaviyo.com/en/v2026-
|
|
2811
|
+
#### [Delete Data Source](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_data_source)
|
|
2086
2812
|
|
|
2087
2813
|
```ruby
|
|
2088
2814
|
KlaviyoAPI::CustomObjects.delete_data_source(id)
|
|
@@ -2092,7 +2818,7 @@ KlaviyoAPI::CustomObjects.delete_data_source(id)
|
|
|
2092
2818
|
|
|
2093
2819
|
|
|
2094
2820
|
|
|
2095
|
-
#### [Delete Object Schema Relationship](https://developers.klaviyo.com/en/v2026-
|
|
2821
|
+
#### [Delete Object Schema Relationship](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_object_schema_relationship)
|
|
2096
2822
|
|
|
2097
2823
|
```ruby
|
|
2098
2824
|
KlaviyoAPI::CustomObjects.delete_object_schema_relationship(id, body)
|
|
@@ -2110,7 +2836,7 @@ KlaviyoAPI::CustomObjects.remove_schemas_from_object_schema(id, body)
|
|
|
2110
2836
|
|
|
2111
2837
|
|
|
2112
2838
|
|
|
2113
|
-
#### [Delete Object Type](https://developers.klaviyo.com/en/v2026-
|
|
2839
|
+
#### [Delete Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_object_type)
|
|
2114
2840
|
|
|
2115
2841
|
```ruby
|
|
2116
2842
|
KlaviyoAPI::CustomObjects.delete_object_type(id)
|
|
@@ -2120,7 +2846,7 @@ KlaviyoAPI::CustomObjects.delete_object_type(id)
|
|
|
2120
2846
|
|
|
2121
2847
|
|
|
2122
2848
|
|
|
2123
|
-
#### [Delete Profile Schema Relationship](https://developers.klaviyo.com/en/v2026-
|
|
2849
|
+
#### [Delete Profile Schema Relationship](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_profile_schema_relationship)
|
|
2124
2850
|
|
|
2125
2851
|
```ruby
|
|
2126
2852
|
KlaviyoAPI::CustomObjects.delete_profile_schema_relationship(id, body)
|
|
@@ -2138,7 +2864,7 @@ KlaviyoAPI::CustomObjects.remove_profile_object_schemas_from_object_schema(id, b
|
|
|
2138
2864
|
|
|
2139
2865
|
|
|
2140
2866
|
|
|
2141
|
-
#### [Get Current Schema for Object Type](https://developers.klaviyo.com/en/v2026-
|
|
2867
|
+
#### [Get Current Schema for Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/get_current_schema_for_object_type)
|
|
2142
2868
|
|
|
2143
2869
|
```ruby
|
|
2144
2870
|
KlaviyoAPI::CustomObjects.get_current_schema_for_object_type(id, opts)
|
|
@@ -2152,7 +2878,7 @@ KlaviyoAPI::CustomObjects.get_object_type_current_schema(id, opts)
|
|
|
2152
2878
|
|
|
2153
2879
|
|
|
2154
2880
|
|
|
2155
|
-
#### [Get Current Schema ID for Object Type](https://developers.klaviyo.com/en/v2026-
|
|
2881
|
+
#### [Get Current Schema ID for Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/get_current_schema_id_for_object_type)
|
|
2156
2882
|
|
|
2157
2883
|
```ruby
|
|
2158
2884
|
KlaviyoAPI::CustomObjects.get_current_schema_id_for_object_type(id)
|
|
@@ -2166,7 +2892,7 @@ KlaviyoAPI::CustomObjects.get_object_type_relationships_current_schema(id)
|
|
|
2166
2892
|
|
|
2167
2893
|
|
|
2168
2894
|
|
|
2169
|
-
#### [Get Data Source](https://developers.klaviyo.com/en/v2026-
|
|
2895
|
+
#### [Get Data Source](https://developers.klaviyo.com/en/v2026-10-15/reference/get_data_source)
|
|
2170
2896
|
|
|
2171
2897
|
```ruby
|
|
2172
2898
|
KlaviyoAPI::CustomObjects.get_data_source(id, opts)
|
|
@@ -2176,7 +2902,7 @@ KlaviyoAPI::CustomObjects.get_data_source(id, opts)
|
|
|
2176
2902
|
|
|
2177
2903
|
|
|
2178
2904
|
|
|
2179
|
-
#### [Get Data Sources](https://developers.klaviyo.com/en/v2026-
|
|
2905
|
+
#### [Get Data Sources](https://developers.klaviyo.com/en/v2026-10-15/reference/get_data_sources)
|
|
2180
2906
|
|
|
2181
2907
|
```ruby
|
|
2182
2908
|
KlaviyoAPI::CustomObjects.get_data_sources(opts)
|
|
@@ -2186,7 +2912,7 @@ KlaviyoAPI::CustomObjects.get_data_sources(opts)
|
|
|
2186
2912
|
|
|
2187
2913
|
|
|
2188
2914
|
|
|
2189
|
-
#### [Get Draft Schema for Object Type](https://developers.klaviyo.com/en/v2026-
|
|
2915
|
+
#### [Get Draft Schema for Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/get_draft_schema_for_object_type)
|
|
2190
2916
|
|
|
2191
2917
|
```ruby
|
|
2192
2918
|
KlaviyoAPI::CustomObjects.get_draft_schema_for_object_type(id, opts)
|
|
@@ -2200,7 +2926,7 @@ KlaviyoAPI::CustomObjects.get_object_type_draft_schema(id, opts)
|
|
|
2200
2926
|
|
|
2201
2927
|
|
|
2202
2928
|
|
|
2203
|
-
#### [Get Draft Schema ID for Object Type](https://developers.klaviyo.com/en/v2026-
|
|
2929
|
+
#### [Get Draft Schema ID for Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/get_draft_schema_id_for_object_type)
|
|
2204
2930
|
|
|
2205
2931
|
```ruby
|
|
2206
2932
|
KlaviyoAPI::CustomObjects.get_draft_schema_id_for_object_type(id)
|
|
@@ -2214,7 +2940,7 @@ KlaviyoAPI::CustomObjects.get_object_type_relationships_draft_schema(id)
|
|
|
2214
2940
|
|
|
2215
2941
|
|
|
2216
2942
|
|
|
2217
|
-
#### [Get Ingestion Log IDs for Object Type](https://developers.klaviyo.com/en/v2026-
|
|
2943
|
+
#### [Get Ingestion Log IDs for Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/get_ingestion_log_ids_for_object_type)
|
|
2218
2944
|
|
|
2219
2945
|
```ruby
|
|
2220
2946
|
KlaviyoAPI::CustomObjects.get_ingestion_log_ids_for_object_type(id, opts)
|
|
@@ -2228,7 +2954,7 @@ KlaviyoAPI::CustomObjects.get_object_type_relationships_ingestion_logs(id, opts)
|
|
|
2228
2954
|
|
|
2229
2955
|
|
|
2230
2956
|
|
|
2231
|
-
#### [Get Ingestion Logs for Object Type](https://developers.klaviyo.com/en/v2026-
|
|
2957
|
+
#### [Get Ingestion Logs for Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/get_ingestion_logs_for_object_type)
|
|
2232
2958
|
|
|
2233
2959
|
```ruby
|
|
2234
2960
|
KlaviyoAPI::CustomObjects.get_ingestion_logs_for_object_type(id, opts)
|
|
@@ -2242,7 +2968,7 @@ KlaviyoAPI::CustomObjects.get_object_type_ingestion_logs(id, opts)
|
|
|
2242
2968
|
|
|
2243
2969
|
|
|
2244
2970
|
|
|
2245
|
-
#### [Get Object Record](https://developers.klaviyo.com/en/v2026-
|
|
2971
|
+
#### [Get Object Record](https://developers.klaviyo.com/en/v2026-10-15/reference/get_object_record)
|
|
2246
2972
|
|
|
2247
2973
|
```ruby
|
|
2248
2974
|
KlaviyoAPI::CustomObjects.get_object_record(id, opts)
|
|
@@ -2252,7 +2978,7 @@ KlaviyoAPI::CustomObjects.get_object_record(id, opts)
|
|
|
2252
2978
|
|
|
2253
2979
|
|
|
2254
2980
|
|
|
2255
|
-
#### [Get Object Schema](https://developers.klaviyo.com/en/v2026-
|
|
2981
|
+
#### [Get Object Schema](https://developers.klaviyo.com/en/v2026-10-15/reference/get_object_schema)
|
|
2256
2982
|
|
|
2257
2983
|
```ruby
|
|
2258
2984
|
KlaviyoAPI::CustomObjects.get_object_schema(id, opts)
|
|
@@ -2262,7 +2988,7 @@ KlaviyoAPI::CustomObjects.get_object_schema(id, opts)
|
|
|
2262
2988
|
|
|
2263
2989
|
|
|
2264
2990
|
|
|
2265
|
-
#### [Get Object Schema Relationships](https://developers.klaviyo.com/en/v2026-
|
|
2991
|
+
#### [Get Object Schema Relationships](https://developers.klaviyo.com/en/v2026-10-15/reference/get_object_schema_relationships)
|
|
2266
2992
|
|
|
2267
2993
|
```ruby
|
|
2268
2994
|
KlaviyoAPI::CustomObjects.get_object_schema_relationships(id)
|
|
@@ -2280,7 +3006,7 @@ KlaviyoAPI::CustomObjects.get_schema_ids_for_object_schema(id)
|
|
|
2280
3006
|
|
|
2281
3007
|
|
|
2282
3008
|
|
|
2283
|
-
#### [Get Object Type](https://developers.klaviyo.com/en/v2026-
|
|
3009
|
+
#### [Get Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/get_object_type)
|
|
2284
3010
|
|
|
2285
3011
|
```ruby
|
|
2286
3012
|
KlaviyoAPI::CustomObjects.get_object_type(id, opts)
|
|
@@ -2290,7 +3016,7 @@ KlaviyoAPI::CustomObjects.get_object_type(id, opts)
|
|
|
2290
3016
|
|
|
2291
3017
|
|
|
2292
3018
|
|
|
2293
|
-
#### [Get Object Type Relationships](https://developers.klaviyo.com/en/v2026-
|
|
3019
|
+
#### [Get Object Type Relationships](https://developers.klaviyo.com/en/v2026-10-15/reference/get_object_type_relationships)
|
|
2294
3020
|
|
|
2295
3021
|
```ruby
|
|
2296
3022
|
KlaviyoAPI::CustomObjects.get_object_type_relationships(id)
|
|
@@ -2308,7 +3034,7 @@ KlaviyoAPI::CustomObjects.get_type_ids_for_object_type(id)
|
|
|
2308
3034
|
|
|
2309
3035
|
|
|
2310
3036
|
|
|
2311
|
-
#### [Get Object Types](https://developers.klaviyo.com/en/v2026-
|
|
3037
|
+
#### [Get Object Types](https://developers.klaviyo.com/en/v2026-10-15/reference/get_object_types)
|
|
2312
3038
|
|
|
2313
3039
|
```ruby
|
|
2314
3040
|
KlaviyoAPI::CustomObjects.get_object_types(opts)
|
|
@@ -2318,7 +3044,7 @@ KlaviyoAPI::CustomObjects.get_object_types(opts)
|
|
|
2318
3044
|
|
|
2319
3045
|
|
|
2320
3046
|
|
|
2321
|
-
#### [Get Profile Schema Relationships](https://developers.klaviyo.com/en/v2026-
|
|
3047
|
+
#### [Get Profile Schema Relationships](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profile_schema_relationships)
|
|
2322
3048
|
|
|
2323
3049
|
```ruby
|
|
2324
3050
|
KlaviyoAPI::CustomObjects.get_profile_schema_relationships(id)
|
|
@@ -2336,7 +3062,7 @@ KlaviyoAPI::CustomObjects.get_profile_object_schema_ids_for_object_schema(id)
|
|
|
2336
3062
|
|
|
2337
3063
|
|
|
2338
3064
|
|
|
2339
|
-
#### [Get Profile Type Relationships](https://developers.klaviyo.com/en/v2026-
|
|
3065
|
+
#### [Get Profile Type Relationships](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profile_type_relationships)
|
|
2340
3066
|
|
|
2341
3067
|
```ruby
|
|
2342
3068
|
KlaviyoAPI::CustomObjects.get_profile_type_relationships(id)
|
|
@@ -2354,7 +3080,7 @@ KlaviyoAPI::CustomObjects.get_profile_object_type_ids_for_object_type(id)
|
|
|
2354
3080
|
|
|
2355
3081
|
|
|
2356
3082
|
|
|
2357
|
-
#### [Get Record IDs for Object Type](https://developers.klaviyo.com/en/v2026-
|
|
3083
|
+
#### [Get Record IDs for Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/get_record_ids_for_object_type)
|
|
2358
3084
|
|
|
2359
3085
|
```ruby
|
|
2360
3086
|
KlaviyoAPI::CustomObjects.get_record_ids_for_object_type(id, opts)
|
|
@@ -2368,7 +3094,7 @@ KlaviyoAPI::CustomObjects.get_object_type_relationships_records(id, opts)
|
|
|
2368
3094
|
|
|
2369
3095
|
|
|
2370
3096
|
|
|
2371
|
-
#### [Get Records for Object Type](https://developers.klaviyo.com/en/v2026-
|
|
3097
|
+
#### [Get Records for Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/get_records_for_object_type)
|
|
2372
3098
|
|
|
2373
3099
|
```ruby
|
|
2374
3100
|
KlaviyoAPI::CustomObjects.get_records_for_object_type(id, opts)
|
|
@@ -2382,7 +3108,7 @@ KlaviyoAPI::CustomObjects.get_object_type_records(id, opts)
|
|
|
2382
3108
|
|
|
2383
3109
|
|
|
2384
3110
|
|
|
2385
|
-
#### [Get Schema Version IDs for Object Type](https://developers.klaviyo.com/en/v2026-
|
|
3111
|
+
#### [Get Schema Version IDs for Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/get_schema_version_ids_for_object_type)
|
|
2386
3112
|
|
|
2387
3113
|
```ruby
|
|
2388
3114
|
KlaviyoAPI::CustomObjects.get_schema_version_ids_for_object_type(id)
|
|
@@ -2396,7 +3122,7 @@ KlaviyoAPI::CustomObjects.get_object_type_relationships_schema_versions(id)
|
|
|
2396
3122
|
|
|
2397
3123
|
|
|
2398
3124
|
|
|
2399
|
-
#### [Get Schema Versions for Object Type](https://developers.klaviyo.com/en/v2026-
|
|
3125
|
+
#### [Get Schema Versions for Object Type](https://developers.klaviyo.com/en/v2026-10-15/reference/get_schema_versions_for_object_type)
|
|
2400
3126
|
|
|
2401
3127
|
```ruby
|
|
2402
3128
|
KlaviyoAPI::CustomObjects.get_schema_versions_for_object_type(id, opts)
|
|
@@ -2410,7 +3136,7 @@ KlaviyoAPI::CustomObjects.get_object_type_schema_versions(id, opts)
|
|
|
2410
3136
|
|
|
2411
3137
|
|
|
2412
3138
|
|
|
2413
|
-
#### [Get Source Mapping](https://developers.klaviyo.com/en/v2026-
|
|
3139
|
+
#### [Get Source Mapping](https://developers.klaviyo.com/en/v2026-10-15/reference/get_source_mapping)
|
|
2414
3140
|
|
|
2415
3141
|
```ruby
|
|
2416
3142
|
KlaviyoAPI::CustomObjects.get_source_mapping(id, opts)
|
|
@@ -2420,7 +3146,7 @@ KlaviyoAPI::CustomObjects.get_source_mapping(id, opts)
|
|
|
2420
3146
|
|
|
2421
3147
|
|
|
2422
3148
|
|
|
2423
|
-
#### [Get Source Mapping for Object Schema](https://developers.klaviyo.com/en/v2026-
|
|
3149
|
+
#### [Get Source Mapping for Object Schema](https://developers.klaviyo.com/en/v2026-10-15/reference/get_source_mapping_for_object_schema)
|
|
2424
3150
|
|
|
2425
3151
|
```ruby
|
|
2426
3152
|
KlaviyoAPI::CustomObjects.get_source_mapping_for_object_schema(id, opts)
|
|
@@ -2434,7 +3160,7 @@ KlaviyoAPI::CustomObjects.get_object_schema_source_mapping(id, opts)
|
|
|
2434
3160
|
|
|
2435
3161
|
|
|
2436
3162
|
|
|
2437
|
-
#### [Get Source Mapping ID for Object Schema](https://developers.klaviyo.com/en/v2026-
|
|
3163
|
+
#### [Get Source Mapping ID for Object Schema](https://developers.klaviyo.com/en/v2026-10-15/reference/get_source_mapping_id_for_object_schema)
|
|
2438
3164
|
|
|
2439
3165
|
```ruby
|
|
2440
3166
|
KlaviyoAPI::CustomObjects.get_source_mapping_id_for_object_schema(id)
|
|
@@ -2448,7 +3174,7 @@ KlaviyoAPI::CustomObjects.get_object_schema_relationships_source_mapping(id)
|
|
|
2448
3174
|
|
|
2449
3175
|
|
|
2450
3176
|
|
|
2451
|
-
#### [Update Object Schema](https://developers.klaviyo.com/en/v2026-
|
|
3177
|
+
#### [Update Object Schema](https://developers.klaviyo.com/en/v2026-10-15/reference/update_object_schema)
|
|
2452
3178
|
|
|
2453
3179
|
```ruby
|
|
2454
3180
|
KlaviyoAPI::CustomObjects.update_object_schema(id, body, opts)
|
|
@@ -2458,7 +3184,7 @@ KlaviyoAPI::CustomObjects.update_object_schema(id, body, opts)
|
|
|
2458
3184
|
|
|
2459
3185
|
|
|
2460
3186
|
|
|
2461
|
-
#### [Update Object Schema Relationship](https://developers.klaviyo.com/en/v2026-
|
|
3187
|
+
#### [Update Object Schema Relationship](https://developers.klaviyo.com/en/v2026-10-15/reference/update_object_schema_relationship)
|
|
2462
3188
|
|
|
2463
3189
|
```ruby
|
|
2464
3190
|
KlaviyoAPI::CustomObjects.update_object_schema_relationship(id, body)
|
|
@@ -2476,7 +3202,7 @@ KlaviyoAPI::CustomObjects.update_schemas_for_object_schema(id, body)
|
|
|
2476
3202
|
|
|
2477
3203
|
|
|
2478
3204
|
|
|
2479
|
-
#### [Update Profile Schema Relationship](https://developers.klaviyo.com/en/v2026-
|
|
3205
|
+
#### [Update Profile Schema Relationship](https://developers.klaviyo.com/en/v2026-10-15/reference/update_profile_schema_relationship)
|
|
2480
3206
|
|
|
2481
3207
|
```ruby
|
|
2482
3208
|
KlaviyoAPI::CustomObjects.update_profile_schema_relationship(id, body)
|
|
@@ -2494,7 +3220,7 @@ KlaviyoAPI::CustomObjects.update_profile_object_schemas_for_object_schema(id, bo
|
|
|
2494
3220
|
|
|
2495
3221
|
|
|
2496
3222
|
|
|
2497
|
-
#### [Update Source Mapping](https://developers.klaviyo.com/en/v2026-
|
|
3223
|
+
#### [Update Source Mapping](https://developers.klaviyo.com/en/v2026-10-15/reference/update_source_mapping)
|
|
2498
3224
|
|
|
2499
3225
|
```ruby
|
|
2500
3226
|
KlaviyoAPI::CustomObjects.update_source_mapping(id, body, opts)
|
|
@@ -2508,7 +3234,7 @@ KlaviyoAPI::CustomObjects.update_source_mapping(id, body, opts)
|
|
|
2508
3234
|
## Data Privacy
|
|
2509
3235
|
|
|
2510
3236
|
|
|
2511
|
-
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2026-
|
|
3237
|
+
#### [Request Profile Deletion](https://developers.klaviyo.com/en/v2026-10-15/reference/request_profile_deletion)
|
|
2512
3238
|
|
|
2513
3239
|
```ruby
|
|
2514
3240
|
KlaviyoAPI::DataPrivacy.request_profile_deletion(body)
|
|
@@ -2526,7 +3252,7 @@ KlaviyoAPI::DataPrivacy.create_data_privacy_deletion_job(body)
|
|
|
2526
3252
|
## Events
|
|
2527
3253
|
|
|
2528
3254
|
|
|
2529
|
-
#### [Bulk Create Events](https://developers.klaviyo.com/en/v2026-
|
|
3255
|
+
#### [Bulk Create Events](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_create_events)
|
|
2530
3256
|
|
|
2531
3257
|
```ruby
|
|
2532
3258
|
KlaviyoAPI::Events.bulk_create_events(body)
|
|
@@ -2540,7 +3266,7 @@ KlaviyoAPI::Events.create_event_bulk_create_job(body)
|
|
|
2540
3266
|
|
|
2541
3267
|
|
|
2542
3268
|
|
|
2543
|
-
#### [Create Event](https://developers.klaviyo.com/en/v2026-
|
|
3269
|
+
#### [Create Event](https://developers.klaviyo.com/en/v2026-10-15/reference/create_event)
|
|
2544
3270
|
|
|
2545
3271
|
```ruby
|
|
2546
3272
|
KlaviyoAPI::Events.create_event(body)
|
|
@@ -2550,7 +3276,7 @@ KlaviyoAPI::Events.create_event(body)
|
|
|
2550
3276
|
|
|
2551
3277
|
|
|
2552
3278
|
|
|
2553
|
-
#### [Get Event](https://developers.klaviyo.com/en/v2026-
|
|
3279
|
+
#### [Get Event](https://developers.klaviyo.com/en/v2026-10-15/reference/get_event)
|
|
2554
3280
|
|
|
2555
3281
|
```ruby
|
|
2556
3282
|
KlaviyoAPI::Events.get_event(id, opts)
|
|
@@ -2560,7 +3286,7 @@ KlaviyoAPI::Events.get_event(id, opts)
|
|
|
2560
3286
|
|
|
2561
3287
|
|
|
2562
3288
|
|
|
2563
|
-
#### [Get Events](https://developers.klaviyo.com/en/v2026-
|
|
3289
|
+
#### [Get Events](https://developers.klaviyo.com/en/v2026-10-15/reference/get_events)
|
|
2564
3290
|
|
|
2565
3291
|
```ruby
|
|
2566
3292
|
KlaviyoAPI::Events.get_events(opts)
|
|
@@ -2570,7 +3296,7 @@ KlaviyoAPI::Events.get_events(opts)
|
|
|
2570
3296
|
|
|
2571
3297
|
|
|
2572
3298
|
|
|
2573
|
-
#### [Get Metric for Event](https://developers.klaviyo.com/en/v2026-
|
|
3299
|
+
#### [Get Metric for Event](https://developers.klaviyo.com/en/v2026-10-15/reference/get_metric_for_event)
|
|
2574
3300
|
|
|
2575
3301
|
```ruby
|
|
2576
3302
|
KlaviyoAPI::Events.get_metric_for_event(id, opts)
|
|
@@ -2584,7 +3310,7 @@ KlaviyoAPI::Events.get_event_metric(id, opts)
|
|
|
2584
3310
|
|
|
2585
3311
|
|
|
2586
3312
|
|
|
2587
|
-
#### [Get Metric ID for Event](https://developers.klaviyo.com/en/v2026-
|
|
3313
|
+
#### [Get Metric ID for Event](https://developers.klaviyo.com/en/v2026-10-15/reference/get_metric_id_for_event)
|
|
2588
3314
|
|
|
2589
3315
|
```ruby
|
|
2590
3316
|
KlaviyoAPI::Events.get_metric_id_for_event(id)
|
|
@@ -2598,7 +3324,7 @@ KlaviyoAPI::Events.get_event_relationships_metric(id)
|
|
|
2598
3324
|
|
|
2599
3325
|
|
|
2600
3326
|
|
|
2601
|
-
#### [Get Profile for Event](https://developers.klaviyo.com/en/v2026-
|
|
3327
|
+
#### [Get Profile for Event](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profile_for_event)
|
|
2602
3328
|
|
|
2603
3329
|
```ruby
|
|
2604
3330
|
KlaviyoAPI::Events.get_profile_for_event(id, opts)
|
|
@@ -2612,7 +3338,7 @@ KlaviyoAPI::Events.get_event_profile(id, opts)
|
|
|
2612
3338
|
|
|
2613
3339
|
|
|
2614
3340
|
|
|
2615
|
-
#### [Get Profile ID for Event](https://developers.klaviyo.com/en/v2026-
|
|
3341
|
+
#### [Get Profile ID for Event](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profile_id_for_event)
|
|
2616
3342
|
|
|
2617
3343
|
```ruby
|
|
2618
3344
|
KlaviyoAPI::Events.get_profile_id_for_event(id)
|
|
@@ -2630,7 +3356,7 @@ KlaviyoAPI::Events.get_event_relationships_profile(id)
|
|
|
2630
3356
|
## Flows
|
|
2631
3357
|
|
|
2632
3358
|
|
|
2633
|
-
#### [Create Flow](https://developers.klaviyo.com/en/v2026-
|
|
3359
|
+
#### [Create Flow](https://developers.klaviyo.com/en/v2026-10-15/reference/create_flow)
|
|
2634
3360
|
|
|
2635
3361
|
```ruby
|
|
2636
3362
|
KlaviyoAPI::Flows.create_flow(body, opts)
|
|
@@ -2640,7 +3366,17 @@ KlaviyoAPI::Flows.create_flow(body, opts)
|
|
|
2640
3366
|
|
|
2641
3367
|
|
|
2642
3368
|
|
|
2643
|
-
#### [
|
|
3369
|
+
#### [Create Flow Action](https://developers.klaviyo.com/en/v2026-10-15/reference/create_flow_action)
|
|
3370
|
+
|
|
3371
|
+
```ruby
|
|
3372
|
+
KlaviyoAPI::Flows.create_flow_action(body, opts)
|
|
3373
|
+
```
|
|
3374
|
+
|
|
3375
|
+
|
|
3376
|
+
|
|
3377
|
+
|
|
3378
|
+
|
|
3379
|
+
#### [Delete Flow](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_flow)
|
|
2644
3380
|
|
|
2645
3381
|
```ruby
|
|
2646
3382
|
KlaviyoAPI::Flows.delete_flow(id)
|
|
@@ -2650,7 +3386,7 @@ KlaviyoAPI::Flows.delete_flow(id)
|
|
|
2650
3386
|
|
|
2651
3387
|
|
|
2652
3388
|
|
|
2653
|
-
#### [Delete Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
3389
|
+
#### [Delete Flow Action](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_flow_action)
|
|
2654
3390
|
|
|
2655
3391
|
```ruby
|
|
2656
3392
|
KlaviyoAPI::Flows.delete_flow_action(id)
|
|
@@ -2660,7 +3396,7 @@ KlaviyoAPI::Flows.delete_flow_action(id)
|
|
|
2660
3396
|
|
|
2661
3397
|
|
|
2662
3398
|
|
|
2663
|
-
#### [Get Action for Flow Message](https://developers.klaviyo.com/en/v2026-
|
|
3399
|
+
#### [Get Action for Flow Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_action_for_flow_message)
|
|
2664
3400
|
|
|
2665
3401
|
```ruby
|
|
2666
3402
|
KlaviyoAPI::Flows.get_action_for_flow_message(id, opts)
|
|
@@ -2674,7 +3410,7 @@ KlaviyoAPI::Flows.get_flow_message_action(id, opts)
|
|
|
2674
3410
|
|
|
2675
3411
|
|
|
2676
3412
|
|
|
2677
|
-
#### [Get Action ID for Flow Message](https://developers.klaviyo.com/en/v2026-
|
|
3413
|
+
#### [Get Action ID for Flow Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_action_id_for_flow_message)
|
|
2678
3414
|
|
|
2679
3415
|
```ruby
|
|
2680
3416
|
KlaviyoAPI::Flows.get_action_id_for_flow_message(id)
|
|
@@ -2688,7 +3424,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships_action(id)
|
|
|
2688
3424
|
|
|
2689
3425
|
|
|
2690
3426
|
|
|
2691
|
-
#### [Get Action IDs for Flow](https://developers.klaviyo.com/en/v2026-
|
|
3427
|
+
#### [Get Action IDs for Flow](https://developers.klaviyo.com/en/v2026-10-15/reference/get_action_ids_for_flow)
|
|
2692
3428
|
|
|
2693
3429
|
```ruby
|
|
2694
3430
|
KlaviyoAPI::Flows.get_action_ids_for_flow(id, opts)
|
|
@@ -2706,7 +3442,7 @@ KlaviyoAPI::Flows.get_flow_relationships_actions(id, opts)
|
|
|
2706
3442
|
|
|
2707
3443
|
|
|
2708
3444
|
|
|
2709
|
-
#### [Get Actions for Flow](https://developers.klaviyo.com/en/v2026-
|
|
3445
|
+
#### [Get Actions for Flow](https://developers.klaviyo.com/en/v2026-10-15/reference/get_actions_for_flow)
|
|
2710
3446
|
|
|
2711
3447
|
```ruby
|
|
2712
3448
|
KlaviyoAPI::Flows.get_actions_for_flow(id, opts)
|
|
@@ -2724,7 +3460,7 @@ KlaviyoAPI::Flows.get_flow_actions(id, opts)
|
|
|
2724
3460
|
|
|
2725
3461
|
|
|
2726
3462
|
|
|
2727
|
-
#### [Get Flow](https://developers.klaviyo.com/en/v2026-
|
|
3463
|
+
#### [Get Flow](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flow)
|
|
2728
3464
|
|
|
2729
3465
|
```ruby
|
|
2730
3466
|
KlaviyoAPI::Flows.get_flow(id, opts)
|
|
@@ -2734,7 +3470,7 @@ KlaviyoAPI::Flows.get_flow(id, opts)
|
|
|
2734
3470
|
|
|
2735
3471
|
|
|
2736
3472
|
|
|
2737
|
-
#### [Get Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
3473
|
+
#### [Get Flow Action](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flow_action)
|
|
2738
3474
|
|
|
2739
3475
|
```ruby
|
|
2740
3476
|
KlaviyoAPI::Flows.get_flow_action(id, opts)
|
|
@@ -2744,7 +3480,7 @@ KlaviyoAPI::Flows.get_flow_action(id, opts)
|
|
|
2744
3480
|
|
|
2745
3481
|
|
|
2746
3482
|
|
|
2747
|
-
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
3483
|
+
#### [Get Messages For Flow Action](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flow_action_messages)
|
|
2748
3484
|
|
|
2749
3485
|
```ruby
|
|
2750
3486
|
KlaviyoAPI::Flows.get_flow_action_messages(id, opts)
|
|
@@ -2758,7 +3494,7 @@ KlaviyoAPI::Flows.get_messages_for_flow_action(id, opts)
|
|
|
2758
3494
|
|
|
2759
3495
|
|
|
2760
3496
|
|
|
2761
|
-
#### [Get Flow for Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
3497
|
+
#### [Get Flow for Flow Action](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flow_for_flow_action)
|
|
2762
3498
|
|
|
2763
3499
|
```ruby
|
|
2764
3500
|
KlaviyoAPI::Flows.get_flow_for_flow_action(id, opts)
|
|
@@ -2772,7 +3508,7 @@ KlaviyoAPI::Flows.get_flow_action_flow(id, opts)
|
|
|
2772
3508
|
|
|
2773
3509
|
|
|
2774
3510
|
|
|
2775
|
-
#### [Get Flow ID for Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
3511
|
+
#### [Get Flow ID for Flow Action](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flow_id_for_flow_action)
|
|
2776
3512
|
|
|
2777
3513
|
```ruby
|
|
2778
3514
|
KlaviyoAPI::Flows.get_flow_id_for_flow_action(id)
|
|
@@ -2786,7 +3522,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_flow(id)
|
|
|
2786
3522
|
|
|
2787
3523
|
|
|
2788
3524
|
|
|
2789
|
-
#### [Get Flow Message](https://developers.klaviyo.com/en/v2026-
|
|
3525
|
+
#### [Get Flow Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flow_message)
|
|
2790
3526
|
|
|
2791
3527
|
```ruby
|
|
2792
3528
|
KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
@@ -2796,7 +3532,7 @@ KlaviyoAPI::Flows.get_flow_message(id, opts)
|
|
|
2796
3532
|
|
|
2797
3533
|
|
|
2798
3534
|
|
|
2799
|
-
#### [Get Flows](https://developers.klaviyo.com/en/v2026-
|
|
3535
|
+
#### [Get Flows](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flows)
|
|
2800
3536
|
|
|
2801
3537
|
```ruby
|
|
2802
3538
|
KlaviyoAPI::Flows.get_flows(opts)
|
|
@@ -2806,7 +3542,7 @@ KlaviyoAPI::Flows.get_flows(opts)
|
|
|
2806
3542
|
|
|
2807
3543
|
|
|
2808
3544
|
|
|
2809
|
-
#### [Get Message IDs for Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
3545
|
+
#### [Get Message IDs for Flow Action](https://developers.klaviyo.com/en/v2026-10-15/reference/get_message_ids_for_flow_action)
|
|
2810
3546
|
|
|
2811
3547
|
```ruby
|
|
2812
3548
|
KlaviyoAPI::Flows.get_message_ids_for_flow_action(id, opts)
|
|
@@ -2820,7 +3556,7 @@ KlaviyoAPI::Flows.get_flow_action_relationships_messages(id, opts)
|
|
|
2820
3556
|
|
|
2821
3557
|
|
|
2822
3558
|
|
|
2823
|
-
#### [Get Tag IDs for Flow](https://developers.klaviyo.com/en/v2026-
|
|
3559
|
+
#### [Get Tag IDs for Flow](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tag_ids_for_flow)
|
|
2824
3560
|
|
|
2825
3561
|
```ruby
|
|
2826
3562
|
KlaviyoAPI::Flows.get_tag_ids_for_flow(id)
|
|
@@ -2834,7 +3570,7 @@ KlaviyoAPI::Flows.get_flow_relationships_tags(id)
|
|
|
2834
3570
|
|
|
2835
3571
|
|
|
2836
3572
|
|
|
2837
|
-
#### [Get Tags for Flow](https://developers.klaviyo.com/en/v2026-
|
|
3573
|
+
#### [Get Tags for Flow](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tags_for_flow)
|
|
2838
3574
|
|
|
2839
3575
|
```ruby
|
|
2840
3576
|
KlaviyoAPI::Flows.get_tags_for_flow(id, opts)
|
|
@@ -2848,7 +3584,7 @@ KlaviyoAPI::Flows.get_flow_tags(id, opts)
|
|
|
2848
3584
|
|
|
2849
3585
|
|
|
2850
3586
|
|
|
2851
|
-
#### [Get Template for Flow Message](https://developers.klaviyo.com/en/v2026-
|
|
3587
|
+
#### [Get Template for Flow Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_template_for_flow_message)
|
|
2852
3588
|
|
|
2853
3589
|
```ruby
|
|
2854
3590
|
KlaviyoAPI::Flows.get_template_for_flow_message(id, opts)
|
|
@@ -2862,7 +3598,7 @@ KlaviyoAPI::Flows.get_flow_message_template(id, opts)
|
|
|
2862
3598
|
|
|
2863
3599
|
|
|
2864
3600
|
|
|
2865
|
-
#### [Get Template ID for Flow Message](https://developers.klaviyo.com/en/v2026-
|
|
3601
|
+
#### [Get Template ID for Flow Message](https://developers.klaviyo.com/en/v2026-10-15/reference/get_template_id_for_flow_message)
|
|
2866
3602
|
|
|
2867
3603
|
```ruby
|
|
2868
3604
|
KlaviyoAPI::Flows.get_template_id_for_flow_message(id)
|
|
@@ -2876,7 +3612,7 @@ KlaviyoAPI::Flows.get_flow_message_relationships_template(id)
|
|
|
2876
3612
|
|
|
2877
3613
|
|
|
2878
3614
|
|
|
2879
|
-
#### [Update Flow Status](https://developers.klaviyo.com/en/v2026-
|
|
3615
|
+
#### [Update Flow Status](https://developers.klaviyo.com/en/v2026-10-15/reference/update_flow)
|
|
2880
3616
|
|
|
2881
3617
|
```ruby
|
|
2882
3618
|
KlaviyoAPI::Flows.update_flow(id, body, opts)
|
|
@@ -2886,7 +3622,7 @@ KlaviyoAPI::Flows.update_flow(id, body, opts)
|
|
|
2886
3622
|
|
|
2887
3623
|
|
|
2888
3624
|
|
|
2889
|
-
#### [Update Flow Action](https://developers.klaviyo.com/en/v2026-
|
|
3625
|
+
#### [Update Flow Action](https://developers.klaviyo.com/en/v2026-10-15/reference/update_flow_action)
|
|
2890
3626
|
|
|
2891
3627
|
```ruby
|
|
2892
3628
|
KlaviyoAPI::Flows.update_flow_action(id, body, opts)
|
|
@@ -2900,7 +3636,7 @@ KlaviyoAPI::Flows.update_flow_action(id, body, opts)
|
|
|
2900
3636
|
## Forms
|
|
2901
3637
|
|
|
2902
3638
|
|
|
2903
|
-
#### [Create Form](https://developers.klaviyo.com/en/v2026-
|
|
3639
|
+
#### [Create Form](https://developers.klaviyo.com/en/v2026-10-15/reference/create_form)
|
|
2904
3640
|
|
|
2905
3641
|
```ruby
|
|
2906
3642
|
KlaviyoAPI::Forms.create_form(body, opts)
|
|
@@ -2910,7 +3646,7 @@ KlaviyoAPI::Forms.create_form(body, opts)
|
|
|
2910
3646
|
|
|
2911
3647
|
|
|
2912
3648
|
|
|
2913
|
-
#### [Delete Form](https://developers.klaviyo.com/en/v2026-
|
|
3649
|
+
#### [Delete Form](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_form)
|
|
2914
3650
|
|
|
2915
3651
|
```ruby
|
|
2916
3652
|
KlaviyoAPI::Forms.delete_form(id)
|
|
@@ -2920,7 +3656,7 @@ KlaviyoAPI::Forms.delete_form(id)
|
|
|
2920
3656
|
|
|
2921
3657
|
|
|
2922
3658
|
|
|
2923
|
-
#### [Get Form](https://developers.klaviyo.com/en/v2026-
|
|
3659
|
+
#### [Get Form](https://developers.klaviyo.com/en/v2026-10-15/reference/get_form)
|
|
2924
3660
|
|
|
2925
3661
|
```ruby
|
|
2926
3662
|
KlaviyoAPI::Forms.get_form(id, opts)
|
|
@@ -2930,7 +3666,7 @@ KlaviyoAPI::Forms.get_form(id, opts)
|
|
|
2930
3666
|
|
|
2931
3667
|
|
|
2932
3668
|
|
|
2933
|
-
#### [Get Form for Form Version](https://developers.klaviyo.com/en/v2026-
|
|
3669
|
+
#### [Get Form for Form Version](https://developers.klaviyo.com/en/v2026-10-15/reference/get_form_for_form_version)
|
|
2934
3670
|
|
|
2935
3671
|
```ruby
|
|
2936
3672
|
KlaviyoAPI::Forms.get_form_for_form_version(id, opts)
|
|
@@ -2944,7 +3680,7 @@ KlaviyoAPI::Forms.get_form_version_form(id, opts)
|
|
|
2944
3680
|
|
|
2945
3681
|
|
|
2946
3682
|
|
|
2947
|
-
#### [Get Form ID for Form Version](https://developers.klaviyo.com/en/v2026-
|
|
3683
|
+
#### [Get Form ID for Form Version](https://developers.klaviyo.com/en/v2026-10-15/reference/get_form_id_for_form_version)
|
|
2948
3684
|
|
|
2949
3685
|
```ruby
|
|
2950
3686
|
KlaviyoAPI::Forms.get_form_id_for_form_version(id)
|
|
@@ -2958,56 +3694,94 @@ KlaviyoAPI::Forms.get_form_version_relationships_form(id)
|
|
|
2958
3694
|
|
|
2959
3695
|
|
|
2960
3696
|
|
|
2961
|
-
#### [Get Form Version](https://developers.klaviyo.com/en/v2026-
|
|
3697
|
+
#### [Get Form Version](https://developers.klaviyo.com/en/v2026-10-15/reference/get_form_version)
|
|
3698
|
+
|
|
3699
|
+
```ruby
|
|
3700
|
+
KlaviyoAPI::Forms.get_form_version(id, opts)
|
|
3701
|
+
```
|
|
3702
|
+
|
|
3703
|
+
|
|
3704
|
+
|
|
3705
|
+
|
|
3706
|
+
|
|
3707
|
+
#### [Get Forms](https://developers.klaviyo.com/en/v2026-10-15/reference/get_forms)
|
|
3708
|
+
|
|
3709
|
+
```ruby
|
|
3710
|
+
KlaviyoAPI::Forms.get_forms(opts)
|
|
3711
|
+
```
|
|
3712
|
+
|
|
3713
|
+
|
|
3714
|
+
|
|
3715
|
+
|
|
3716
|
+
|
|
3717
|
+
#### [Get Version IDs for Form](https://developers.klaviyo.com/en/v2026-10-15/reference/get_version_ids_for_form)
|
|
3718
|
+
|
|
3719
|
+
```ruby
|
|
3720
|
+
KlaviyoAPI::Forms.get_version_ids_for_form(id, opts)
|
|
3721
|
+
```
|
|
3722
|
+
##### Method alias:
|
|
3723
|
+
```ruby
|
|
3724
|
+
KlaviyoAPI::Forms.get_form_relationships_form_versions(id, opts)
|
|
3725
|
+
```
|
|
3726
|
+
##### Method alias:
|
|
3727
|
+
```ruby
|
|
3728
|
+
KlaviyoAPI::Forms.get_form_relationships_versions(id, opts)
|
|
3729
|
+
```
|
|
3730
|
+
|
|
3731
|
+
|
|
3732
|
+
|
|
3733
|
+
|
|
3734
|
+
|
|
3735
|
+
#### [Get Versions for Form](https://developers.klaviyo.com/en/v2026-10-15/reference/get_versions_for_form)
|
|
3736
|
+
|
|
3737
|
+
```ruby
|
|
3738
|
+
KlaviyoAPI::Forms.get_versions_for_form(id, opts)
|
|
3739
|
+
```
|
|
3740
|
+
##### Method alias:
|
|
3741
|
+
```ruby
|
|
3742
|
+
KlaviyoAPI::Forms.get_form_form_versions(id, opts)
|
|
3743
|
+
```
|
|
3744
|
+
##### Method alias:
|
|
3745
|
+
```ruby
|
|
3746
|
+
KlaviyoAPI::Forms.get_form_versions(id, opts)
|
|
3747
|
+
```
|
|
3748
|
+
|
|
3749
|
+
|
|
3750
|
+
|
|
3751
|
+
|
|
3752
|
+
|
|
3753
|
+
#### [Publish Form](https://developers.klaviyo.com/en/v2026-10-15/reference/publish_form)
|
|
2962
3754
|
|
|
2963
3755
|
```ruby
|
|
2964
|
-
KlaviyoAPI::Forms.
|
|
3756
|
+
KlaviyoAPI::Forms.publish_form(body, opts)
|
|
2965
3757
|
```
|
|
2966
|
-
|
|
2967
|
-
|
|
2968
|
-
|
|
2969
|
-
|
|
2970
|
-
|
|
2971
|
-
#### [Get Forms](https://developers.klaviyo.com/en/v2026-07-15/reference/get_forms)
|
|
2972
|
-
|
|
3758
|
+
##### Method alias:
|
|
2973
3759
|
```ruby
|
|
2974
|
-
KlaviyoAPI::Forms.
|
|
3760
|
+
KlaviyoAPI::Forms.create_form_publish_job(body, opts)
|
|
2975
3761
|
```
|
|
2976
3762
|
|
|
2977
3763
|
|
|
2978
3764
|
|
|
2979
3765
|
|
|
2980
3766
|
|
|
2981
|
-
#### [
|
|
3767
|
+
#### [Unpublish Form](https://developers.klaviyo.com/en/v2026-10-15/reference/unpublish_form)
|
|
2982
3768
|
|
|
2983
3769
|
```ruby
|
|
2984
|
-
KlaviyoAPI::Forms.
|
|
2985
|
-
```
|
|
2986
|
-
##### Method alias:
|
|
2987
|
-
```ruby
|
|
2988
|
-
KlaviyoAPI::Forms.get_form_relationships_form_versions(id, opts)
|
|
3770
|
+
KlaviyoAPI::Forms.unpublish_form(body, opts)
|
|
2989
3771
|
```
|
|
2990
3772
|
##### Method alias:
|
|
2991
3773
|
```ruby
|
|
2992
|
-
KlaviyoAPI::Forms.
|
|
3774
|
+
KlaviyoAPI::Forms.create_form_unpublish_job(body, opts)
|
|
2993
3775
|
```
|
|
2994
3776
|
|
|
2995
3777
|
|
|
2996
3778
|
|
|
2997
3779
|
|
|
2998
3780
|
|
|
2999
|
-
#### [
|
|
3781
|
+
#### [Update Form](https://developers.klaviyo.com/en/v2026-10-15/reference/update_form)
|
|
3000
3782
|
|
|
3001
3783
|
```ruby
|
|
3002
|
-
KlaviyoAPI::Forms.
|
|
3003
|
-
```
|
|
3004
|
-
##### Method alias:
|
|
3005
|
-
```ruby
|
|
3006
|
-
KlaviyoAPI::Forms.get_form_form_versions(id, opts)
|
|
3007
|
-
```
|
|
3008
|
-
##### Method alias:
|
|
3009
|
-
```ruby
|
|
3010
|
-
KlaviyoAPI::Forms.get_form_versions(id, opts)
|
|
3784
|
+
KlaviyoAPI::Forms.update_form(id, body, opts)
|
|
3011
3785
|
```
|
|
3012
3786
|
|
|
3013
3787
|
|
|
@@ -3018,7 +3792,7 @@ KlaviyoAPI::Forms.get_form_versions(id, opts)
|
|
|
3018
3792
|
## Images
|
|
3019
3793
|
|
|
3020
3794
|
|
|
3021
|
-
#### [Get Image](https://developers.klaviyo.com/en/v2026-
|
|
3795
|
+
#### [Get Image](https://developers.klaviyo.com/en/v2026-10-15/reference/get_image)
|
|
3022
3796
|
|
|
3023
3797
|
```ruby
|
|
3024
3798
|
KlaviyoAPI::Images.get_image(id, opts)
|
|
@@ -3028,7 +3802,7 @@ KlaviyoAPI::Images.get_image(id, opts)
|
|
|
3028
3802
|
|
|
3029
3803
|
|
|
3030
3804
|
|
|
3031
|
-
#### [Get Images](https://developers.klaviyo.com/en/v2026-
|
|
3805
|
+
#### [Get Images](https://developers.klaviyo.com/en/v2026-10-15/reference/get_images)
|
|
3032
3806
|
|
|
3033
3807
|
```ruby
|
|
3034
3808
|
KlaviyoAPI::Images.get_images(opts)
|
|
@@ -3038,7 +3812,7 @@ KlaviyoAPI::Images.get_images(opts)
|
|
|
3038
3812
|
|
|
3039
3813
|
|
|
3040
3814
|
|
|
3041
|
-
#### [Update Image](https://developers.klaviyo.com/en/v2026-
|
|
3815
|
+
#### [Update Image](https://developers.klaviyo.com/en/v2026-10-15/reference/update_image)
|
|
3042
3816
|
|
|
3043
3817
|
```ruby
|
|
3044
3818
|
KlaviyoAPI::Images.update_image(id, body, opts)
|
|
@@ -3048,7 +3822,7 @@ KlaviyoAPI::Images.update_image(id, body, opts)
|
|
|
3048
3822
|
|
|
3049
3823
|
|
|
3050
3824
|
|
|
3051
|
-
#### [Upload Image From File](https://developers.klaviyo.com/en/v2026-
|
|
3825
|
+
#### [Upload Image From File](https://developers.klaviyo.com/en/v2026-10-15/reference/upload_image_from_file)
|
|
3052
3826
|
|
|
3053
3827
|
```ruby
|
|
3054
3828
|
KlaviyoAPI::Images.upload_image_from_file(file, opts)
|
|
@@ -3062,7 +3836,7 @@ KlaviyoAPI::Images.create_image_upload(file, opts)
|
|
|
3062
3836
|
|
|
3063
3837
|
|
|
3064
3838
|
|
|
3065
|
-
#### [Upload Image From URL](https://developers.klaviyo.com/en/v2026-
|
|
3839
|
+
#### [Upload Image From URL](https://developers.klaviyo.com/en/v2026-10-15/reference/upload_image_from_url)
|
|
3066
3840
|
|
|
3067
3841
|
```ruby
|
|
3068
3842
|
KlaviyoAPI::Images.upload_image_from_url(body, opts)
|
|
@@ -3080,7 +3854,7 @@ KlaviyoAPI::Images.create_image(body, opts)
|
|
|
3080
3854
|
## Lists
|
|
3081
3855
|
|
|
3082
3856
|
|
|
3083
|
-
#### [Add Profiles to List](https://developers.klaviyo.com/en/v2026-
|
|
3857
|
+
#### [Add Profiles to List](https://developers.klaviyo.com/en/v2026-10-15/reference/add_profiles_to_list)
|
|
3084
3858
|
|
|
3085
3859
|
```ruby
|
|
3086
3860
|
KlaviyoAPI::Lists.add_profiles_to_list(id, body)
|
|
@@ -3102,7 +3876,7 @@ KlaviyoAPI::Lists.create_list_relationships_profiles(id, body)
|
|
|
3102
3876
|
|
|
3103
3877
|
|
|
3104
3878
|
|
|
3105
|
-
#### [Create List](https://developers.klaviyo.com/en/v2026-
|
|
3879
|
+
#### [Create List](https://developers.klaviyo.com/en/v2026-10-15/reference/create_list)
|
|
3106
3880
|
|
|
3107
3881
|
```ruby
|
|
3108
3882
|
KlaviyoAPI::Lists.create_list(body, opts)
|
|
@@ -3112,7 +3886,7 @@ KlaviyoAPI::Lists.create_list(body, opts)
|
|
|
3112
3886
|
|
|
3113
3887
|
|
|
3114
3888
|
|
|
3115
|
-
#### [Delete List](https://developers.klaviyo.com/en/v2026-
|
|
3889
|
+
#### [Delete List](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_list)
|
|
3116
3890
|
|
|
3117
3891
|
```ruby
|
|
3118
3892
|
KlaviyoAPI::Lists.delete_list(id)
|
|
@@ -3122,7 +3896,7 @@ KlaviyoAPI::Lists.delete_list(id)
|
|
|
3122
3896
|
|
|
3123
3897
|
|
|
3124
3898
|
|
|
3125
|
-
#### [Get Flows Triggered by List](https://developers.klaviyo.com/en/v2026-
|
|
3899
|
+
#### [Get Flows Triggered by List](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flows_triggered_by_list)
|
|
3126
3900
|
|
|
3127
3901
|
```ruby
|
|
3128
3902
|
KlaviyoAPI::Lists.get_flows_triggered_by_list(id, opts)
|
|
@@ -3140,7 +3914,7 @@ KlaviyoAPI::Lists.get_list_flow_triggers(id, opts)
|
|
|
3140
3914
|
|
|
3141
3915
|
|
|
3142
3916
|
|
|
3143
|
-
#### [Get IDs for Flows Triggered by List](https://developers.klaviyo.com/en/v2026-
|
|
3917
|
+
#### [Get IDs for Flows Triggered by List](https://developers.klaviyo.com/en/v2026-10-15/reference/get_ids_for_flows_triggered_by_list)
|
|
3144
3918
|
|
|
3145
3919
|
```ruby
|
|
3146
3920
|
KlaviyoAPI::Lists.get_ids_for_flows_triggered_by_list(id)
|
|
@@ -3158,7 +3932,7 @@ KlaviyoAPI::Lists.get_list_relationships_flow_triggers(id)
|
|
|
3158
3932
|
|
|
3159
3933
|
|
|
3160
3934
|
|
|
3161
|
-
#### [Get List](https://developers.klaviyo.com/en/v2026-
|
|
3935
|
+
#### [Get List](https://developers.klaviyo.com/en/v2026-10-15/reference/get_list)
|
|
3162
3936
|
|
|
3163
3937
|
```ruby
|
|
3164
3938
|
KlaviyoAPI::Lists.get_list(id, opts)
|
|
@@ -3168,7 +3942,7 @@ KlaviyoAPI::Lists.get_list(id, opts)
|
|
|
3168
3942
|
|
|
3169
3943
|
|
|
3170
3944
|
|
|
3171
|
-
#### [Get Lists](https://developers.klaviyo.com/en/v2026-
|
|
3945
|
+
#### [Get Lists](https://developers.klaviyo.com/en/v2026-10-15/reference/get_lists)
|
|
3172
3946
|
|
|
3173
3947
|
```ruby
|
|
3174
3948
|
KlaviyoAPI::Lists.get_lists(opts)
|
|
@@ -3178,7 +3952,7 @@ KlaviyoAPI::Lists.get_lists(opts)
|
|
|
3178
3952
|
|
|
3179
3953
|
|
|
3180
3954
|
|
|
3181
|
-
#### [Get Profile IDs for List](https://developers.klaviyo.com/en/v2026-
|
|
3955
|
+
#### [Get Profile IDs for List](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profile_ids_for_list)
|
|
3182
3956
|
|
|
3183
3957
|
```ruby
|
|
3184
3958
|
KlaviyoAPI::Lists.get_profile_ids_for_list(id, opts)
|
|
@@ -3192,7 +3966,7 @@ KlaviyoAPI::Lists.get_list_relationships_profiles(id, opts)
|
|
|
3192
3966
|
|
|
3193
3967
|
|
|
3194
3968
|
|
|
3195
|
-
#### [Get Profiles for List](https://developers.klaviyo.com/en/v2026-
|
|
3969
|
+
#### [Get Profiles for List](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profiles_for_list)
|
|
3196
3970
|
|
|
3197
3971
|
```ruby
|
|
3198
3972
|
KlaviyoAPI::Lists.get_profiles_for_list(id, opts)
|
|
@@ -3206,7 +3980,7 @@ KlaviyoAPI::Lists.get_list_profiles(id, opts)
|
|
|
3206
3980
|
|
|
3207
3981
|
|
|
3208
3982
|
|
|
3209
|
-
#### [Get Tag IDs for List](https://developers.klaviyo.com/en/v2026-
|
|
3983
|
+
#### [Get Tag IDs for List](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tag_ids_for_list)
|
|
3210
3984
|
|
|
3211
3985
|
```ruby
|
|
3212
3986
|
KlaviyoAPI::Lists.get_tag_ids_for_list(id)
|
|
@@ -3220,7 +3994,7 @@ KlaviyoAPI::Lists.get_list_relationships_tags(id)
|
|
|
3220
3994
|
|
|
3221
3995
|
|
|
3222
3996
|
|
|
3223
|
-
#### [Get Tags for List](https://developers.klaviyo.com/en/v2026-
|
|
3997
|
+
#### [Get Tags for List](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tags_for_list)
|
|
3224
3998
|
|
|
3225
3999
|
```ruby
|
|
3226
4000
|
KlaviyoAPI::Lists.get_tags_for_list(id, opts)
|
|
@@ -3234,7 +4008,7 @@ KlaviyoAPI::Lists.get_list_tags(id, opts)
|
|
|
3234
4008
|
|
|
3235
4009
|
|
|
3236
4010
|
|
|
3237
|
-
#### [Remove Profiles from List](https://developers.klaviyo.com/en/v2026-
|
|
4011
|
+
#### [Remove Profiles from List](https://developers.klaviyo.com/en/v2026-10-15/reference/remove_profiles_from_list)
|
|
3238
4012
|
|
|
3239
4013
|
```ruby
|
|
3240
4014
|
KlaviyoAPI::Lists.remove_profiles_from_list(id, body)
|
|
@@ -3252,7 +4026,7 @@ KlaviyoAPI::Lists.delete_list_relationships_profiles(id, body)
|
|
|
3252
4026
|
|
|
3253
4027
|
|
|
3254
4028
|
|
|
3255
|
-
#### [Update List](https://developers.klaviyo.com/en/v2026-
|
|
4029
|
+
#### [Update List](https://developers.klaviyo.com/en/v2026-10-15/reference/update_list)
|
|
3256
4030
|
|
|
3257
4031
|
```ruby
|
|
3258
4032
|
KlaviyoAPI::Lists.update_list(id, body, opts)
|
|
@@ -3266,7 +4040,7 @@ KlaviyoAPI::Lists.update_list(id, body, opts)
|
|
|
3266
4040
|
## Metrics
|
|
3267
4041
|
|
|
3268
4042
|
|
|
3269
|
-
#### [Create Custom Metric](https://developers.klaviyo.com/en/v2026-
|
|
4043
|
+
#### [Create Custom Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/create_custom_metric)
|
|
3270
4044
|
|
|
3271
4045
|
```ruby
|
|
3272
4046
|
KlaviyoAPI::Metrics.create_custom_metric(body, opts)
|
|
@@ -3276,7 +4050,7 @@ KlaviyoAPI::Metrics.create_custom_metric(body, opts)
|
|
|
3276
4050
|
|
|
3277
4051
|
|
|
3278
4052
|
|
|
3279
|
-
#### [Delete Custom Metric](https://developers.klaviyo.com/en/v2026-
|
|
4053
|
+
#### [Delete Custom Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_custom_metric)
|
|
3280
4054
|
|
|
3281
4055
|
```ruby
|
|
3282
4056
|
KlaviyoAPI::Metrics.delete_custom_metric(id)
|
|
@@ -3286,7 +4060,7 @@ KlaviyoAPI::Metrics.delete_custom_metric(id)
|
|
|
3286
4060
|
|
|
3287
4061
|
|
|
3288
4062
|
|
|
3289
|
-
#### [Get Custom Metric](https://developers.klaviyo.com/en/v2026-
|
|
4063
|
+
#### [Get Custom Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_custom_metric)
|
|
3290
4064
|
|
|
3291
4065
|
```ruby
|
|
3292
4066
|
KlaviyoAPI::Metrics.get_custom_metric(id, opts)
|
|
@@ -3296,7 +4070,7 @@ KlaviyoAPI::Metrics.get_custom_metric(id, opts)
|
|
|
3296
4070
|
|
|
3297
4071
|
|
|
3298
4072
|
|
|
3299
|
-
#### [Get Custom Metric for Mapped Metric](https://developers.klaviyo.com/en/v2026-
|
|
4073
|
+
#### [Get Custom Metric for Mapped Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_custom_metric_for_mapped_metric)
|
|
3300
4074
|
|
|
3301
4075
|
```ruby
|
|
3302
4076
|
KlaviyoAPI::Metrics.get_custom_metric_for_mapped_metric(id, opts)
|
|
@@ -3310,7 +4084,7 @@ KlaviyoAPI::Metrics.get_mapped_metric_custom_metric(id, opts)
|
|
|
3310
4084
|
|
|
3311
4085
|
|
|
3312
4086
|
|
|
3313
|
-
#### [Get Custom Metric ID for Mapped Metric](https://developers.klaviyo.com/en/v2026-
|
|
4087
|
+
#### [Get Custom Metric ID for Mapped Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_custom_metric_id_for_mapped_metric)
|
|
3314
4088
|
|
|
3315
4089
|
```ruby
|
|
3316
4090
|
KlaviyoAPI::Metrics.get_custom_metric_id_for_mapped_metric(id)
|
|
@@ -3324,7 +4098,7 @@ KlaviyoAPI::Metrics.get_mapped_metric_relationships_custom_metric(id)
|
|
|
3324
4098
|
|
|
3325
4099
|
|
|
3326
4100
|
|
|
3327
|
-
#### [Get Custom Metrics](https://developers.klaviyo.com/en/v2026-
|
|
4101
|
+
#### [Get Custom Metrics](https://developers.klaviyo.com/en/v2026-10-15/reference/get_custom_metrics)
|
|
3328
4102
|
|
|
3329
4103
|
```ruby
|
|
3330
4104
|
KlaviyoAPI::Metrics.get_custom_metrics(opts)
|
|
@@ -3334,7 +4108,7 @@ KlaviyoAPI::Metrics.get_custom_metrics(opts)
|
|
|
3334
4108
|
|
|
3335
4109
|
|
|
3336
4110
|
|
|
3337
|
-
#### [Get Flows Triggered by Metric](https://developers.klaviyo.com/en/v2026-
|
|
4111
|
+
#### [Get Flows Triggered by Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flows_triggered_by_metric)
|
|
3338
4112
|
|
|
3339
4113
|
```ruby
|
|
3340
4114
|
KlaviyoAPI::Metrics.get_flows_triggered_by_metric(id, opts)
|
|
@@ -3352,7 +4126,7 @@ KlaviyoAPI::Metrics.get_metric_flow_triggers(id, opts)
|
|
|
3352
4126
|
|
|
3353
4127
|
|
|
3354
4128
|
|
|
3355
|
-
#### [Get IDs for Flows Triggered by Metric](https://developers.klaviyo.com/en/v2026-
|
|
4129
|
+
#### [Get IDs for Flows Triggered by Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_ids_for_flows_triggered_by_metric)
|
|
3356
4130
|
|
|
3357
4131
|
```ruby
|
|
3358
4132
|
KlaviyoAPI::Metrics.get_ids_for_flows_triggered_by_metric(id)
|
|
@@ -3370,7 +4144,7 @@ KlaviyoAPI::Metrics.get_metric_relationships_flow_triggers(id)
|
|
|
3370
4144
|
|
|
3371
4145
|
|
|
3372
4146
|
|
|
3373
|
-
#### [Get Mapped Metric](https://developers.klaviyo.com/en/v2026-
|
|
4147
|
+
#### [Get Mapped Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_mapped_metric)
|
|
3374
4148
|
|
|
3375
4149
|
```ruby
|
|
3376
4150
|
KlaviyoAPI::Metrics.get_mapped_metric(id, opts)
|
|
@@ -3380,7 +4154,7 @@ KlaviyoAPI::Metrics.get_mapped_metric(id, opts)
|
|
|
3380
4154
|
|
|
3381
4155
|
|
|
3382
4156
|
|
|
3383
|
-
#### [Get Mapped Metrics](https://developers.klaviyo.com/en/v2026-
|
|
4157
|
+
#### [Get Mapped Metrics](https://developers.klaviyo.com/en/v2026-10-15/reference/get_mapped_metrics)
|
|
3384
4158
|
|
|
3385
4159
|
```ruby
|
|
3386
4160
|
KlaviyoAPI::Metrics.get_mapped_metrics(opts)
|
|
@@ -3390,7 +4164,7 @@ KlaviyoAPI::Metrics.get_mapped_metrics(opts)
|
|
|
3390
4164
|
|
|
3391
4165
|
|
|
3392
4166
|
|
|
3393
|
-
#### [Get Metric](https://developers.klaviyo.com/en/v2026-
|
|
4167
|
+
#### [Get Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_metric)
|
|
3394
4168
|
|
|
3395
4169
|
```ruby
|
|
3396
4170
|
KlaviyoAPI::Metrics.get_metric(id, opts)
|
|
@@ -3400,7 +4174,7 @@ KlaviyoAPI::Metrics.get_metric(id, opts)
|
|
|
3400
4174
|
|
|
3401
4175
|
|
|
3402
4176
|
|
|
3403
|
-
#### [Get Metric for Mapped Metric](https://developers.klaviyo.com/en/v2026-
|
|
4177
|
+
#### [Get Metric for Mapped Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_metric_for_mapped_metric)
|
|
3404
4178
|
|
|
3405
4179
|
```ruby
|
|
3406
4180
|
KlaviyoAPI::Metrics.get_metric_for_mapped_metric(id, opts)
|
|
@@ -3414,7 +4188,7 @@ KlaviyoAPI::Metrics.get_mapped_metric_metric(id, opts)
|
|
|
3414
4188
|
|
|
3415
4189
|
|
|
3416
4190
|
|
|
3417
|
-
#### [Get Metric for Metric Property](https://developers.klaviyo.com/en/v2026-
|
|
4191
|
+
#### [Get Metric for Metric Property](https://developers.klaviyo.com/en/v2026-10-15/reference/get_metric_for_metric_property)
|
|
3418
4192
|
|
|
3419
4193
|
```ruby
|
|
3420
4194
|
KlaviyoAPI::Metrics.get_metric_for_metric_property(id, opts)
|
|
@@ -3428,7 +4202,7 @@ KlaviyoAPI::Metrics.get_metric_property_metric(id, opts)
|
|
|
3428
4202
|
|
|
3429
4203
|
|
|
3430
4204
|
|
|
3431
|
-
#### [Get Metric ID for Mapped Metric](https://developers.klaviyo.com/en/v2026-
|
|
4205
|
+
#### [Get Metric ID for Mapped Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_metric_id_for_mapped_metric)
|
|
3432
4206
|
|
|
3433
4207
|
```ruby
|
|
3434
4208
|
KlaviyoAPI::Metrics.get_metric_id_for_mapped_metric(id)
|
|
@@ -3442,7 +4216,7 @@ KlaviyoAPI::Metrics.get_mapped_metric_relationships_metric(id)
|
|
|
3442
4216
|
|
|
3443
4217
|
|
|
3444
4218
|
|
|
3445
|
-
#### [Get Metric ID for Metric Property](https://developers.klaviyo.com/en/v2026-
|
|
4219
|
+
#### [Get Metric ID for Metric Property](https://developers.klaviyo.com/en/v2026-10-15/reference/get_metric_id_for_metric_property)
|
|
3446
4220
|
|
|
3447
4221
|
```ruby
|
|
3448
4222
|
KlaviyoAPI::Metrics.get_metric_id_for_metric_property(id)
|
|
@@ -3456,7 +4230,7 @@ KlaviyoAPI::Metrics.get_metric_property_relationships_metric(id)
|
|
|
3456
4230
|
|
|
3457
4231
|
|
|
3458
4232
|
|
|
3459
|
-
#### [Get Metric IDs for Custom Metric](https://developers.klaviyo.com/en/v2026-
|
|
4233
|
+
#### [Get Metric IDs for Custom Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_metric_ids_for_custom_metric)
|
|
3460
4234
|
|
|
3461
4235
|
```ruby
|
|
3462
4236
|
KlaviyoAPI::Metrics.get_metric_ids_for_custom_metric(id)
|
|
@@ -3470,7 +4244,7 @@ KlaviyoAPI::Metrics.get_custom_metric_relationships_metrics(id)
|
|
|
3470
4244
|
|
|
3471
4245
|
|
|
3472
4246
|
|
|
3473
|
-
#### [Get Metric Property](https://developers.klaviyo.com/en/v2026-
|
|
4247
|
+
#### [Get Metric Property](https://developers.klaviyo.com/en/v2026-10-15/reference/get_metric_property)
|
|
3474
4248
|
|
|
3475
4249
|
```ruby
|
|
3476
4250
|
KlaviyoAPI::Metrics.get_metric_property(id, opts)
|
|
@@ -3480,7 +4254,7 @@ KlaviyoAPI::Metrics.get_metric_property(id, opts)
|
|
|
3480
4254
|
|
|
3481
4255
|
|
|
3482
4256
|
|
|
3483
|
-
#### [Get Metrics](https://developers.klaviyo.com/en/v2026-
|
|
4257
|
+
#### [Get Metrics](https://developers.klaviyo.com/en/v2026-10-15/reference/get_metrics)
|
|
3484
4258
|
|
|
3485
4259
|
```ruby
|
|
3486
4260
|
KlaviyoAPI::Metrics.get_metrics(opts)
|
|
@@ -3490,7 +4264,7 @@ KlaviyoAPI::Metrics.get_metrics(opts)
|
|
|
3490
4264
|
|
|
3491
4265
|
|
|
3492
4266
|
|
|
3493
|
-
#### [Get Metrics for Custom Metric](https://developers.klaviyo.com/en/v2026-
|
|
4267
|
+
#### [Get Metrics for Custom Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_metrics_for_custom_metric)
|
|
3494
4268
|
|
|
3495
4269
|
```ruby
|
|
3496
4270
|
KlaviyoAPI::Metrics.get_metrics_for_custom_metric(id, opts)
|
|
@@ -3504,7 +4278,7 @@ KlaviyoAPI::Metrics.get_custom_metric_metrics(id, opts)
|
|
|
3504
4278
|
|
|
3505
4279
|
|
|
3506
4280
|
|
|
3507
|
-
#### [Get Properties for Metric](https://developers.klaviyo.com/en/v2026-
|
|
4281
|
+
#### [Get Properties for Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_properties_for_metric)
|
|
3508
4282
|
|
|
3509
4283
|
```ruby
|
|
3510
4284
|
KlaviyoAPI::Metrics.get_properties_for_metric(id, opts)
|
|
@@ -3522,7 +4296,7 @@ KlaviyoAPI::Metrics.get_metric_properties(id, opts)
|
|
|
3522
4296
|
|
|
3523
4297
|
|
|
3524
4298
|
|
|
3525
|
-
#### [Get Property IDs for Metric](https://developers.klaviyo.com/en/v2026-
|
|
4299
|
+
#### [Get Property IDs for Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/get_property_ids_for_metric)
|
|
3526
4300
|
|
|
3527
4301
|
```ruby
|
|
3528
4302
|
KlaviyoAPI::Metrics.get_property_ids_for_metric(id)
|
|
@@ -3540,7 +4314,7 @@ KlaviyoAPI::Metrics.get_metric_relationships_properties(id)
|
|
|
3540
4314
|
|
|
3541
4315
|
|
|
3542
4316
|
|
|
3543
|
-
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2026-
|
|
4317
|
+
#### [Query Metric Aggregates](https://developers.klaviyo.com/en/v2026-10-15/reference/query_metric_aggregates)
|
|
3544
4318
|
|
|
3545
4319
|
```ruby
|
|
3546
4320
|
KlaviyoAPI::Metrics.query_metric_aggregates(body, opts)
|
|
@@ -3554,7 +4328,7 @@ KlaviyoAPI::Metrics.create_metric_aggregate(body, opts)
|
|
|
3554
4328
|
|
|
3555
4329
|
|
|
3556
4330
|
|
|
3557
|
-
#### [Update Custom Metric](https://developers.klaviyo.com/en/v2026-
|
|
4331
|
+
#### [Update Custom Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/update_custom_metric)
|
|
3558
4332
|
|
|
3559
4333
|
```ruby
|
|
3560
4334
|
KlaviyoAPI::Metrics.update_custom_metric(id, body, opts)
|
|
@@ -3564,7 +4338,7 @@ KlaviyoAPI::Metrics.update_custom_metric(id, body, opts)
|
|
|
3564
4338
|
|
|
3565
4339
|
|
|
3566
4340
|
|
|
3567
|
-
#### [Update Mapped Metric](https://developers.klaviyo.com/en/v2026-
|
|
4341
|
+
#### [Update Mapped Metric](https://developers.klaviyo.com/en/v2026-10-15/reference/update_mapped_metric)
|
|
3568
4342
|
|
|
3569
4343
|
```ruby
|
|
3570
4344
|
KlaviyoAPI::Metrics.update_mapped_metric(id, body, opts)
|
|
@@ -3578,7 +4352,7 @@ KlaviyoAPI::Metrics.update_mapped_metric(id, body, opts)
|
|
|
3578
4352
|
## Profiles
|
|
3579
4353
|
|
|
3580
4354
|
|
|
3581
|
-
#### [Bulk Import Profiles](https://developers.klaviyo.com/en/v2026-
|
|
4355
|
+
#### [Bulk Import Profiles](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_import_profiles)
|
|
3582
4356
|
|
|
3583
4357
|
```ruby
|
|
3584
4358
|
KlaviyoAPI::Profiles.bulk_import_profiles(body, opts)
|
|
@@ -3596,7 +4370,7 @@ KlaviyoAPI::Profiles.create_profile_bulk_import_job(body, opts)
|
|
|
3596
4370
|
|
|
3597
4371
|
|
|
3598
4372
|
|
|
3599
|
-
#### [Bulk Subscribe Profiles](https://developers.klaviyo.com/en/v2026-
|
|
4373
|
+
#### [Bulk Subscribe Profiles](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_subscribe_profiles)
|
|
3600
4374
|
|
|
3601
4375
|
```ruby
|
|
3602
4376
|
KlaviyoAPI::Profiles.bulk_subscribe_profiles(body)
|
|
@@ -3614,7 +4388,7 @@ KlaviyoAPI::Profiles.create_profile_subscription_bulk_create_job(body)
|
|
|
3614
4388
|
|
|
3615
4389
|
|
|
3616
4390
|
|
|
3617
|
-
#### [Bulk Suppress Profiles](https://developers.klaviyo.com/en/v2026-
|
|
4391
|
+
#### [Bulk Suppress Profiles](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_suppress_profiles)
|
|
3618
4392
|
|
|
3619
4393
|
```ruby
|
|
3620
4394
|
KlaviyoAPI::Profiles.bulk_suppress_profiles(body, opts)
|
|
@@ -3632,7 +4406,7 @@ KlaviyoAPI::Profiles.create_profile_suppression_bulk_create_job(body, opts)
|
|
|
3632
4406
|
|
|
3633
4407
|
|
|
3634
4408
|
|
|
3635
|
-
#### [Bulk Unsubscribe Profiles](https://developers.klaviyo.com/en/v2026-
|
|
4409
|
+
#### [Bulk Unsubscribe Profiles](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_unsubscribe_profiles)
|
|
3636
4410
|
|
|
3637
4411
|
```ruby
|
|
3638
4412
|
KlaviyoAPI::Profiles.bulk_unsubscribe_profiles(body)
|
|
@@ -3650,7 +4424,7 @@ KlaviyoAPI::Profiles.create_profile_subscription_bulk_delete_job(body)
|
|
|
3650
4424
|
|
|
3651
4425
|
|
|
3652
4426
|
|
|
3653
|
-
#### [Bulk Unsuppress Profiles](https://developers.klaviyo.com/en/v2026-
|
|
4427
|
+
#### [Bulk Unsuppress Profiles](https://developers.klaviyo.com/en/v2026-10-15/reference/bulk_unsuppress_profiles)
|
|
3654
4428
|
|
|
3655
4429
|
```ruby
|
|
3656
4430
|
KlaviyoAPI::Profiles.bulk_unsuppress_profiles(body, opts)
|
|
@@ -3668,7 +4442,7 @@ KlaviyoAPI::Profiles.create_profile_suppression_bulk_delete_job(body, opts)
|
|
|
3668
4442
|
|
|
3669
4443
|
|
|
3670
4444
|
|
|
3671
|
-
#### [Create or Update Profile](https://developers.klaviyo.com/en/v2026-
|
|
4445
|
+
#### [Create or Update Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/create_or_update_profile)
|
|
3672
4446
|
|
|
3673
4447
|
```ruby
|
|
3674
4448
|
KlaviyoAPI::Profiles.create_or_update_profile(body, opts)
|
|
@@ -3682,7 +4456,7 @@ KlaviyoAPI::Profiles.create_profile_import(body, opts)
|
|
|
3682
4456
|
|
|
3683
4457
|
|
|
3684
4458
|
|
|
3685
|
-
#### [Create Profile](https://developers.klaviyo.com/en/v2026-
|
|
4459
|
+
#### [Create Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/create_profile)
|
|
3686
4460
|
|
|
3687
4461
|
```ruby
|
|
3688
4462
|
KlaviyoAPI::Profiles.create_profile(body, opts)
|
|
@@ -3692,7 +4466,7 @@ KlaviyoAPI::Profiles.create_profile(body, opts)
|
|
|
3692
4466
|
|
|
3693
4467
|
|
|
3694
4468
|
|
|
3695
|
-
#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2026-
|
|
4469
|
+
#### [Create or Update Push Token](https://developers.klaviyo.com/en/v2026-10-15/reference/create_push_token)
|
|
3696
4470
|
|
|
3697
4471
|
```ruby
|
|
3698
4472
|
KlaviyoAPI::Profiles.create_push_token(body)
|
|
@@ -3702,7 +4476,7 @@ KlaviyoAPI::Profiles.create_push_token(body)
|
|
|
3702
4476
|
|
|
3703
4477
|
|
|
3704
4478
|
|
|
3705
|
-
#### [Delete Push Token](https://developers.klaviyo.com/en/v2026-
|
|
4479
|
+
#### [Delete Push Token](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_push_token)
|
|
3706
4480
|
|
|
3707
4481
|
```ruby
|
|
3708
4482
|
KlaviyoAPI::Profiles.delete_push_token(id)
|
|
@@ -3712,7 +4486,7 @@ KlaviyoAPI::Profiles.delete_push_token(id)
|
|
|
3712
4486
|
|
|
3713
4487
|
|
|
3714
4488
|
|
|
3715
|
-
#### [Get Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
4489
|
+
#### [Get Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_import_profiles_job)
|
|
3716
4490
|
|
|
3717
4491
|
```ruby
|
|
3718
4492
|
KlaviyoAPI::Profiles.get_bulk_import_profiles_job(job_id, opts)
|
|
@@ -3730,7 +4504,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job(job_id, opts)
|
|
|
3730
4504
|
|
|
3731
4505
|
|
|
3732
4506
|
|
|
3733
|
-
#### [Get Bulk Import Profiles Jobs](https://developers.klaviyo.com/en/v2026-
|
|
4507
|
+
#### [Get Bulk Import Profiles Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_import_profiles_jobs)
|
|
3734
4508
|
|
|
3735
4509
|
```ruby
|
|
3736
4510
|
KlaviyoAPI::Profiles.get_bulk_import_profiles_jobs(opts)
|
|
@@ -3748,7 +4522,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_jobs(opts)
|
|
|
3748
4522
|
|
|
3749
4523
|
|
|
3750
4524
|
|
|
3751
|
-
#### [Get Bulk Suppress Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
4525
|
+
#### [Get Bulk Suppress Profiles Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_suppress_profiles_job)
|
|
3752
4526
|
|
|
3753
4527
|
```ruby
|
|
3754
4528
|
KlaviyoAPI::Profiles.get_bulk_suppress_profiles_job(job_id, opts)
|
|
@@ -3762,7 +4536,7 @@ KlaviyoAPI::Profiles.get_profile_suppression_bulk_create_job(job_id, opts)
|
|
|
3762
4536
|
|
|
3763
4537
|
|
|
3764
4538
|
|
|
3765
|
-
#### [Get Bulk Suppress Profiles Jobs](https://developers.klaviyo.com/en/v2026-
|
|
4539
|
+
#### [Get Bulk Suppress Profiles Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_suppress_profiles_jobs)
|
|
3766
4540
|
|
|
3767
4541
|
```ruby
|
|
3768
4542
|
KlaviyoAPI::Profiles.get_bulk_suppress_profiles_jobs(opts)
|
|
@@ -3776,7 +4550,7 @@ KlaviyoAPI::Profiles.get_profile_suppression_bulk_create_jobs(opts)
|
|
|
3776
4550
|
|
|
3777
4551
|
|
|
3778
4552
|
|
|
3779
|
-
#### [Get Bulk Unsuppress Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
4553
|
+
#### [Get Bulk Unsuppress Profiles Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_unsuppress_profiles_job)
|
|
3780
4554
|
|
|
3781
4555
|
```ruby
|
|
3782
4556
|
KlaviyoAPI::Profiles.get_bulk_unsuppress_profiles_job(job_id, opts)
|
|
@@ -3790,7 +4564,7 @@ KlaviyoAPI::Profiles.get_profile_suppression_bulk_delete_job(job_id, opts)
|
|
|
3790
4564
|
|
|
3791
4565
|
|
|
3792
4566
|
|
|
3793
|
-
#### [Get Bulk Unsuppress Profiles Jobs](https://developers.klaviyo.com/en/v2026-
|
|
4567
|
+
#### [Get Bulk Unsuppress Profiles Jobs](https://developers.klaviyo.com/en/v2026-10-15/reference/get_bulk_unsuppress_profiles_jobs)
|
|
3794
4568
|
|
|
3795
4569
|
```ruby
|
|
3796
4570
|
KlaviyoAPI::Profiles.get_bulk_unsuppress_profiles_jobs(opts)
|
|
@@ -3804,7 +4578,7 @@ KlaviyoAPI::Profiles.get_profile_suppression_bulk_delete_jobs(opts)
|
|
|
3804
4578
|
|
|
3805
4579
|
|
|
3806
4580
|
|
|
3807
|
-
#### [Get Conversation for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4581
|
+
#### [Get Conversation for Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/get_conversation_for_profile)
|
|
3808
4582
|
|
|
3809
4583
|
```ruby
|
|
3810
4584
|
KlaviyoAPI::Profiles.get_conversation_for_profile(id, opts)
|
|
@@ -3818,7 +4592,7 @@ KlaviyoAPI::Profiles.get_profile_conversation(id, opts)
|
|
|
3818
4592
|
|
|
3819
4593
|
|
|
3820
4594
|
|
|
3821
|
-
#### [Get Conversation ID for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4595
|
+
#### [Get Conversation ID for Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/get_conversation_id_for_profile)
|
|
3822
4596
|
|
|
3823
4597
|
```ruby
|
|
3824
4598
|
KlaviyoAPI::Profiles.get_conversation_id_for_profile(id)
|
|
@@ -3832,7 +4606,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_conversation(id)
|
|
|
3832
4606
|
|
|
3833
4607
|
|
|
3834
4608
|
|
|
3835
|
-
#### [Get Conversation IDs for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4609
|
+
#### [Get Conversation IDs for Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/get_conversation_ids_for_profile)
|
|
3836
4610
|
|
|
3837
4611
|
```ruby
|
|
3838
4612
|
KlaviyoAPI::Profiles.get_conversation_ids_for_profile(id)
|
|
@@ -3846,7 +4620,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_conversations(id)
|
|
|
3846
4620
|
|
|
3847
4621
|
|
|
3848
4622
|
|
|
3849
|
-
#### [Get Conversations for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4623
|
+
#### [Get Conversations for Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/get_conversations_for_profile)
|
|
3850
4624
|
|
|
3851
4625
|
```ruby
|
|
3852
4626
|
KlaviyoAPI::Profiles.get_conversations_for_profile(id, opts)
|
|
@@ -3860,7 +4634,7 @@ KlaviyoAPI::Profiles.get_profile_conversations(id, opts)
|
|
|
3860
4634
|
|
|
3861
4635
|
|
|
3862
4636
|
|
|
3863
|
-
#### [Get Errors for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
4637
|
+
#### [Get Errors for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_errors_for_bulk_import_profiles_job)
|
|
3864
4638
|
|
|
3865
4639
|
```ruby
|
|
3866
4640
|
KlaviyoAPI::Profiles.get_errors_for_bulk_import_profiles_job(id, opts)
|
|
@@ -3882,7 +4656,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job_import_errors(id, opts)
|
|
|
3882
4656
|
|
|
3883
4657
|
|
|
3884
4658
|
|
|
3885
|
-
#### [Get List for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
4659
|
+
#### [Get List for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_list_for_bulk_import_profiles_job)
|
|
3886
4660
|
|
|
3887
4661
|
```ruby
|
|
3888
4662
|
KlaviyoAPI::Profiles.get_list_for_bulk_import_profiles_job(id, opts)
|
|
@@ -3904,7 +4678,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job_lists(id, opts)
|
|
|
3904
4678
|
|
|
3905
4679
|
|
|
3906
4680
|
|
|
3907
|
-
#### [Get List IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
4681
|
+
#### [Get List IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_list_ids_for_bulk_import_profiles_job)
|
|
3908
4682
|
|
|
3909
4683
|
```ruby
|
|
3910
4684
|
KlaviyoAPI::Profiles.get_list_ids_for_bulk_import_profiles_job(id)
|
|
@@ -3926,7 +4700,7 @@ KlaviyoAPI::Profiles.get_profile_bulk_import_job_relationships_lists(id)
|
|
|
3926
4700
|
|
|
3927
4701
|
|
|
3928
4702
|
|
|
3929
|
-
#### [Get List IDs for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4703
|
+
#### [Get List IDs for Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/get_list_ids_for_profile)
|
|
3930
4704
|
|
|
3931
4705
|
```ruby
|
|
3932
4706
|
KlaviyoAPI::Profiles.get_list_ids_for_profile(id)
|
|
@@ -3940,7 +4714,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_lists(id)
|
|
|
3940
4714
|
|
|
3941
4715
|
|
|
3942
4716
|
|
|
3943
|
-
#### [Get Lists for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4717
|
+
#### [Get Lists for Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/get_lists_for_profile)
|
|
3944
4718
|
|
|
3945
4719
|
```ruby
|
|
3946
4720
|
KlaviyoAPI::Profiles.get_lists_for_profile(id, opts)
|
|
@@ -3954,7 +4728,7 @@ KlaviyoAPI::Profiles.get_profile_lists(id, opts)
|
|
|
3954
4728
|
|
|
3955
4729
|
|
|
3956
4730
|
|
|
3957
|
-
#### [Get Profile](https://developers.klaviyo.com/en/v2026-
|
|
4731
|
+
#### [Get Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profile)
|
|
3958
4732
|
|
|
3959
4733
|
```ruby
|
|
3960
4734
|
KlaviyoAPI::Profiles.get_profile(id, opts)
|
|
@@ -3964,7 +4738,7 @@ KlaviyoAPI::Profiles.get_profile(id, opts)
|
|
|
3964
4738
|
|
|
3965
4739
|
|
|
3966
4740
|
|
|
3967
|
-
#### [Get Profile for Push Token](https://developers.klaviyo.com/en/v2026-
|
|
4741
|
+
#### [Get Profile for Push Token](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profile_for_push_token)
|
|
3968
4742
|
|
|
3969
4743
|
```ruby
|
|
3970
4744
|
KlaviyoAPI::Profiles.get_profile_for_push_token(id, opts)
|
|
@@ -3978,7 +4752,7 @@ KlaviyoAPI::Profiles.get_push_token_profile(id, opts)
|
|
|
3978
4752
|
|
|
3979
4753
|
|
|
3980
4754
|
|
|
3981
|
-
#### [Get Profile ID for Push Token](https://developers.klaviyo.com/en/v2026-
|
|
4755
|
+
#### [Get Profile ID for Push Token](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profile_id_for_push_token)
|
|
3982
4756
|
|
|
3983
4757
|
```ruby
|
|
3984
4758
|
KlaviyoAPI::Profiles.get_profile_id_for_push_token(id)
|
|
@@ -3992,7 +4766,7 @@ KlaviyoAPI::Profiles.get_push_token_relationships_profile(id)
|
|
|
3992
4766
|
|
|
3993
4767
|
|
|
3994
4768
|
|
|
3995
|
-
#### [Get Profile IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
4769
|
+
#### [Get Profile IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profile_ids_for_bulk_import_profiles_job)
|
|
3996
4770
|
|
|
3997
4771
|
```ruby
|
|
3998
4772
|
KlaviyoAPI::Profiles.get_profile_ids_for_bulk_import_profiles_job(id, opts)
|
|
@@ -4014,7 +4788,7 @@ KlaviyoAPI::Profiles.get_profile_ids_for_profile_bulk_import_job(id, opts)
|
|
|
4014
4788
|
|
|
4015
4789
|
|
|
4016
4790
|
|
|
4017
|
-
#### [Get Profiles](https://developers.klaviyo.com/en/v2026-
|
|
4791
|
+
#### [Get Profiles](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profiles)
|
|
4018
4792
|
|
|
4019
4793
|
```ruby
|
|
4020
4794
|
KlaviyoAPI::Profiles.get_profiles(opts)
|
|
@@ -4024,7 +4798,7 @@ KlaviyoAPI::Profiles.get_profiles(opts)
|
|
|
4024
4798
|
|
|
4025
4799
|
|
|
4026
4800
|
|
|
4027
|
-
#### [Get Profiles for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-
|
|
4801
|
+
#### [Get Profiles for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profiles_for_bulk_import_profiles_job)
|
|
4028
4802
|
|
|
4029
4803
|
```ruby
|
|
4030
4804
|
KlaviyoAPI::Profiles.get_profiles_for_bulk_import_profiles_job(id, opts)
|
|
@@ -4046,7 +4820,7 @@ KlaviyoAPI::Profiles.get_profiles_for_profile_bulk_import_job(id, opts)
|
|
|
4046
4820
|
|
|
4047
4821
|
|
|
4048
4822
|
|
|
4049
|
-
#### [Get Push Token](https://developers.klaviyo.com/en/v2026-
|
|
4823
|
+
#### [Get Push Token](https://developers.klaviyo.com/en/v2026-10-15/reference/get_push_token)
|
|
4050
4824
|
|
|
4051
4825
|
```ruby
|
|
4052
4826
|
KlaviyoAPI::Profiles.get_push_token(id, opts)
|
|
@@ -4056,7 +4830,7 @@ KlaviyoAPI::Profiles.get_push_token(id, opts)
|
|
|
4056
4830
|
|
|
4057
4831
|
|
|
4058
4832
|
|
|
4059
|
-
#### [Get Push Token IDs for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4833
|
+
#### [Get Push Token IDs for Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/get_push_token_ids_for_profile)
|
|
4060
4834
|
|
|
4061
4835
|
```ruby
|
|
4062
4836
|
KlaviyoAPI::Profiles.get_push_token_ids_for_profile(id)
|
|
@@ -4070,7 +4844,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_push_tokens(id)
|
|
|
4070
4844
|
|
|
4071
4845
|
|
|
4072
4846
|
|
|
4073
|
-
#### [Get Push Tokens](https://developers.klaviyo.com/en/v2026-
|
|
4847
|
+
#### [Get Push Tokens](https://developers.klaviyo.com/en/v2026-10-15/reference/get_push_tokens)
|
|
4074
4848
|
|
|
4075
4849
|
```ruby
|
|
4076
4850
|
KlaviyoAPI::Profiles.get_push_tokens(opts)
|
|
@@ -4080,7 +4854,7 @@ KlaviyoAPI::Profiles.get_push_tokens(opts)
|
|
|
4080
4854
|
|
|
4081
4855
|
|
|
4082
4856
|
|
|
4083
|
-
#### [Get Push Tokens for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4857
|
+
#### [Get Push Tokens for Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/get_push_tokens_for_profile)
|
|
4084
4858
|
|
|
4085
4859
|
```ruby
|
|
4086
4860
|
KlaviyoAPI::Profiles.get_push_tokens_for_profile(id, opts)
|
|
@@ -4094,7 +4868,7 @@ KlaviyoAPI::Profiles.get_profile_push_tokens(id, opts)
|
|
|
4094
4868
|
|
|
4095
4869
|
|
|
4096
4870
|
|
|
4097
|
-
#### [Get Segment IDs for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4871
|
+
#### [Get Segment IDs for Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/get_segment_ids_for_profile)
|
|
4098
4872
|
|
|
4099
4873
|
```ruby
|
|
4100
4874
|
KlaviyoAPI::Profiles.get_segment_ids_for_profile(id)
|
|
@@ -4108,7 +4882,7 @@ KlaviyoAPI::Profiles.get_profile_relationships_segments(id)
|
|
|
4108
4882
|
|
|
4109
4883
|
|
|
4110
4884
|
|
|
4111
|
-
#### [Get Segments for Profile](https://developers.klaviyo.com/en/v2026-
|
|
4885
|
+
#### [Get Segments for Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/get_segments_for_profile)
|
|
4112
4886
|
|
|
4113
4887
|
```ruby
|
|
4114
4888
|
KlaviyoAPI::Profiles.get_segments_for_profile(id, opts)
|
|
@@ -4122,7 +4896,7 @@ KlaviyoAPI::Profiles.get_profile_segments(id, opts)
|
|
|
4122
4896
|
|
|
4123
4897
|
|
|
4124
4898
|
|
|
4125
|
-
#### [Merge Profiles](https://developers.klaviyo.com/en/v2026-
|
|
4899
|
+
#### [Merge Profiles](https://developers.klaviyo.com/en/v2026-10-15/reference/merge_profiles)
|
|
4126
4900
|
|
|
4127
4901
|
```ruby
|
|
4128
4902
|
KlaviyoAPI::Profiles.merge_profiles(body, opts)
|
|
@@ -4136,7 +4910,7 @@ KlaviyoAPI::Profiles.create_profile_merge(body, opts)
|
|
|
4136
4910
|
|
|
4137
4911
|
|
|
4138
4912
|
|
|
4139
|
-
#### [Update Profile](https://developers.klaviyo.com/en/v2026-
|
|
4913
|
+
#### [Update Profile](https://developers.klaviyo.com/en/v2026-10-15/reference/update_profile)
|
|
4140
4914
|
|
|
4141
4915
|
```ruby
|
|
4142
4916
|
KlaviyoAPI::Profiles.update_profile(id, body, opts)
|
|
@@ -4150,7 +4924,7 @@ KlaviyoAPI::Profiles.update_profile(id, body, opts)
|
|
|
4150
4924
|
## Reporting
|
|
4151
4925
|
|
|
4152
4926
|
|
|
4153
|
-
#### [Query Campaign Values](https://developers.klaviyo.com/en/v2026-
|
|
4927
|
+
#### [Query Campaign Values](https://developers.klaviyo.com/en/v2026-10-15/reference/query_campaign_values)
|
|
4154
4928
|
|
|
4155
4929
|
```ruby
|
|
4156
4930
|
KlaviyoAPI::Reporting.query_campaign_values(body, opts)
|
|
@@ -4168,7 +4942,7 @@ KlaviyoAPI::Reporting.create_campaign_values_report(body, opts)
|
|
|
4168
4942
|
|
|
4169
4943
|
|
|
4170
4944
|
|
|
4171
|
-
#### [Query Flow Series](https://developers.klaviyo.com/en/v2026-
|
|
4945
|
+
#### [Query Flow Series](https://developers.klaviyo.com/en/v2026-10-15/reference/query_flow_series)
|
|
4172
4946
|
|
|
4173
4947
|
```ruby
|
|
4174
4948
|
KlaviyoAPI::Reporting.query_flow_series(body, opts)
|
|
@@ -4186,7 +4960,7 @@ KlaviyoAPI::Reporting.create_flow_series_report(body, opts)
|
|
|
4186
4960
|
|
|
4187
4961
|
|
|
4188
4962
|
|
|
4189
|
-
#### [Query Flow Values](https://developers.klaviyo.com/en/v2026-
|
|
4963
|
+
#### [Query Flow Values](https://developers.klaviyo.com/en/v2026-10-15/reference/query_flow_values)
|
|
4190
4964
|
|
|
4191
4965
|
```ruby
|
|
4192
4966
|
KlaviyoAPI::Reporting.query_flow_values(body, opts)
|
|
@@ -4204,7 +4978,7 @@ KlaviyoAPI::Reporting.create_flow_values_report(body, opts)
|
|
|
4204
4978
|
|
|
4205
4979
|
|
|
4206
4980
|
|
|
4207
|
-
#### [Query Form Series](https://developers.klaviyo.com/en/v2026-
|
|
4981
|
+
#### [Query Form Series](https://developers.klaviyo.com/en/v2026-10-15/reference/query_form_series)
|
|
4208
4982
|
|
|
4209
4983
|
```ruby
|
|
4210
4984
|
KlaviyoAPI::Reporting.query_form_series(body, opts)
|
|
@@ -4222,7 +4996,7 @@ KlaviyoAPI::Reporting.create_form_series_report(body, opts)
|
|
|
4222
4996
|
|
|
4223
4997
|
|
|
4224
4998
|
|
|
4225
|
-
#### [Query Form Values](https://developers.klaviyo.com/en/v2026-
|
|
4999
|
+
#### [Query Form Values](https://developers.klaviyo.com/en/v2026-10-15/reference/query_form_values)
|
|
4226
5000
|
|
|
4227
5001
|
```ruby
|
|
4228
5002
|
KlaviyoAPI::Reporting.query_form_values(body, opts)
|
|
@@ -4240,7 +5014,7 @@ KlaviyoAPI::Reporting.create_form_values_report(body, opts)
|
|
|
4240
5014
|
|
|
4241
5015
|
|
|
4242
5016
|
|
|
4243
|
-
#### [Query Segment Series](https://developers.klaviyo.com/en/v2026-
|
|
5017
|
+
#### [Query Segment Series](https://developers.klaviyo.com/en/v2026-10-15/reference/query_segment_series)
|
|
4244
5018
|
|
|
4245
5019
|
```ruby
|
|
4246
5020
|
KlaviyoAPI::Reporting.query_segment_series(body, opts)
|
|
@@ -4258,7 +5032,7 @@ KlaviyoAPI::Reporting.create_segment_series_report(body, opts)
|
|
|
4258
5032
|
|
|
4259
5033
|
|
|
4260
5034
|
|
|
4261
|
-
#### [Query Segment Values](https://developers.klaviyo.com/en/v2026-
|
|
5035
|
+
#### [Query Segment Values](https://developers.klaviyo.com/en/v2026-10-15/reference/query_segment_values)
|
|
4262
5036
|
|
|
4263
5037
|
```ruby
|
|
4264
5038
|
KlaviyoAPI::Reporting.query_segment_values(body, opts)
|
|
@@ -4280,7 +5054,7 @@ KlaviyoAPI::Reporting.create_segment_values_report(body, opts)
|
|
|
4280
5054
|
## Reviews
|
|
4281
5055
|
|
|
4282
5056
|
|
|
4283
|
-
#### [Get Review](https://developers.klaviyo.com/en/v2026-
|
|
5057
|
+
#### [Get Review](https://developers.klaviyo.com/en/v2026-10-15/reference/get_review)
|
|
4284
5058
|
|
|
4285
5059
|
```ruby
|
|
4286
5060
|
KlaviyoAPI::Reviews.get_review(id, opts)
|
|
@@ -4290,7 +5064,7 @@ KlaviyoAPI::Reviews.get_review(id, opts)
|
|
|
4290
5064
|
|
|
4291
5065
|
|
|
4292
5066
|
|
|
4293
|
-
#### [Get Reviews](https://developers.klaviyo.com/en/v2026-
|
|
5067
|
+
#### [Get Reviews](https://developers.klaviyo.com/en/v2026-10-15/reference/get_reviews)
|
|
4294
5068
|
|
|
4295
5069
|
```ruby
|
|
4296
5070
|
KlaviyoAPI::Reviews.get_reviews(opts)
|
|
@@ -4300,7 +5074,7 @@ KlaviyoAPI::Reviews.get_reviews(opts)
|
|
|
4300
5074
|
|
|
4301
5075
|
|
|
4302
5076
|
|
|
4303
|
-
#### [Update Review](https://developers.klaviyo.com/en/v2026-
|
|
5077
|
+
#### [Update Review](https://developers.klaviyo.com/en/v2026-10-15/reference/update_review)
|
|
4304
5078
|
|
|
4305
5079
|
```ruby
|
|
4306
5080
|
KlaviyoAPI::Reviews.update_review(id, body, opts)
|
|
@@ -4314,7 +5088,7 @@ KlaviyoAPI::Reviews.update_review(id, body, opts)
|
|
|
4314
5088
|
## Segments
|
|
4315
5089
|
|
|
4316
5090
|
|
|
4317
|
-
#### [Create Segment](https://developers.klaviyo.com/en/v2026-
|
|
5091
|
+
#### [Create Segment](https://developers.klaviyo.com/en/v2026-10-15/reference/create_segment)
|
|
4318
5092
|
|
|
4319
5093
|
```ruby
|
|
4320
5094
|
KlaviyoAPI::Segments.create_segment(body, opts)
|
|
@@ -4324,7 +5098,7 @@ KlaviyoAPI::Segments.create_segment(body, opts)
|
|
|
4324
5098
|
|
|
4325
5099
|
|
|
4326
5100
|
|
|
4327
|
-
#### [Delete Segment](https://developers.klaviyo.com/en/v2026-
|
|
5101
|
+
#### [Delete Segment](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_segment)
|
|
4328
5102
|
|
|
4329
5103
|
```ruby
|
|
4330
5104
|
KlaviyoAPI::Segments.delete_segment(id)
|
|
@@ -4334,7 +5108,7 @@ KlaviyoAPI::Segments.delete_segment(id)
|
|
|
4334
5108
|
|
|
4335
5109
|
|
|
4336
5110
|
|
|
4337
|
-
#### [Get Flows Triggered by Segment](https://developers.klaviyo.com/en/v2026-
|
|
5111
|
+
#### [Get Flows Triggered by Segment](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flows_triggered_by_segment)
|
|
4338
5112
|
|
|
4339
5113
|
```ruby
|
|
4340
5114
|
KlaviyoAPI::Segments.get_flows_triggered_by_segment(id, opts)
|
|
@@ -4352,7 +5126,7 @@ KlaviyoAPI::Segments.get_segment_flow_triggers(id, opts)
|
|
|
4352
5126
|
|
|
4353
5127
|
|
|
4354
5128
|
|
|
4355
|
-
#### [Get IDs for Flows Triggered by Segment](https://developers.klaviyo.com/en/v2026-
|
|
5129
|
+
#### [Get IDs for Flows Triggered by Segment](https://developers.klaviyo.com/en/v2026-10-15/reference/get_ids_for_flows_triggered_by_segment)
|
|
4356
5130
|
|
|
4357
5131
|
```ruby
|
|
4358
5132
|
KlaviyoAPI::Segments.get_ids_for_flows_triggered_by_segment(id)
|
|
@@ -4370,7 +5144,7 @@ KlaviyoAPI::Segments.get_segment_relationships_flow_triggers(id)
|
|
|
4370
5144
|
|
|
4371
5145
|
|
|
4372
5146
|
|
|
4373
|
-
#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2026-
|
|
5147
|
+
#### [Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profile_ids_for_segment)
|
|
4374
5148
|
|
|
4375
5149
|
```ruby
|
|
4376
5150
|
KlaviyoAPI::Segments.get_profile_ids_for_segment(id, opts)
|
|
@@ -4384,7 +5158,7 @@ KlaviyoAPI::Segments.get_segment_relationships_profiles(id, opts)
|
|
|
4384
5158
|
|
|
4385
5159
|
|
|
4386
5160
|
|
|
4387
|
-
#### [Get Profiles for Segment](https://developers.klaviyo.com/en/v2026-
|
|
5161
|
+
#### [Get Profiles for Segment](https://developers.klaviyo.com/en/v2026-10-15/reference/get_profiles_for_segment)
|
|
4388
5162
|
|
|
4389
5163
|
```ruby
|
|
4390
5164
|
KlaviyoAPI::Segments.get_profiles_for_segment(id, opts)
|
|
@@ -4398,7 +5172,7 @@ KlaviyoAPI::Segments.get_segment_profiles(id, opts)
|
|
|
4398
5172
|
|
|
4399
5173
|
|
|
4400
5174
|
|
|
4401
|
-
#### [Get Segment](https://developers.klaviyo.com/en/v2026-
|
|
5175
|
+
#### [Get Segment](https://developers.klaviyo.com/en/v2026-10-15/reference/get_segment)
|
|
4402
5176
|
|
|
4403
5177
|
```ruby
|
|
4404
5178
|
KlaviyoAPI::Segments.get_segment(id, opts)
|
|
@@ -4408,7 +5182,7 @@ KlaviyoAPI::Segments.get_segment(id, opts)
|
|
|
4408
5182
|
|
|
4409
5183
|
|
|
4410
5184
|
|
|
4411
|
-
#### [Get Segments](https://developers.klaviyo.com/en/v2026-
|
|
5185
|
+
#### [Get Segments](https://developers.klaviyo.com/en/v2026-10-15/reference/get_segments)
|
|
4412
5186
|
|
|
4413
5187
|
```ruby
|
|
4414
5188
|
KlaviyoAPI::Segments.get_segments(opts)
|
|
@@ -4418,7 +5192,7 @@ KlaviyoAPI::Segments.get_segments(opts)
|
|
|
4418
5192
|
|
|
4419
5193
|
|
|
4420
5194
|
|
|
4421
|
-
#### [Get Tag IDs for Segment](https://developers.klaviyo.com/en/v2026-
|
|
5195
|
+
#### [Get Tag IDs for Segment](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tag_ids_for_segment)
|
|
4422
5196
|
|
|
4423
5197
|
```ruby
|
|
4424
5198
|
KlaviyoAPI::Segments.get_tag_ids_for_segment(id)
|
|
@@ -4432,7 +5206,7 @@ KlaviyoAPI::Segments.get_segment_relationships_tags(id)
|
|
|
4432
5206
|
|
|
4433
5207
|
|
|
4434
5208
|
|
|
4435
|
-
#### [Get Tags for Segment](https://developers.klaviyo.com/en/v2026-
|
|
5209
|
+
#### [Get Tags for Segment](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tags_for_segment)
|
|
4436
5210
|
|
|
4437
5211
|
```ruby
|
|
4438
5212
|
KlaviyoAPI::Segments.get_tags_for_segment(id, opts)
|
|
@@ -4446,7 +5220,7 @@ KlaviyoAPI::Segments.get_segment_tags(id, opts)
|
|
|
4446
5220
|
|
|
4447
5221
|
|
|
4448
5222
|
|
|
4449
|
-
#### [Update Segment](https://developers.klaviyo.com/en/v2026-
|
|
5223
|
+
#### [Update Segment](https://developers.klaviyo.com/en/v2026-10-15/reference/update_segment)
|
|
4450
5224
|
|
|
4451
5225
|
```ruby
|
|
4452
5226
|
KlaviyoAPI::Segments.update_segment(id, body, opts)
|
|
@@ -4460,7 +5234,7 @@ KlaviyoAPI::Segments.update_segment(id, body, opts)
|
|
|
4460
5234
|
## Tags
|
|
4461
5235
|
|
|
4462
5236
|
|
|
4463
|
-
#### [Create Tag](https://developers.klaviyo.com/en/v2026-
|
|
5237
|
+
#### [Create Tag](https://developers.klaviyo.com/en/v2026-10-15/reference/create_tag)
|
|
4464
5238
|
|
|
4465
5239
|
```ruby
|
|
4466
5240
|
KlaviyoAPI::Tags.create_tag(body, opts)
|
|
@@ -4470,7 +5244,7 @@ KlaviyoAPI::Tags.create_tag(body, opts)
|
|
|
4470
5244
|
|
|
4471
5245
|
|
|
4472
5246
|
|
|
4473
|
-
#### [Create Tag Group](https://developers.klaviyo.com/en/v2026-
|
|
5247
|
+
#### [Create Tag Group](https://developers.klaviyo.com/en/v2026-10-15/reference/create_tag_group)
|
|
4474
5248
|
|
|
4475
5249
|
```ruby
|
|
4476
5250
|
KlaviyoAPI::Tags.create_tag_group(body, opts)
|
|
@@ -4480,7 +5254,7 @@ KlaviyoAPI::Tags.create_tag_group(body, opts)
|
|
|
4480
5254
|
|
|
4481
5255
|
|
|
4482
5256
|
|
|
4483
|
-
#### [Delete Tag](https://developers.klaviyo.com/en/v2026-
|
|
5257
|
+
#### [Delete Tag](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_tag)
|
|
4484
5258
|
|
|
4485
5259
|
```ruby
|
|
4486
5260
|
KlaviyoAPI::Tags.delete_tag(id)
|
|
@@ -4490,7 +5264,7 @@ KlaviyoAPI::Tags.delete_tag(id)
|
|
|
4490
5264
|
|
|
4491
5265
|
|
|
4492
5266
|
|
|
4493
|
-
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2026-
|
|
5267
|
+
#### [Delete Tag Group](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_tag_group)
|
|
4494
5268
|
|
|
4495
5269
|
```ruby
|
|
4496
5270
|
KlaviyoAPI::Tags.delete_tag_group(id)
|
|
@@ -4500,7 +5274,7 @@ KlaviyoAPI::Tags.delete_tag_group(id)
|
|
|
4500
5274
|
|
|
4501
5275
|
|
|
4502
5276
|
|
|
4503
|
-
#### [Get Campaign IDs for Tag](https://developers.klaviyo.com/en/v2026-
|
|
5277
|
+
#### [Get Campaign IDs for Tag](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_ids_for_tag)
|
|
4504
5278
|
|
|
4505
5279
|
```ruby
|
|
4506
5280
|
KlaviyoAPI::Tags.get_campaign_ids_for_tag(id)
|
|
@@ -4514,7 +5288,7 @@ KlaviyoAPI::Tags.get_tag_relationships_campaigns(id)
|
|
|
4514
5288
|
|
|
4515
5289
|
|
|
4516
5290
|
|
|
4517
|
-
#### [Get Flow IDs for Tag](https://developers.klaviyo.com/en/v2026-
|
|
5291
|
+
#### [Get Flow IDs for Tag](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flow_ids_for_tag)
|
|
4518
5292
|
|
|
4519
5293
|
```ruby
|
|
4520
5294
|
KlaviyoAPI::Tags.get_flow_ids_for_tag(id)
|
|
@@ -4528,7 +5302,7 @@ KlaviyoAPI::Tags.get_tag_relationships_flows(id)
|
|
|
4528
5302
|
|
|
4529
5303
|
|
|
4530
5304
|
|
|
4531
|
-
#### [Get List IDs for Tag](https://developers.klaviyo.com/en/v2026-
|
|
5305
|
+
#### [Get List IDs for Tag](https://developers.klaviyo.com/en/v2026-10-15/reference/get_list_ids_for_tag)
|
|
4532
5306
|
|
|
4533
5307
|
```ruby
|
|
4534
5308
|
KlaviyoAPI::Tags.get_list_ids_for_tag(id)
|
|
@@ -4542,7 +5316,7 @@ KlaviyoAPI::Tags.get_tag_relationships_lists(id)
|
|
|
4542
5316
|
|
|
4543
5317
|
|
|
4544
5318
|
|
|
4545
|
-
#### [Get Segment IDs for Tag](https://developers.klaviyo.com/en/v2026-
|
|
5319
|
+
#### [Get Segment IDs for Tag](https://developers.klaviyo.com/en/v2026-10-15/reference/get_segment_ids_for_tag)
|
|
4546
5320
|
|
|
4547
5321
|
```ruby
|
|
4548
5322
|
KlaviyoAPI::Tags.get_segment_ids_for_tag(id)
|
|
@@ -4556,7 +5330,7 @@ KlaviyoAPI::Tags.get_tag_relationships_segments(id)
|
|
|
4556
5330
|
|
|
4557
5331
|
|
|
4558
5332
|
|
|
4559
|
-
#### [Get Tag](https://developers.klaviyo.com/en/v2026-
|
|
5333
|
+
#### [Get Tag](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tag)
|
|
4560
5334
|
|
|
4561
5335
|
```ruby
|
|
4562
5336
|
KlaviyoAPI::Tags.get_tag(id, opts)
|
|
@@ -4566,7 +5340,7 @@ KlaviyoAPI::Tags.get_tag(id, opts)
|
|
|
4566
5340
|
|
|
4567
5341
|
|
|
4568
5342
|
|
|
4569
|
-
#### [Get Tag Group](https://developers.klaviyo.com/en/v2026-
|
|
5343
|
+
#### [Get Tag Group](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tag_group)
|
|
4570
5344
|
|
|
4571
5345
|
```ruby
|
|
4572
5346
|
KlaviyoAPI::Tags.get_tag_group(id, opts)
|
|
@@ -4576,7 +5350,7 @@ KlaviyoAPI::Tags.get_tag_group(id, opts)
|
|
|
4576
5350
|
|
|
4577
5351
|
|
|
4578
5352
|
|
|
4579
|
-
#### [Get Tag Group for Tag](https://developers.klaviyo.com/en/v2026-
|
|
5353
|
+
#### [Get Tag Group for Tag](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tag_group_for_tag)
|
|
4580
5354
|
|
|
4581
5355
|
```ruby
|
|
4582
5356
|
KlaviyoAPI::Tags.get_tag_group_for_tag(id, opts)
|
|
@@ -4594,7 +5368,7 @@ KlaviyoAPI::Tags.get_group_for_tag(id, opts)
|
|
|
4594
5368
|
|
|
4595
5369
|
|
|
4596
5370
|
|
|
4597
|
-
#### [Get Tag Group ID for Tag](https://developers.klaviyo.com/en/v2026-
|
|
5371
|
+
#### [Get Tag Group ID for Tag](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tag_group_id_for_tag)
|
|
4598
5372
|
|
|
4599
5373
|
```ruby
|
|
4600
5374
|
KlaviyoAPI::Tags.get_tag_group_id_for_tag(id)
|
|
@@ -4616,7 +5390,7 @@ KlaviyoAPI::Tags.get_tag_relationships_group(id)
|
|
|
4616
5390
|
|
|
4617
5391
|
|
|
4618
5392
|
|
|
4619
|
-
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2026-
|
|
5393
|
+
#### [Get Tag Groups](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tag_groups)
|
|
4620
5394
|
|
|
4621
5395
|
```ruby
|
|
4622
5396
|
KlaviyoAPI::Tags.get_tag_groups(opts)
|
|
@@ -4626,7 +5400,7 @@ KlaviyoAPI::Tags.get_tag_groups(opts)
|
|
|
4626
5400
|
|
|
4627
5401
|
|
|
4628
5402
|
|
|
4629
|
-
#### [Get Tag IDs for Tag Group](https://developers.klaviyo.com/en/v2026-
|
|
5403
|
+
#### [Get Tag IDs for Tag Group](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tag_ids_for_tag_group)
|
|
4630
5404
|
|
|
4631
5405
|
```ruby
|
|
4632
5406
|
KlaviyoAPI::Tags.get_tag_ids_for_tag_group(id)
|
|
@@ -4640,7 +5414,7 @@ KlaviyoAPI::Tags.get_tag_group_relationships_tags(id)
|
|
|
4640
5414
|
|
|
4641
5415
|
|
|
4642
5416
|
|
|
4643
|
-
#### [Get Tags](https://developers.klaviyo.com/en/v2026-
|
|
5417
|
+
#### [Get Tags](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tags)
|
|
4644
5418
|
|
|
4645
5419
|
```ruby
|
|
4646
5420
|
KlaviyoAPI::Tags.get_tags(opts)
|
|
@@ -4650,7 +5424,7 @@ KlaviyoAPI::Tags.get_tags(opts)
|
|
|
4650
5424
|
|
|
4651
5425
|
|
|
4652
5426
|
|
|
4653
|
-
#### [Get Tags for Tag Group](https://developers.klaviyo.com/en/v2026-
|
|
5427
|
+
#### [Get Tags for Tag Group](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tags_for_tag_group)
|
|
4654
5428
|
|
|
4655
5429
|
```ruby
|
|
4656
5430
|
KlaviyoAPI::Tags.get_tags_for_tag_group(id, opts)
|
|
@@ -4664,7 +5438,7 @@ KlaviyoAPI::Tags.get_tag_group_tags(id, opts)
|
|
|
4664
5438
|
|
|
4665
5439
|
|
|
4666
5440
|
|
|
4667
|
-
#### [Remove Tag from Campaigns](https://developers.klaviyo.com/en/v2026-
|
|
5441
|
+
#### [Remove Tag from Campaigns](https://developers.klaviyo.com/en/v2026-10-15/reference/remove_tag_from_campaigns)
|
|
4668
5442
|
|
|
4669
5443
|
```ruby
|
|
4670
5444
|
KlaviyoAPI::Tags.remove_tag_from_campaigns(id, body)
|
|
@@ -4682,7 +5456,7 @@ KlaviyoAPI::Tags.remove_campaigns_from_tag(id, body)
|
|
|
4682
5456
|
|
|
4683
5457
|
|
|
4684
5458
|
|
|
4685
|
-
#### [Remove Tag from Flows](https://developers.klaviyo.com/en/v2026-
|
|
5459
|
+
#### [Remove Tag from Flows](https://developers.klaviyo.com/en/v2026-10-15/reference/remove_tag_from_flows)
|
|
4686
5460
|
|
|
4687
5461
|
```ruby
|
|
4688
5462
|
KlaviyoAPI::Tags.remove_tag_from_flows(id, body)
|
|
@@ -4700,7 +5474,7 @@ KlaviyoAPI::Tags.remove_flows_from_tag(id, body)
|
|
|
4700
5474
|
|
|
4701
5475
|
|
|
4702
5476
|
|
|
4703
|
-
#### [Remove Tag from Lists](https://developers.klaviyo.com/en/v2026-
|
|
5477
|
+
#### [Remove Tag from Lists](https://developers.klaviyo.com/en/v2026-10-15/reference/remove_tag_from_lists)
|
|
4704
5478
|
|
|
4705
5479
|
```ruby
|
|
4706
5480
|
KlaviyoAPI::Tags.remove_tag_from_lists(id, body)
|
|
@@ -4718,7 +5492,7 @@ KlaviyoAPI::Tags.remove_lists_from_tag(id, body)
|
|
|
4718
5492
|
|
|
4719
5493
|
|
|
4720
5494
|
|
|
4721
|
-
#### [Remove Tag from Segments](https://developers.klaviyo.com/en/v2026-
|
|
5495
|
+
#### [Remove Tag from Segments](https://developers.klaviyo.com/en/v2026-10-15/reference/remove_tag_from_segments)
|
|
4722
5496
|
|
|
4723
5497
|
```ruby
|
|
4724
5498
|
KlaviyoAPI::Tags.remove_tag_from_segments(id, body)
|
|
@@ -4736,7 +5510,7 @@ KlaviyoAPI::Tags.remove_segments_from_tag(id, body)
|
|
|
4736
5510
|
|
|
4737
5511
|
|
|
4738
5512
|
|
|
4739
|
-
#### [Tag Campaigns](https://developers.klaviyo.com/en/v2026-
|
|
5513
|
+
#### [Tag Campaigns](https://developers.klaviyo.com/en/v2026-10-15/reference/tag_campaigns)
|
|
4740
5514
|
|
|
4741
5515
|
```ruby
|
|
4742
5516
|
KlaviyoAPI::Tags.tag_campaigns(id, body)
|
|
@@ -4758,7 +5532,7 @@ KlaviyoAPI::Tags.create_tag_relationships_campaigns(id, body)
|
|
|
4758
5532
|
|
|
4759
5533
|
|
|
4760
5534
|
|
|
4761
|
-
#### [Tag Flows](https://developers.klaviyo.com/en/v2026-
|
|
5535
|
+
#### [Tag Flows](https://developers.klaviyo.com/en/v2026-10-15/reference/tag_flows)
|
|
4762
5536
|
|
|
4763
5537
|
```ruby
|
|
4764
5538
|
KlaviyoAPI::Tags.tag_flows(id, body)
|
|
@@ -4780,7 +5554,7 @@ KlaviyoAPI::Tags.create_tag_relationships_flows(id, body)
|
|
|
4780
5554
|
|
|
4781
5555
|
|
|
4782
5556
|
|
|
4783
|
-
#### [Tag Lists](https://developers.klaviyo.com/en/v2026-
|
|
5557
|
+
#### [Tag Lists](https://developers.klaviyo.com/en/v2026-10-15/reference/tag_lists)
|
|
4784
5558
|
|
|
4785
5559
|
```ruby
|
|
4786
5560
|
KlaviyoAPI::Tags.tag_lists(id, body)
|
|
@@ -4802,7 +5576,7 @@ KlaviyoAPI::Tags.create_tag_relationships_lists(id, body)
|
|
|
4802
5576
|
|
|
4803
5577
|
|
|
4804
5578
|
|
|
4805
|
-
#### [Tag Segments](https://developers.klaviyo.com/en/v2026-
|
|
5579
|
+
#### [Tag Segments](https://developers.klaviyo.com/en/v2026-10-15/reference/tag_segments)
|
|
4806
5580
|
|
|
4807
5581
|
```ruby
|
|
4808
5582
|
KlaviyoAPI::Tags.tag_segments(id, body)
|
|
@@ -4824,7 +5598,7 @@ KlaviyoAPI::Tags.create_tag_relationships_segments(id, body)
|
|
|
4824
5598
|
|
|
4825
5599
|
|
|
4826
5600
|
|
|
4827
|
-
#### [Update Tag](https://developers.klaviyo.com/en/v2026-
|
|
5601
|
+
#### [Update Tag](https://developers.klaviyo.com/en/v2026-10-15/reference/update_tag)
|
|
4828
5602
|
|
|
4829
5603
|
```ruby
|
|
4830
5604
|
KlaviyoAPI::Tags.update_tag(id, body)
|
|
@@ -4834,7 +5608,7 @@ KlaviyoAPI::Tags.update_tag(id, body)
|
|
|
4834
5608
|
|
|
4835
5609
|
|
|
4836
5610
|
|
|
4837
|
-
#### [Update Tag Group](https://developers.klaviyo.com/en/v2026-
|
|
5611
|
+
#### [Update Tag Group](https://developers.klaviyo.com/en/v2026-10-15/reference/update_tag_group)
|
|
4838
5612
|
|
|
4839
5613
|
```ruby
|
|
4840
5614
|
KlaviyoAPI::Tags.update_tag_group(id, body)
|
|
@@ -4848,7 +5622,7 @@ KlaviyoAPI::Tags.update_tag_group(id, body)
|
|
|
4848
5622
|
## Templates
|
|
4849
5623
|
|
|
4850
5624
|
|
|
4851
|
-
#### [Clone Template](https://developers.klaviyo.com/en/v2026-
|
|
5625
|
+
#### [Clone Template](https://developers.klaviyo.com/en/v2026-10-15/reference/clone_template)
|
|
4852
5626
|
|
|
4853
5627
|
```ruby
|
|
4854
5628
|
KlaviyoAPI::Templates.clone_template(body, opts)
|
|
@@ -4862,7 +5636,21 @@ KlaviyoAPI::Templates.create_template_clone(body, opts)
|
|
|
4862
5636
|
|
|
4863
5637
|
|
|
4864
5638
|
|
|
4865
|
-
#### [
|
|
5639
|
+
#### [Clone Universal Content](https://developers.klaviyo.com/en/v2026-10-15/reference/clone_universal_content)
|
|
5640
|
+
|
|
5641
|
+
```ruby
|
|
5642
|
+
KlaviyoAPI::Templates.clone_universal_content(body, opts)
|
|
5643
|
+
```
|
|
5644
|
+
##### Method alias:
|
|
5645
|
+
```ruby
|
|
5646
|
+
KlaviyoAPI::Templates.create_template_universal_content_clone(body, opts)
|
|
5647
|
+
```
|
|
5648
|
+
|
|
5649
|
+
|
|
5650
|
+
|
|
5651
|
+
|
|
5652
|
+
|
|
5653
|
+
#### [Create Template](https://developers.klaviyo.com/en/v2026-10-15/reference/create_template)
|
|
4866
5654
|
|
|
4867
5655
|
```ruby
|
|
4868
5656
|
KlaviyoAPI::Templates.create_template(body, opts)
|
|
@@ -4872,7 +5660,17 @@ KlaviyoAPI::Templates.create_template(body, opts)
|
|
|
4872
5660
|
|
|
4873
5661
|
|
|
4874
5662
|
|
|
4875
|
-
#### [Create
|
|
5663
|
+
#### [Create Template Preview Send Job](https://developers.klaviyo.com/en/v2026-10-15/reference/create_template_preview_send_job)
|
|
5664
|
+
|
|
5665
|
+
```ruby
|
|
5666
|
+
KlaviyoAPI::Templates.create_template_preview_send_job(body, opts)
|
|
5667
|
+
```
|
|
5668
|
+
|
|
5669
|
+
|
|
5670
|
+
|
|
5671
|
+
|
|
5672
|
+
|
|
5673
|
+
#### [Create Universal Content](https://developers.klaviyo.com/en/v2026-10-15/reference/create_universal_content)
|
|
4876
5674
|
|
|
4877
5675
|
```ruby
|
|
4878
5676
|
KlaviyoAPI::Templates.create_universal_content(body, opts)
|
|
@@ -4886,7 +5684,7 @@ KlaviyoAPI::Templates.create_template_universal_content(body, opts)
|
|
|
4886
5684
|
|
|
4887
5685
|
|
|
4888
5686
|
|
|
4889
|
-
#### [Delete Template](https://developers.klaviyo.com/en/v2026-
|
|
5687
|
+
#### [Delete Template](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_template)
|
|
4890
5688
|
|
|
4891
5689
|
```ruby
|
|
4892
5690
|
KlaviyoAPI::Templates.delete_template(id)
|
|
@@ -4896,7 +5694,7 @@ KlaviyoAPI::Templates.delete_template(id)
|
|
|
4896
5694
|
|
|
4897
5695
|
|
|
4898
5696
|
|
|
4899
|
-
#### [Delete Universal Content](https://developers.klaviyo.com/en/v2026-
|
|
5697
|
+
#### [Delete Universal Content](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_universal_content)
|
|
4900
5698
|
|
|
4901
5699
|
```ruby
|
|
4902
5700
|
KlaviyoAPI::Templates.delete_universal_content(id)
|
|
@@ -4910,7 +5708,7 @@ KlaviyoAPI::Templates.delete_template_universal_content(id)
|
|
|
4910
5708
|
|
|
4911
5709
|
|
|
4912
5710
|
|
|
4913
|
-
#### [Get All Universal Content](https://developers.klaviyo.com/en/v2026-
|
|
5711
|
+
#### [Get All Universal Content](https://developers.klaviyo.com/en/v2026-10-15/reference/get_all_universal_content)
|
|
4914
5712
|
|
|
4915
5713
|
```ruby
|
|
4916
5714
|
KlaviyoAPI::Templates.get_all_universal_content(opts)
|
|
@@ -4924,7 +5722,7 @@ KlaviyoAPI::Templates.get_template_universal_content(opts)
|
|
|
4924
5722
|
|
|
4925
5723
|
|
|
4926
5724
|
|
|
4927
|
-
#### [Get Template](https://developers.klaviyo.com/en/v2026-
|
|
5725
|
+
#### [Get Template](https://developers.klaviyo.com/en/v2026-10-15/reference/get_template)
|
|
4928
5726
|
|
|
4929
5727
|
```ruby
|
|
4930
5728
|
KlaviyoAPI::Templates.get_template(id, opts)
|
|
@@ -4934,7 +5732,7 @@ KlaviyoAPI::Templates.get_template(id, opts)
|
|
|
4934
5732
|
|
|
4935
5733
|
|
|
4936
5734
|
|
|
4937
|
-
#### [Get Templates](https://developers.klaviyo.com/en/v2026-
|
|
5735
|
+
#### [Get Templates](https://developers.klaviyo.com/en/v2026-10-15/reference/get_templates)
|
|
4938
5736
|
|
|
4939
5737
|
```ruby
|
|
4940
5738
|
KlaviyoAPI::Templates.get_templates(opts)
|
|
@@ -4944,7 +5742,7 @@ KlaviyoAPI::Templates.get_templates(opts)
|
|
|
4944
5742
|
|
|
4945
5743
|
|
|
4946
5744
|
|
|
4947
|
-
#### [Get Universal Content](https://developers.klaviyo.com/en/v2026-
|
|
5745
|
+
#### [Get Universal Content](https://developers.klaviyo.com/en/v2026-10-15/reference/get_universal_content)
|
|
4948
5746
|
|
|
4949
5747
|
```ruby
|
|
4950
5748
|
KlaviyoAPI::Templates.get_universal_content(id, opts)
|
|
@@ -4954,7 +5752,7 @@ KlaviyoAPI::Templates.get_universal_content(id, opts)
|
|
|
4954
5752
|
|
|
4955
5753
|
|
|
4956
5754
|
|
|
4957
|
-
#### [Render Template](https://developers.klaviyo.com/en/v2026-
|
|
5755
|
+
#### [Render Template](https://developers.klaviyo.com/en/v2026-10-15/reference/render_template)
|
|
4958
5756
|
|
|
4959
5757
|
```ruby
|
|
4960
5758
|
KlaviyoAPI::Templates.render_template(body, opts)
|
|
@@ -4968,7 +5766,7 @@ KlaviyoAPI::Templates.create_template_render(body, opts)
|
|
|
4968
5766
|
|
|
4969
5767
|
|
|
4970
5768
|
|
|
4971
|
-
#### [Update Template](https://developers.klaviyo.com/en/v2026-
|
|
5769
|
+
#### [Update Template](https://developers.klaviyo.com/en/v2026-10-15/reference/update_template)
|
|
4972
5770
|
|
|
4973
5771
|
```ruby
|
|
4974
5772
|
KlaviyoAPI::Templates.update_template(id, body, opts)
|
|
@@ -4978,7 +5776,7 @@ KlaviyoAPI::Templates.update_template(id, body, opts)
|
|
|
4978
5776
|
|
|
4979
5777
|
|
|
4980
5778
|
|
|
4981
|
-
#### [Update Universal Content](https://developers.klaviyo.com/en/v2026-
|
|
5779
|
+
#### [Update Universal Content](https://developers.klaviyo.com/en/v2026-10-15/reference/update_universal_content)
|
|
4982
5780
|
|
|
4983
5781
|
```ruby
|
|
4984
5782
|
KlaviyoAPI::Templates.update_universal_content(id, body, opts)
|
|
@@ -4993,10 +5791,112 @@ KlaviyoAPI::Templates.update_template_universal_content(id, body, opts)
|
|
|
4993
5791
|
|
|
4994
5792
|
|
|
4995
5793
|
|
|
5794
|
+
## Text Messaging
|
|
5795
|
+
|
|
5796
|
+
|
|
5797
|
+
#### [Create Text Messaging Configuration](https://developers.klaviyo.com/en/v2026-10-15/reference/create_text_messaging_configuration)
|
|
5798
|
+
|
|
5799
|
+
```ruby
|
|
5800
|
+
KlaviyoAPI::TextMessaging.create_text_messaging_configuration(body, opts)
|
|
5801
|
+
```
|
|
5802
|
+
|
|
5803
|
+
|
|
5804
|
+
|
|
5805
|
+
|
|
5806
|
+
|
|
5807
|
+
#### [Create Text Messaging Sender](https://developers.klaviyo.com/en/v2026-10-15/reference/create_text_messaging_sender)
|
|
5808
|
+
|
|
5809
|
+
```ruby
|
|
5810
|
+
KlaviyoAPI::TextMessaging.create_text_messaging_sender(body, opts)
|
|
5811
|
+
```
|
|
5812
|
+
|
|
5813
|
+
|
|
5814
|
+
|
|
5815
|
+
|
|
5816
|
+
|
|
5817
|
+
#### [Create Text Messaging Sender Registration](https://developers.klaviyo.com/en/v2026-10-15/reference/create_text_messaging_sender_registration)
|
|
5818
|
+
|
|
5819
|
+
```ruby
|
|
5820
|
+
KlaviyoAPI::TextMessaging.create_text_messaging_sender_registration(body, opts)
|
|
5821
|
+
```
|
|
5822
|
+
|
|
5823
|
+
|
|
5824
|
+
|
|
5825
|
+
|
|
5826
|
+
|
|
5827
|
+
#### [Get Messaging Sender Registration for Text Messaging Sender](https://developers.klaviyo.com/en/v2026-10-15/reference/get_messaging_sender_registration_for_text_messaging_sender)
|
|
5828
|
+
|
|
5829
|
+
```ruby
|
|
5830
|
+
KlaviyoAPI::TextMessaging.get_messaging_sender_registration_for_text_messaging_sender(id, opts)
|
|
5831
|
+
```
|
|
5832
|
+
##### Method alias:
|
|
5833
|
+
```ruby
|
|
5834
|
+
KlaviyoAPI::TextMessaging.get_text_messaging_sender_messaging_sender_registration(id, opts)
|
|
5835
|
+
```
|
|
5836
|
+
|
|
5837
|
+
|
|
5838
|
+
|
|
5839
|
+
|
|
5840
|
+
|
|
5841
|
+
#### [Get Messaging Sender Registration ID for Text Messaging Sender](https://developers.klaviyo.com/en/v2026-10-15/reference/get_messaging_sender_registration_id_for_text_messaging_sender)
|
|
5842
|
+
|
|
5843
|
+
```ruby
|
|
5844
|
+
KlaviyoAPI::TextMessaging.get_messaging_sender_registration_id_for_text_messaging_sender(id)
|
|
5845
|
+
```
|
|
5846
|
+
##### Method alias:
|
|
5847
|
+
```ruby
|
|
5848
|
+
KlaviyoAPI::TextMessaging.get_text_messaging_sender_relationships_messaging_sender_registration(id)
|
|
5849
|
+
```
|
|
5850
|
+
|
|
5851
|
+
|
|
5852
|
+
|
|
5853
|
+
|
|
5854
|
+
|
|
5855
|
+
#### [Get Text Messaging Configuration](https://developers.klaviyo.com/en/v2026-10-15/reference/get_text_messaging_configuration)
|
|
5856
|
+
|
|
5857
|
+
```ruby
|
|
5858
|
+
KlaviyoAPI::TextMessaging.get_text_messaging_configuration(id, opts)
|
|
5859
|
+
```
|
|
5860
|
+
|
|
5861
|
+
|
|
5862
|
+
|
|
5863
|
+
|
|
5864
|
+
|
|
5865
|
+
#### [Get Text Messaging Sender](https://developers.klaviyo.com/en/v2026-10-15/reference/get_text_messaging_sender)
|
|
5866
|
+
|
|
5867
|
+
```ruby
|
|
5868
|
+
KlaviyoAPI::TextMessaging.get_text_messaging_sender(id, opts)
|
|
5869
|
+
```
|
|
5870
|
+
|
|
5871
|
+
|
|
5872
|
+
|
|
5873
|
+
|
|
5874
|
+
|
|
5875
|
+
#### [Get Text Messaging Sender Registration](https://developers.klaviyo.com/en/v2026-10-15/reference/get_text_messaging_sender_registration)
|
|
5876
|
+
|
|
5877
|
+
```ruby
|
|
5878
|
+
KlaviyoAPI::TextMessaging.get_text_messaging_sender_registration(id, opts)
|
|
5879
|
+
```
|
|
5880
|
+
|
|
5881
|
+
|
|
5882
|
+
|
|
5883
|
+
|
|
5884
|
+
|
|
5885
|
+
#### [Get Text Messaging Senders](https://developers.klaviyo.com/en/v2026-10-15/reference/get_text_messaging_senders)
|
|
5886
|
+
|
|
5887
|
+
```ruby
|
|
5888
|
+
KlaviyoAPI::TextMessaging.get_text_messaging_senders(opts)
|
|
5889
|
+
```
|
|
5890
|
+
|
|
5891
|
+
|
|
5892
|
+
|
|
5893
|
+
|
|
5894
|
+
|
|
5895
|
+
|
|
4996
5896
|
## Tracking Settings
|
|
4997
5897
|
|
|
4998
5898
|
|
|
4999
|
-
#### [Get Tracking Setting](https://developers.klaviyo.com/en/v2026-
|
|
5899
|
+
#### [Get Tracking Setting](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tracking_setting)
|
|
5000
5900
|
|
|
5001
5901
|
```ruby
|
|
5002
5902
|
KlaviyoAPI::TrackingSettings.get_tracking_setting(id, opts)
|
|
@@ -5006,7 +5906,7 @@ KlaviyoAPI::TrackingSettings.get_tracking_setting(id, opts)
|
|
|
5006
5906
|
|
|
5007
5907
|
|
|
5008
5908
|
|
|
5009
|
-
#### [Get Tracking Settings](https://developers.klaviyo.com/en/v2026-
|
|
5909
|
+
#### [Get Tracking Settings](https://developers.klaviyo.com/en/v2026-10-15/reference/get_tracking_settings)
|
|
5010
5910
|
|
|
5011
5911
|
```ruby
|
|
5012
5912
|
KlaviyoAPI::TrackingSettings.get_tracking_settings(opts)
|
|
@@ -5016,7 +5916,7 @@ KlaviyoAPI::TrackingSettings.get_tracking_settings(opts)
|
|
|
5016
5916
|
|
|
5017
5917
|
|
|
5018
5918
|
|
|
5019
|
-
#### [Update Tracking Setting](https://developers.klaviyo.com/en/v2026-
|
|
5919
|
+
#### [Update Tracking Setting](https://developers.klaviyo.com/en/v2026-10-15/reference/update_tracking_setting)
|
|
5020
5920
|
|
|
5021
5921
|
```ruby
|
|
5022
5922
|
KlaviyoAPI::TrackingSettings.update_tracking_setting(id, body, opts)
|
|
@@ -5027,10 +5927,176 @@ KlaviyoAPI::TrackingSettings.update_tracking_setting(id, body, opts)
|
|
|
5027
5927
|
|
|
5028
5928
|
|
|
5029
5929
|
|
|
5930
|
+
## Translations
|
|
5931
|
+
|
|
5932
|
+
|
|
5933
|
+
#### [Create Translation](https://developers.klaviyo.com/en/v2026-10-15/reference/create_translation)
|
|
5934
|
+
|
|
5935
|
+
```ruby
|
|
5936
|
+
KlaviyoAPI::Translations.create_translation(body, opts)
|
|
5937
|
+
```
|
|
5938
|
+
|
|
5939
|
+
|
|
5940
|
+
|
|
5941
|
+
|
|
5942
|
+
|
|
5943
|
+
#### [Delete Translation](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_translation)
|
|
5944
|
+
|
|
5945
|
+
```ruby
|
|
5946
|
+
KlaviyoAPI::Translations.delete_translation(id)
|
|
5947
|
+
```
|
|
5948
|
+
|
|
5949
|
+
|
|
5950
|
+
|
|
5951
|
+
|
|
5952
|
+
|
|
5953
|
+
#### [Get Campaign Variation for Translation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_variation_for_translation)
|
|
5954
|
+
|
|
5955
|
+
```ruby
|
|
5956
|
+
KlaviyoAPI::Translations.get_campaign_variation_for_translation(id, opts)
|
|
5957
|
+
```
|
|
5958
|
+
##### Method alias:
|
|
5959
|
+
```ruby
|
|
5960
|
+
KlaviyoAPI::Translations.get_translation_campaign_variation(id, opts)
|
|
5961
|
+
```
|
|
5962
|
+
|
|
5963
|
+
|
|
5964
|
+
|
|
5965
|
+
|
|
5966
|
+
|
|
5967
|
+
#### [Get Campaign Variation ID for Translation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_campaign_variation_id_for_translation)
|
|
5968
|
+
|
|
5969
|
+
```ruby
|
|
5970
|
+
KlaviyoAPI::Translations.get_campaign_variation_id_for_translation(id)
|
|
5971
|
+
```
|
|
5972
|
+
##### Method alias:
|
|
5973
|
+
```ruby
|
|
5974
|
+
KlaviyoAPI::Translations.get_translation_relationships_campaign_variation(id)
|
|
5975
|
+
```
|
|
5976
|
+
|
|
5977
|
+
|
|
5978
|
+
|
|
5979
|
+
|
|
5980
|
+
|
|
5981
|
+
#### [Get Flow Message for Translation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flow_message_for_translation)
|
|
5982
|
+
|
|
5983
|
+
```ruby
|
|
5984
|
+
KlaviyoAPI::Translations.get_flow_message_for_translation(id, opts)
|
|
5985
|
+
```
|
|
5986
|
+
##### Method alias:
|
|
5987
|
+
```ruby
|
|
5988
|
+
KlaviyoAPI::Translations.get_translation_flow_message(id, opts)
|
|
5989
|
+
```
|
|
5990
|
+
|
|
5991
|
+
|
|
5992
|
+
|
|
5993
|
+
|
|
5994
|
+
|
|
5995
|
+
#### [Get Flow Message ID for Translation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_flow_message_id_for_translation)
|
|
5996
|
+
|
|
5997
|
+
```ruby
|
|
5998
|
+
KlaviyoAPI::Translations.get_flow_message_id_for_translation(id)
|
|
5999
|
+
```
|
|
6000
|
+
##### Method alias:
|
|
6001
|
+
```ruby
|
|
6002
|
+
KlaviyoAPI::Translations.get_translation_relationships_flow_message(id)
|
|
6003
|
+
```
|
|
6004
|
+
|
|
6005
|
+
|
|
6006
|
+
|
|
6007
|
+
|
|
6008
|
+
|
|
6009
|
+
#### [Get Template for Translation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_template_for_translation)
|
|
6010
|
+
|
|
6011
|
+
```ruby
|
|
6012
|
+
KlaviyoAPI::Translations.get_template_for_translation(id, opts)
|
|
6013
|
+
```
|
|
6014
|
+
##### Method alias:
|
|
6015
|
+
```ruby
|
|
6016
|
+
KlaviyoAPI::Translations.get_translation_template(id, opts)
|
|
6017
|
+
```
|
|
6018
|
+
|
|
6019
|
+
|
|
6020
|
+
|
|
6021
|
+
|
|
6022
|
+
|
|
6023
|
+
#### [Get Template ID for Translation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_template_id_for_translation)
|
|
6024
|
+
|
|
6025
|
+
```ruby
|
|
6026
|
+
KlaviyoAPI::Translations.get_template_id_for_translation(id)
|
|
6027
|
+
```
|
|
6028
|
+
##### Method alias:
|
|
6029
|
+
```ruby
|
|
6030
|
+
KlaviyoAPI::Translations.get_translation_relationships_template(id)
|
|
6031
|
+
```
|
|
6032
|
+
|
|
6033
|
+
|
|
6034
|
+
|
|
6035
|
+
|
|
6036
|
+
|
|
6037
|
+
#### [Get Template Universal Content for Translation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_template_universal_content_for_translation)
|
|
6038
|
+
|
|
6039
|
+
```ruby
|
|
6040
|
+
KlaviyoAPI::Translations.get_template_universal_content_for_translation(id, opts)
|
|
6041
|
+
```
|
|
6042
|
+
##### Method alias:
|
|
6043
|
+
```ruby
|
|
6044
|
+
KlaviyoAPI::Translations.get_translation_template_universal_content(id, opts)
|
|
6045
|
+
```
|
|
6046
|
+
|
|
6047
|
+
|
|
6048
|
+
|
|
6049
|
+
|
|
6050
|
+
|
|
6051
|
+
#### [Get Template Universal Content ID for Translation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_template_universal_content_id_for_translation)
|
|
6052
|
+
|
|
6053
|
+
```ruby
|
|
6054
|
+
KlaviyoAPI::Translations.get_template_universal_content_id_for_translation(id)
|
|
6055
|
+
```
|
|
6056
|
+
##### Method alias:
|
|
6057
|
+
```ruby
|
|
6058
|
+
KlaviyoAPI::Translations.get_translation_relationships_template_universal_content(id)
|
|
6059
|
+
```
|
|
6060
|
+
|
|
6061
|
+
|
|
6062
|
+
|
|
6063
|
+
|
|
6064
|
+
|
|
6065
|
+
#### [Get Translation](https://developers.klaviyo.com/en/v2026-10-15/reference/get_translation)
|
|
6066
|
+
|
|
6067
|
+
```ruby
|
|
6068
|
+
KlaviyoAPI::Translations.get_translation(id, opts)
|
|
6069
|
+
```
|
|
6070
|
+
|
|
6071
|
+
|
|
6072
|
+
|
|
6073
|
+
|
|
6074
|
+
|
|
6075
|
+
#### [Get Translations](https://developers.klaviyo.com/en/v2026-10-15/reference/get_translations)
|
|
6076
|
+
|
|
6077
|
+
```ruby
|
|
6078
|
+
KlaviyoAPI::Translations.get_translations(opts)
|
|
6079
|
+
```
|
|
6080
|
+
|
|
6081
|
+
|
|
6082
|
+
|
|
6083
|
+
|
|
6084
|
+
|
|
6085
|
+
#### [Update Translation](https://developers.klaviyo.com/en/v2026-10-15/reference/update_translation)
|
|
6086
|
+
|
|
6087
|
+
```ruby
|
|
6088
|
+
KlaviyoAPI::Translations.update_translation(id, body, opts)
|
|
6089
|
+
```
|
|
6090
|
+
|
|
6091
|
+
|
|
6092
|
+
|
|
6093
|
+
|
|
6094
|
+
|
|
6095
|
+
|
|
5030
6096
|
## Web Feeds
|
|
5031
6097
|
|
|
5032
6098
|
|
|
5033
|
-
#### [Create Web Feed](https://developers.klaviyo.com/en/v2026-
|
|
6099
|
+
#### [Create Web Feed](https://developers.klaviyo.com/en/v2026-10-15/reference/create_web_feed)
|
|
5034
6100
|
|
|
5035
6101
|
```ruby
|
|
5036
6102
|
KlaviyoAPI::WebFeeds.create_web_feed(body, opts)
|
|
@@ -5040,7 +6106,7 @@ KlaviyoAPI::WebFeeds.create_web_feed(body, opts)
|
|
|
5040
6106
|
|
|
5041
6107
|
|
|
5042
6108
|
|
|
5043
|
-
#### [Delete Web Feed](https://developers.klaviyo.com/en/v2026-
|
|
6109
|
+
#### [Delete Web Feed](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_web_feed)
|
|
5044
6110
|
|
|
5045
6111
|
```ruby
|
|
5046
6112
|
KlaviyoAPI::WebFeeds.delete_web_feed(id)
|
|
@@ -5050,7 +6116,7 @@ KlaviyoAPI::WebFeeds.delete_web_feed(id)
|
|
|
5050
6116
|
|
|
5051
6117
|
|
|
5052
6118
|
|
|
5053
|
-
#### [Get Web Feed](https://developers.klaviyo.com/en/v2026-
|
|
6119
|
+
#### [Get Web Feed](https://developers.klaviyo.com/en/v2026-10-15/reference/get_web_feed)
|
|
5054
6120
|
|
|
5055
6121
|
```ruby
|
|
5056
6122
|
KlaviyoAPI::WebFeeds.get_web_feed(id, opts)
|
|
@@ -5060,7 +6126,7 @@ KlaviyoAPI::WebFeeds.get_web_feed(id, opts)
|
|
|
5060
6126
|
|
|
5061
6127
|
|
|
5062
6128
|
|
|
5063
|
-
#### [Get Web Feeds](https://developers.klaviyo.com/en/v2026-
|
|
6129
|
+
#### [Get Web Feeds](https://developers.klaviyo.com/en/v2026-10-15/reference/get_web_feeds)
|
|
5064
6130
|
|
|
5065
6131
|
```ruby
|
|
5066
6132
|
KlaviyoAPI::WebFeeds.get_web_feeds(opts)
|
|
@@ -5070,7 +6136,7 @@ KlaviyoAPI::WebFeeds.get_web_feeds(opts)
|
|
|
5070
6136
|
|
|
5071
6137
|
|
|
5072
6138
|
|
|
5073
|
-
#### [Update Web Feed](https://developers.klaviyo.com/en/v2026-
|
|
6139
|
+
#### [Update Web Feed](https://developers.klaviyo.com/en/v2026-10-15/reference/update_web_feed)
|
|
5074
6140
|
|
|
5075
6141
|
```ruby
|
|
5076
6142
|
KlaviyoAPI::WebFeeds.update_web_feed(id, body, opts)
|
|
@@ -5084,7 +6150,7 @@ KlaviyoAPI::WebFeeds.update_web_feed(id, body, opts)
|
|
|
5084
6150
|
## Webhooks
|
|
5085
6151
|
|
|
5086
6152
|
|
|
5087
|
-
#### [Create Webhook](https://developers.klaviyo.com/en/v2026-
|
|
6153
|
+
#### [Create Webhook](https://developers.klaviyo.com/en/v2026-10-15/reference/create_webhook)
|
|
5088
6154
|
|
|
5089
6155
|
```ruby
|
|
5090
6156
|
KlaviyoAPI::Webhooks.create_webhook(body, opts)
|
|
@@ -5094,7 +6160,7 @@ KlaviyoAPI::Webhooks.create_webhook(body, opts)
|
|
|
5094
6160
|
|
|
5095
6161
|
|
|
5096
6162
|
|
|
5097
|
-
#### [Delete Webhook](https://developers.klaviyo.com/en/v2026-
|
|
6163
|
+
#### [Delete Webhook](https://developers.klaviyo.com/en/v2026-10-15/reference/delete_webhook)
|
|
5098
6164
|
|
|
5099
6165
|
```ruby
|
|
5100
6166
|
KlaviyoAPI::Webhooks.delete_webhook(id)
|
|
@@ -5104,7 +6170,7 @@ KlaviyoAPI::Webhooks.delete_webhook(id)
|
|
|
5104
6170
|
|
|
5105
6171
|
|
|
5106
6172
|
|
|
5107
|
-
#### [Get Webhook](https://developers.klaviyo.com/en/v2026-
|
|
6173
|
+
#### [Get Webhook](https://developers.klaviyo.com/en/v2026-10-15/reference/get_webhook)
|
|
5108
6174
|
|
|
5109
6175
|
```ruby
|
|
5110
6176
|
KlaviyoAPI::Webhooks.get_webhook(id, opts)
|
|
@@ -5114,7 +6180,7 @@ KlaviyoAPI::Webhooks.get_webhook(id, opts)
|
|
|
5114
6180
|
|
|
5115
6181
|
|
|
5116
6182
|
|
|
5117
|
-
#### [Get Webhook Topic](https://developers.klaviyo.com/en/v2026-
|
|
6183
|
+
#### [Get Webhook Topic](https://developers.klaviyo.com/en/v2026-10-15/reference/get_webhook_topic)
|
|
5118
6184
|
|
|
5119
6185
|
```ruby
|
|
5120
6186
|
KlaviyoAPI::Webhooks.get_webhook_topic(id, opts)
|
|
@@ -5124,7 +6190,7 @@ KlaviyoAPI::Webhooks.get_webhook_topic(id, opts)
|
|
|
5124
6190
|
|
|
5125
6191
|
|
|
5126
6192
|
|
|
5127
|
-
#### [Get Webhook Topics](https://developers.klaviyo.com/en/v2026-
|
|
6193
|
+
#### [Get Webhook Topics](https://developers.klaviyo.com/en/v2026-10-15/reference/get_webhook_topics)
|
|
5128
6194
|
|
|
5129
6195
|
```ruby
|
|
5130
6196
|
KlaviyoAPI::Webhooks.get_webhook_topics(opts)
|
|
@@ -5134,7 +6200,7 @@ KlaviyoAPI::Webhooks.get_webhook_topics(opts)
|
|
|
5134
6200
|
|
|
5135
6201
|
|
|
5136
6202
|
|
|
5137
|
-
#### [Get Webhooks](https://developers.klaviyo.com/en/v2026-
|
|
6203
|
+
#### [Get Webhooks](https://developers.klaviyo.com/en/v2026-10-15/reference/get_webhooks)
|
|
5138
6204
|
|
|
5139
6205
|
```ruby
|
|
5140
6206
|
KlaviyoAPI::Webhooks.get_webhooks(opts)
|
|
@@ -5144,7 +6210,7 @@ KlaviyoAPI::Webhooks.get_webhooks(opts)
|
|
|
5144
6210
|
|
|
5145
6211
|
|
|
5146
6212
|
|
|
5147
|
-
#### [Update Webhook](https://developers.klaviyo.com/en/v2026-
|
|
6213
|
+
#### [Update Webhook](https://developers.klaviyo.com/en/v2026-10-15/reference/update_webhook)
|
|
5148
6214
|
|
|
5149
6215
|
```ruby
|
|
5150
6216
|
KlaviyoAPI::Webhooks.update_webhook(id, body, opts)
|