klaviyo-api-sdk 13.0.1 → 14.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 +12 -0
- data/README.md +434 -286
- data/klaviyo-api-sdk.gemspec +1 -1
- data/lib/klaviyo-api-sdk/api/accounts_api.rb +6 -6
- data/lib/klaviyo-api-sdk/api/campaigns_api.rb +82 -82
- data/lib/klaviyo-api-sdk/api/catalogs_api.rb +235 -235
- data/lib/klaviyo-api-sdk/api/coupons_api.rb +63 -63
- data/lib/klaviyo-api-sdk/api/custom_objects_api.rb +384 -0
- data/lib/klaviyo-api-sdk/api/data_privacy_api.rb +1 -1
- data/lib/klaviyo-api-sdk/api/events_api.rb +34 -34
- data/lib/klaviyo-api-sdk/api/flows_api.rb +93 -93
- data/lib/klaviyo-api-sdk/api/forms_api.rb +40 -40
- data/lib/klaviyo-api-sdk/api/images_api.rb +15 -15
- data/lib/klaviyo-api-sdk/api/lists_api.rb +59 -59
- data/lib/klaviyo-api-sdk/api/metrics_api.rb +643 -59
- data/lib/klaviyo-api-sdk/api/profiles_api.rb +128 -128
- data/lib/klaviyo-api-sdk/api/reporting_api.rb +13 -13
- data/lib/klaviyo-api-sdk/api/reviews_api.rb +21 -21
- data/lib/klaviyo-api-sdk/api/segments_api.rb +53 -53
- data/lib/klaviyo-api-sdk/api/tags_api.rb +58 -58
- data/lib/klaviyo-api-sdk/api/templates_api.rb +36 -36
- data/lib/klaviyo-api-sdk/api/tracking_settings_api.rb +15 -15
- data/lib/klaviyo-api-sdk/api/web_feeds_api.rb +15 -15
- data/lib/klaviyo-api-sdk/api/webhooks_api.rb +15 -15
- data/lib/klaviyo-api-sdk/api_client.rb +1 -1
- data/lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/button_block.rb +247 -0
- data/lib/klaviyo-api-sdk/models/{custom_object_property_enum.rb → button_enum.rb} +4 -4
- data/lib/klaviyo-api-sdk/models/campaign_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/condition_group_conditions_inner.rb +3 -0
- data/lib/klaviyo-api-sdk/models/conditional_branch_action_data_profile_filter_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/data_source_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/data_source_create_query_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/data_source_create_query_resource_object_attributes.rb +284 -0
- data/lib/klaviyo-api-sdk/models/data_source_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object.rb +246 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_attributes.rb +219 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships.rb +218 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_create_query_resource_object_relationships_data_source.rb +218 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_bulk_create_job_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_resource_object.rb +237 -0
- data/lib/klaviyo-api-sdk/models/data_source_record_resource_object_attributes.rb +223 -0
- data/lib/klaviyo-api-sdk/models/drop_shadow_block.rb +247 -0
- data/lib/klaviyo-api-sdk/models/drop_shadow_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/{trigger_branch_action_data_trigger_filter.rb → dsr_bulk_create_attrs_data_source_records.rb} +15 -14
- data/lib/klaviyo-api-sdk/models/dsr_bulk_create_rels_data_source_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/event_create_query_v2_resource_object_attributes.rb +1 -1
- data/lib/klaviyo-api-sdk/models/flow_definition_profile_filter_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_email_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_push_notification_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/flow_sms_additional_filters_condition_groups_inner_conditions_inner.rb +1 -0
- data/lib/klaviyo-api-sdk/models/horizontal_rule_block.rb +247 -0
- data/lib/klaviyo-api-sdk/models/horizontal_rule_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/image_block.rb +247 -0
- data/lib/klaviyo-api-sdk/models/mapped_metric_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query.rb +223 -0
- data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object.rb +281 -0
- data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships.rb +227 -0
- data/lib/klaviyo-api-sdk/models/{trigger_branch_action_data_trigger_filter_condition_groups_inner.rb → mapped_metric_partial_update_query_resource_object_relationships_custom_metric.rb} +10 -17
- data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships_custom_metric_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships_metric.rb +218 -0
- data/lib/klaviyo-api-sdk/models/mapped_metric_partial_update_query_resource_object_relationships_metric_data.rb +238 -0
- data/lib/klaviyo-api-sdk/models/priority_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_priority_condition.rb +327 -0
- data/lib/klaviyo-api-sdk/models/{custom_object_property_condition.rb → profile_predictive_analytics_channel_affinity_priority_filter.rb} +23 -37
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_condition.rb +327 -0
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_channel_affinity_rank_filter.rb +286 -0
- data/lib/klaviyo-api-sdk/models/profile_predictive_analytics_date_condition.rb +286 -0
- data/lib/klaviyo-api-sdk/models/rank_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/segment_values_request_dto_resource_object_attributes_timeframe.rb +1 -1
- data/lib/klaviyo-api-sdk/models/spacer_block.rb +247 -0
- data/lib/klaviyo-api-sdk/models/spacer_enum.rb +35 -0
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data.rb +6 -2
- data/lib/klaviyo-api-sdk/models/universal_content_create_query_resource_object_attributes_definition.rb +5 -0
- data/lib/klaviyo-api-sdk/models/universal_content_partial_update_query_resource_object_attributes_definition.rb +5 -0
- data/lib/klaviyo-api-sdk.rb +40 -5
- data/lib/klaviyo-api-sdk.rb.bak +974 -0
- metadata +43 -7
- data/lib/klaviyo-api-sdk/models/trigger_branch_action_data_trigger_filter_condition_groups_inner_conditions_inner.rb +0 -106
@@ -56,7 +56,7 @@ module KlaviyoAPI
|
|
56
56
|
# header parameters
|
57
57
|
header_params = opts[:header_params] || {}
|
58
58
|
# klaviyo api revision
|
59
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
59
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
60
60
|
# HTTP header 'Accept' (if needed)
|
61
61
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
62
62
|
# HTTP header 'Content-Type'
|
@@ -138,7 +138,7 @@ module KlaviyoAPI
|
|
138
138
|
# header parameters
|
139
139
|
header_params = opts[:header_params] || {}
|
140
140
|
# klaviyo api revision
|
141
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
141
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
142
142
|
# HTTP header 'Accept' (if needed)
|
143
143
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
144
144
|
# HTTP header 'Content-Type'
|
@@ -220,7 +220,7 @@ module KlaviyoAPI
|
|
220
220
|
# header parameters
|
221
221
|
header_params = opts[:header_params] || {}
|
222
222
|
# klaviyo api revision
|
223
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
223
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
224
224
|
# HTTP header 'Accept' (if needed)
|
225
225
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
226
226
|
# HTTP header 'Content-Type'
|
@@ -302,7 +302,7 @@ module KlaviyoAPI
|
|
302
302
|
# header parameters
|
303
303
|
header_params = opts[:header_params] || {}
|
304
304
|
# klaviyo api revision
|
305
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
305
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
306
306
|
# HTTP header 'Accept' (if needed)
|
307
307
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
308
308
|
# HTTP header 'Content-Type'
|
@@ -384,7 +384,7 @@ module KlaviyoAPI
|
|
384
384
|
# header parameters
|
385
385
|
header_params = opts[:header_params] || {}
|
386
386
|
# klaviyo api revision
|
387
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
387
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
388
388
|
# HTTP header 'Accept' (if needed)
|
389
389
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
390
390
|
# HTTP header 'Content-Type'
|
@@ -470,7 +470,7 @@ module KlaviyoAPI
|
|
470
470
|
# header parameters
|
471
471
|
header_params = opts[:header_params] || {}
|
472
472
|
# klaviyo api revision
|
473
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
473
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
474
474
|
# HTTP header 'Accept' (if needed)
|
475
475
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
476
476
|
# HTTP header 'Content-Type'
|
@@ -550,7 +550,7 @@ module KlaviyoAPI
|
|
550
550
|
# header parameters
|
551
551
|
header_params = opts[:header_params] || {}
|
552
552
|
# klaviyo api revision
|
553
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
553
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
554
554
|
# HTTP header 'Accept' (if needed)
|
555
555
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
556
556
|
# HTTP header 'Content-Type'
|
@@ -620,7 +620,7 @@ module KlaviyoAPI
|
|
620
620
|
# header parameters
|
621
621
|
header_params = opts[:header_params] || {}
|
622
622
|
# klaviyo api revision
|
623
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
623
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
624
624
|
# HTTP header 'Accept' (if needed)
|
625
625
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
626
626
|
# HTTP header 'Content-Type'
|
@@ -690,7 +690,7 @@ module KlaviyoAPI
|
|
690
690
|
# header parameters
|
691
691
|
header_params = opts[:header_params] || {}
|
692
692
|
# klaviyo api revision
|
693
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
693
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
694
694
|
# HTTP header 'Accept' (if needed)
|
695
695
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
696
696
|
|
@@ -727,9 +727,9 @@ module KlaviyoAPI
|
|
727
727
|
# Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
728
728
|
# @param job_id [String] ID of the job to retrieve.
|
729
729
|
# @param [Hash] opts the optional parameters
|
730
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
731
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
732
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
730
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
731
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
732
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
733
733
|
# @return [Hash<String, Object>]
|
734
734
|
def get_bulk_import_profiles_job(job_id, opts = {})
|
735
735
|
data, _status_code, _headers = get_bulk_import_profiles_job_with_http_info(job_id, opts)
|
@@ -746,9 +746,9 @@ module KlaviyoAPI
|
|
746
746
|
# Get a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
747
747
|
# @param job_id [String] ID of the job to retrieve.
|
748
748
|
# @param [Hash] opts the optional parameters
|
749
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
750
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
751
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
749
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
750
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
751
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
752
752
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
753
753
|
def get_bulk_import_profiles_job_with_http_info(job_id, opts = {})
|
754
754
|
if @api_client.config.debugging
|
@@ -782,7 +782,7 @@ module KlaviyoAPI
|
|
782
782
|
# header parameters
|
783
783
|
header_params = opts[:header_params] || {}
|
784
784
|
# klaviyo api revision
|
785
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
785
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
786
786
|
# HTTP header 'Accept' (if needed)
|
787
787
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
788
788
|
|
@@ -824,11 +824,11 @@ module KlaviyoAPI
|
|
824
824
|
# Get Bulk Import Profiles Jobs
|
825
825
|
# Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
826
826
|
# @param [Hash] opts the optional parameters
|
827
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
828
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
829
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
827
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
828
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
829
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
830
830
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
831
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
831
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
832
832
|
# @return [Hash<String, Object>]
|
833
833
|
def get_bulk_import_profiles_jobs(opts = {})
|
834
834
|
data, _status_code, _headers = get_bulk_import_profiles_jobs_with_http_info(opts)
|
@@ -844,11 +844,11 @@ module KlaviyoAPI
|
|
844
844
|
# Get Bulk Import Profiles Jobs
|
845
845
|
# Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
|
846
846
|
# @param [Hash] opts the optional parameters
|
847
|
-
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
848
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
849
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
847
|
+
# @option opts [Array<String>] :fields_profile_bulk_import_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
848
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
|
849
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
850
850
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
851
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
851
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
852
852
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
853
853
|
def get_bulk_import_profiles_jobs_with_http_info(opts = {})
|
854
854
|
if @api_client.config.debugging
|
@@ -884,7 +884,7 @@ module KlaviyoAPI
|
|
884
884
|
# header parameters
|
885
885
|
header_params = opts[:header_params] || {}
|
886
886
|
# klaviyo api revision
|
887
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
887
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
888
888
|
# HTTP header 'Accept' (if needed)
|
889
889
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
890
890
|
|
@@ -927,7 +927,7 @@ module KlaviyoAPI
|
|
927
927
|
# Get the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
928
928
|
# @param job_id [String] ID of the job to retrieve.
|
929
929
|
# @param [Hash] opts the optional parameters
|
930
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
930
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
931
931
|
# @return [Hash<String, Object>]
|
932
932
|
def get_bulk_suppress_profiles_job(job_id, opts = {})
|
933
933
|
data, _status_code, _headers = get_bulk_suppress_profiles_job_with_http_info(job_id, opts)
|
@@ -941,7 +941,7 @@ module KlaviyoAPI
|
|
941
941
|
# Get the bulk suppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
942
942
|
# @param job_id [String] ID of the job to retrieve.
|
943
943
|
# @param [Hash] opts the optional parameters
|
944
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
944
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
945
945
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
946
946
|
def get_bulk_suppress_profiles_job_with_http_info(job_id, opts = {})
|
947
947
|
if @api_client.config.debugging
|
@@ -965,7 +965,7 @@ module KlaviyoAPI
|
|
965
965
|
# header parameters
|
966
966
|
header_params = opts[:header_params] || {}
|
967
967
|
# klaviyo api revision
|
968
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
968
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
969
969
|
# HTTP header 'Accept' (if needed)
|
970
970
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
971
971
|
|
@@ -1004,10 +1004,10 @@ module KlaviyoAPI
|
|
1004
1004
|
# Get Bulk Suppress Profiles Jobs
|
1005
1005
|
# Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
1006
1006
|
# @param [Hash] opts the optional parameters
|
1007
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1008
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1009
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1010
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
1007
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1008
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
1009
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1010
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
1011
1011
|
# @return [Hash<String, Object>]
|
1012
1012
|
def get_bulk_suppress_profiles_jobs(opts = {})
|
1013
1013
|
data, _status_code, _headers = get_bulk_suppress_profiles_jobs_with_http_info(opts)
|
@@ -1020,10 +1020,10 @@ module KlaviyoAPI
|
|
1020
1020
|
# Get Bulk Suppress Profiles Jobs
|
1021
1021
|
# Get the status of all bulk profile suppression jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
1022
1022
|
# @param [Hash] opts the optional parameters
|
1023
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1024
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1025
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1026
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
1023
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_create_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1024
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
1025
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1026
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
1027
1027
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1028
1028
|
def get_bulk_suppress_profiles_jobs_with_http_info(opts = {})
|
1029
1029
|
if @api_client.config.debugging
|
@@ -1050,7 +1050,7 @@ module KlaviyoAPI
|
|
1050
1050
|
# header parameters
|
1051
1051
|
header_params = opts[:header_params] || {}
|
1052
1052
|
# klaviyo api revision
|
1053
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1053
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1054
1054
|
# HTTP header 'Accept' (if needed)
|
1055
1055
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1056
1056
|
|
@@ -1090,7 +1090,7 @@ module KlaviyoAPI
|
|
1090
1090
|
# Get the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
1091
1091
|
# @param job_id [String] ID of the job to retrieve.
|
1092
1092
|
# @param [Hash] opts the optional parameters
|
1093
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1093
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1094
1094
|
# @return [Hash<String, Object>]
|
1095
1095
|
def get_bulk_unsuppress_profiles_job(job_id, opts = {})
|
1096
1096
|
data, _status_code, _headers = get_bulk_unsuppress_profiles_job_with_http_info(job_id, opts)
|
@@ -1104,7 +1104,7 @@ module KlaviyoAPI
|
|
1104
1104
|
# Get the bulk unsuppress profiles job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
1105
1105
|
# @param job_id [String] ID of the job to retrieve.
|
1106
1106
|
# @param [Hash] opts the optional parameters
|
1107
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1107
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1108
1108
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1109
1109
|
def get_bulk_unsuppress_profiles_job_with_http_info(job_id, opts = {})
|
1110
1110
|
if @api_client.config.debugging
|
@@ -1128,7 +1128,7 @@ module KlaviyoAPI
|
|
1128
1128
|
# header parameters
|
1129
1129
|
header_params = opts[:header_params] || {}
|
1130
1130
|
# klaviyo api revision
|
1131
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1131
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1132
1132
|
# HTTP header 'Accept' (if needed)
|
1133
1133
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1134
1134
|
|
@@ -1167,10 +1167,10 @@ module KlaviyoAPI
|
|
1167
1167
|
# Get Bulk Unsuppress Profiles Jobs
|
1168
1168
|
# Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
1169
1169
|
# @param [Hash] opts the optional parameters
|
1170
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1171
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1172
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1173
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
1170
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1171
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
1172
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1173
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
1174
1174
|
# @return [Hash<String, Object>]
|
1175
1175
|
def get_bulk_unsuppress_profiles_jobs(opts = {})
|
1176
1176
|
data, _status_code, _headers = get_bulk_unsuppress_profiles_jobs_with_http_info(opts)
|
@@ -1183,10 +1183,10 @@ module KlaviyoAPI
|
|
1183
1183
|
# Get Bulk Unsuppress Profiles Jobs
|
1184
1184
|
# Get all bulk unsuppress profiles jobs.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `subscriptions:read`
|
1185
1185
|
# @param [Hash] opts the optional parameters
|
1186
|
-
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-
|
1187
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
1188
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1189
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
1186
|
+
# @option opts [Array<String>] :fields_profile_suppression_bulk_delete_job For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1187
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`<br>`list_id`: `equals`<br>`segment_id`: `equals`
|
1188
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1189
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
1190
1190
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1191
1191
|
def get_bulk_unsuppress_profiles_jobs_with_http_info(opts = {})
|
1192
1192
|
if @api_client.config.debugging
|
@@ -1213,7 +1213,7 @@ module KlaviyoAPI
|
|
1213
1213
|
# header parameters
|
1214
1214
|
header_params = opts[:header_params] || {}
|
1215
1215
|
# klaviyo api revision
|
1216
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1216
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1217
1217
|
# HTTP header 'Accept' (if needed)
|
1218
1218
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1219
1219
|
|
@@ -1253,8 +1253,8 @@ module KlaviyoAPI
|
|
1253
1253
|
# Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
1254
1254
|
# @param id [String]
|
1255
1255
|
# @param [Hash] opts the optional parameters
|
1256
|
-
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2025-
|
1257
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1256
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1257
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1258
1258
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1259
1259
|
# @return [Hash<String, Object>]
|
1260
1260
|
def get_errors_for_bulk_import_profiles_job(id, opts = {})
|
@@ -1275,8 +1275,8 @@ module KlaviyoAPI
|
|
1275
1275
|
# Get import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
1276
1276
|
# @param id [String]
|
1277
1277
|
# @param [Hash] opts the optional parameters
|
1278
|
-
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2025-
|
1279
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1278
|
+
# @option opts [Array<String>] :fields_import_error For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1279
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1280
1280
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1281
1281
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1282
1282
|
def get_errors_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
@@ -1311,7 +1311,7 @@ module KlaviyoAPI
|
|
1311
1311
|
# header parameters
|
1312
1312
|
header_params = opts[:header_params] || {}
|
1313
1313
|
# klaviyo api revision
|
1314
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1314
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1315
1315
|
# HTTP header 'Accept' (if needed)
|
1316
1316
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1317
1317
|
|
@@ -1357,7 +1357,7 @@ module KlaviyoAPI
|
|
1357
1357
|
# Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
1358
1358
|
# @param id [String]
|
1359
1359
|
# @param [Hash] opts the optional parameters
|
1360
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
1360
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1361
1361
|
# @return [Hash<String, Object>]
|
1362
1362
|
def get_list_for_bulk_import_profiles_job(id, opts = {})
|
1363
1363
|
data, _status_code, _headers = get_list_for_bulk_import_profiles_job_with_http_info(id, opts)
|
@@ -1377,7 +1377,7 @@ module KlaviyoAPI
|
|
1377
1377
|
# Get list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
|
1378
1378
|
# @param id [String]
|
1379
1379
|
# @param [Hash] opts the optional parameters
|
1380
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
1380
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1381
1381
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1382
1382
|
def get_list_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
1383
1383
|
if @api_client.config.debugging
|
@@ -1401,7 +1401,7 @@ module KlaviyoAPI
|
|
1401
1401
|
# header parameters
|
1402
1402
|
header_params = opts[:header_params] || {}
|
1403
1403
|
# klaviyo api revision
|
1404
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1404
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1405
1405
|
# HTTP header 'Accept' (if needed)
|
1406
1406
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1407
1407
|
|
@@ -1484,7 +1484,7 @@ module KlaviyoAPI
|
|
1484
1484
|
# header parameters
|
1485
1485
|
header_params = opts[:header_params] || {}
|
1486
1486
|
# klaviyo api revision
|
1487
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1487
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1488
1488
|
# HTTP header 'Accept' (if needed)
|
1489
1489
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1490
1490
|
|
@@ -1561,7 +1561,7 @@ module KlaviyoAPI
|
|
1561
1561
|
# header parameters
|
1562
1562
|
header_params = opts[:header_params] || {}
|
1563
1563
|
# klaviyo api revision
|
1564
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1564
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1565
1565
|
# HTTP header 'Accept' (if needed)
|
1566
1566
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1567
1567
|
|
@@ -1601,7 +1601,7 @@ module KlaviyoAPI
|
|
1601
1601
|
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
|
1602
1602
|
# @param id [String]
|
1603
1603
|
# @param [Hash] opts the optional parameters
|
1604
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
1604
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1605
1605
|
# @return [Hash<String, Object>]
|
1606
1606
|
def get_lists_for_profile(id, opts = {})
|
1607
1607
|
data, _status_code, _headers = get_lists_for_profile_with_http_info(id, opts)
|
@@ -1615,7 +1615,7 @@ module KlaviyoAPI
|
|
1615
1615
|
# Get list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
|
1616
1616
|
# @param id [String]
|
1617
1617
|
# @param [Hash] opts the optional parameters
|
1618
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
1618
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1619
1619
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1620
1620
|
def get_lists_for_profile_with_http_info(id, opts = {})
|
1621
1621
|
if @api_client.config.debugging
|
@@ -1639,7 +1639,7 @@ module KlaviyoAPI
|
|
1639
1639
|
# header parameters
|
1640
1640
|
header_params = opts[:header_params] || {}
|
1641
1641
|
# klaviyo api revision
|
1642
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1642
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1643
1643
|
# HTTP header 'Accept' (if needed)
|
1644
1644
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1645
1645
|
|
@@ -1676,15 +1676,15 @@ module KlaviyoAPI
|
|
1676
1676
|
alias get_profile_lists_with_http_info get_lists_for_profile_with_http_info
|
1677
1677
|
|
1678
1678
|
# Get Profile
|
1679
|
-
# Get the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `include=list` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>Rate limits when using the `include=segment` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-
|
1679
|
+
# Get the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `include=list` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>Rate limits when using the `include=segment` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1680
1680
|
# @param id [String]
|
1681
1681
|
# @param [Hash] opts the optional parameters
|
1682
1682
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1683
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
1684
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
1685
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-
|
1686
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-
|
1687
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
1683
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1684
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1685
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1686
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1687
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
1688
1688
|
# @return [Hash<String, Object>]
|
1689
1689
|
def get_profile(id, opts = {})
|
1690
1690
|
data, _status_code, _headers = get_profile_with_http_info(id, opts)
|
@@ -1692,15 +1692,15 @@ module KlaviyoAPI
|
|
1692
1692
|
end
|
1693
1693
|
|
1694
1694
|
# Get Profile
|
1695
|
-
# Get the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `include=list` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>Rate limits when using the `include=segment` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-
|
1695
|
+
# Get the profile with the given profile ID. Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `include=list` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>Rate limits when using the `include=segment` parameter in your API request:<br>Burst: `1/s`<br>Steady: `15/m`<br><br>To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
1696
1696
|
# @param id [String]
|
1697
1697
|
# @param [Hash] opts the optional parameters
|
1698
1698
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1699
|
-
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-
|
1700
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
1701
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-
|
1702
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-
|
1703
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
1699
|
+
# @option opts [Array<String>] :fields_list For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1700
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1701
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1702
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1703
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
1704
1704
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1705
1705
|
def get_profile_with_http_info(id, opts = {})
|
1706
1706
|
if @api_client.config.debugging
|
@@ -1749,7 +1749,7 @@ module KlaviyoAPI
|
|
1749
1749
|
# header parameters
|
1750
1750
|
header_params = opts[:header_params] || {}
|
1751
1751
|
# klaviyo api revision
|
1752
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1752
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1753
1753
|
# HTTP header 'Accept' (if needed)
|
1754
1754
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1755
1755
|
|
@@ -1787,7 +1787,7 @@ module KlaviyoAPI
|
|
1787
1787
|
# @param id [String] The value of the push token
|
1788
1788
|
# @param [Hash] opts the optional parameters
|
1789
1789
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1790
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
1790
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1791
1791
|
# @return [Hash<String, Object>]
|
1792
1792
|
def get_profile_for_push_token(id, opts = {})
|
1793
1793
|
data, _status_code, _headers = get_profile_for_push_token_with_http_info(id, opts)
|
@@ -1802,7 +1802,7 @@ module KlaviyoAPI
|
|
1802
1802
|
# @param id [String] The value of the push token
|
1803
1803
|
# @param [Hash] opts the optional parameters
|
1804
1804
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
1805
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
1805
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
1806
1806
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1807
1807
|
def get_profile_for_push_token_with_http_info(id, opts = {})
|
1808
1808
|
if @api_client.config.debugging
|
@@ -1831,7 +1831,7 @@ module KlaviyoAPI
|
|
1831
1831
|
# header parameters
|
1832
1832
|
header_params = opts[:header_params] || {}
|
1833
1833
|
# klaviyo api revision
|
1834
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1834
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1835
1835
|
# HTTP header 'Accept' (if needed)
|
1836
1836
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1837
1837
|
|
@@ -1902,7 +1902,7 @@ module KlaviyoAPI
|
|
1902
1902
|
# header parameters
|
1903
1903
|
header_params = opts[:header_params] || {}
|
1904
1904
|
# klaviyo api revision
|
1905
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1905
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1906
1906
|
# HTTP header 'Accept' (if needed)
|
1907
1907
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1908
1908
|
|
@@ -1942,7 +1942,7 @@ module KlaviyoAPI
|
|
1942
1942
|
# Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
1943
1943
|
# @param id [String]
|
1944
1944
|
# @param [Hash] opts the optional parameters
|
1945
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1945
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1946
1946
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1947
1947
|
# @return [Hash<String, Object>]
|
1948
1948
|
def get_profile_ids_for_bulk_import_profiles_job(id, opts = {})
|
@@ -1963,7 +1963,7 @@ module KlaviyoAPI
|
|
1963
1963
|
# Get profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
1964
1964
|
# @param id [String]
|
1965
1965
|
# @param [Hash] opts the optional parameters
|
1966
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
1966
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
1967
1967
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
1968
1968
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
1969
1969
|
def get_profile_ids_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
@@ -1993,7 +1993,7 @@ module KlaviyoAPI
|
|
1993
1993
|
# header parameters
|
1994
1994
|
header_params = opts[:header_params] || {}
|
1995
1995
|
# klaviyo api revision
|
1996
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
1996
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
1997
1997
|
# HTTP header 'Accept' (if needed)
|
1998
1998
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
1999
1999
|
|
@@ -2036,15 +2036,15 @@ module KlaviyoAPI
|
|
2036
2036
|
alias get_profile_ids_for_profile_bulk_import_job_with_http_info get_profile_ids_for_bulk_import_profiles_job_with_http_info
|
2037
2037
|
|
2038
2038
|
# Get Profiles
|
2039
|
-
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp` Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-
|
2039
|
+
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp` Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
2040
2040
|
# @param [Hash] opts the optional parameters
|
2041
2041
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
2042
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
2043
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
2044
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
2045
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2042
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2043
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.reason`: `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.list_id`: `equals`<br>`subscriptions.email.marketing.suppression.reason`: `equals`<br>`subscriptions.email.marketing.suppression.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
2044
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
2045
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
2046
2046
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
2047
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
2047
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
2048
2048
|
# @return [Hash<String, Object>]
|
2049
2049
|
def get_profiles(opts = {})
|
2050
2050
|
data, _status_code, _headers = get_profiles_with_http_info(opts)
|
@@ -2052,15 +2052,15 @@ module KlaviyoAPI
|
|
2052
2052
|
end
|
2053
2053
|
|
2054
2054
|
# Get Profiles
|
2055
|
-
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp` Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-
|
2055
|
+
# Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp` Use the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m`<br><br>Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:<br>Burst: `10/s`<br>Steady: `150/m`<br><br>To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2025-07-15/docs/rate_limits_and_error_handling) guide. **Scopes:** `profiles:read`
|
2056
2056
|
# @param [Hash] opts the optional parameters
|
2057
2057
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
2058
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
2059
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
2060
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
2061
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2058
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2059
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`external_id`: `any`, `equals`<br>`_kx`: `equals`<br>`created`: `greater-than`, `less-than`<br>`updated`: `greater-than`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.reason`: `equals`<br>`subscriptions.email.marketing.list_suppressions.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`subscriptions.email.marketing.list_suppressions.list_id`: `equals`<br>`subscriptions.email.marketing.suppression.reason`: `equals`<br>`subscriptions.email.marketing.suppression.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
|
2060
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
2061
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
2062
2062
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
2063
|
-
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-
|
2063
|
+
# @option opts [String] :sort For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sorting
|
2064
2064
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2065
2065
|
def get_profiles_with_http_info(opts = {})
|
2066
2066
|
if @api_client.config.debugging
|
@@ -2106,7 +2106,7 @@ module KlaviyoAPI
|
|
2106
2106
|
# header parameters
|
2107
2107
|
header_params = opts[:header_params] || {}
|
2108
2108
|
# klaviyo api revision
|
2109
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2109
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
2110
2110
|
# HTTP header 'Accept' (if needed)
|
2111
2111
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2112
2112
|
|
@@ -2144,8 +2144,8 @@ module KlaviyoAPI
|
|
2144
2144
|
# @param id [String]
|
2145
2145
|
# @param [Hash] opts the optional parameters
|
2146
2146
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
2147
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
2148
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2147
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2148
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
2149
2149
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
2150
2150
|
# @return [Hash<String, Object>]
|
2151
2151
|
def get_profiles_for_bulk_import_profiles_job(id, opts = {})
|
@@ -2167,8 +2167,8 @@ module KlaviyoAPI
|
|
2167
2167
|
# @param id [String]
|
2168
2168
|
# @param [Hash] opts the optional parameters
|
2169
2169
|
# @option opts [Array<String>] :additional_fields_profile Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'
|
2170
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
2171
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2170
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2171
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
2172
2172
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
2173
2173
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2174
2174
|
def get_profiles_for_bulk_import_profiles_job_with_http_info(id, opts = {})
|
@@ -2208,7 +2208,7 @@ module KlaviyoAPI
|
|
2208
2208
|
# header parameters
|
2209
2209
|
header_params = opts[:header_params] || {}
|
2210
2210
|
# klaviyo api revision
|
2211
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2211
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
2212
2212
|
# HTTP header 'Accept' (if needed)
|
2213
2213
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2214
2214
|
|
@@ -2254,9 +2254,9 @@ module KlaviyoAPI
|
|
2254
2254
|
# Return a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read`
|
2255
2255
|
# @param id [String] The value of the push token
|
2256
2256
|
# @param [Hash] opts the optional parameters
|
2257
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
2258
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-
|
2259
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
2257
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2258
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2259
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
2260
2260
|
# @return [Hash<String, Object>]
|
2261
2261
|
def get_push_token(id, opts = {})
|
2262
2262
|
data, _status_code, _headers = get_push_token_with_http_info(id, opts)
|
@@ -2267,9 +2267,9 @@ module KlaviyoAPI
|
|
2267
2267
|
# Return a specific push token based on its ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read`
|
2268
2268
|
# @param id [String] The value of the push token
|
2269
2269
|
# @param [Hash] opts the optional parameters
|
2270
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
2271
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-
|
2272
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
2270
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2271
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2272
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
2273
2273
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2274
2274
|
def get_push_token_with_http_info(id, opts = {})
|
2275
2275
|
if @api_client.config.debugging
|
@@ -2303,7 +2303,7 @@ module KlaviyoAPI
|
|
2303
2303
|
# header parameters
|
2304
2304
|
header_params = opts[:header_params] || {}
|
2305
2305
|
# klaviyo api revision
|
2306
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2306
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
2307
2307
|
# HTTP header 'Accept' (if needed)
|
2308
2308
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2309
2309
|
|
@@ -2371,7 +2371,7 @@ module KlaviyoAPI
|
|
2371
2371
|
# header parameters
|
2372
2372
|
header_params = opts[:header_params] || {}
|
2373
2373
|
# klaviyo api revision
|
2374
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2374
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
2375
2375
|
# HTTP header 'Accept' (if needed)
|
2376
2376
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2377
2377
|
|
@@ -2410,11 +2410,11 @@ module KlaviyoAPI
|
|
2410
2410
|
# Get Push Tokens
|
2411
2411
|
# Return push tokens associated with company.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read`
|
2412
2412
|
# @param [Hash] opts the optional parameters
|
2413
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
2414
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-
|
2415
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
2416
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
2417
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2413
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2414
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2415
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `equals`<br>`profile.id`: `equals`<br>`enablement_status`: `equals`<br>`platform`: `equals`
|
2416
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
2417
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
2418
2418
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
2419
2419
|
# @return [Hash<String, Object>]
|
2420
2420
|
def get_push_tokens(opts = {})
|
@@ -2425,11 +2425,11 @@ module KlaviyoAPI
|
|
2425
2425
|
# Get Push Tokens
|
2426
2426
|
# Return push tokens associated with company.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read` `push-tokens:read`
|
2427
2427
|
# @param [Hash] opts the optional parameters
|
2428
|
-
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-
|
2429
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-
|
2430
|
-
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-
|
2431
|
-
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-
|
2432
|
-
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-
|
2428
|
+
# @option opts [Array<String>] :fields_profile For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2429
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2430
|
+
# @option opts [String] :filter For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `equals`<br>`profile.id`: `equals`<br>`enablement_status`: `equals`<br>`platform`: `equals`
|
2431
|
+
# @option opts [Array<String>] :include For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#relationships
|
2432
|
+
# @option opts [String] :page_cursor For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#pagination
|
2433
2433
|
# @option opts [Integer] :page_size Default: 20. Min: 1. Max: 100. (default to 20)
|
2434
2434
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2435
2435
|
def get_push_tokens_with_http_info(opts = {})
|
@@ -2471,7 +2471,7 @@ module KlaviyoAPI
|
|
2471
2471
|
# header parameters
|
2472
2472
|
header_params = opts[:header_params] || {}
|
2473
2473
|
# klaviyo api revision
|
2474
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2474
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
2475
2475
|
# HTTP header 'Accept' (if needed)
|
2476
2476
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2477
2477
|
|
@@ -2508,7 +2508,7 @@ module KlaviyoAPI
|
|
2508
2508
|
# Return all push tokens that belong to the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
2509
2509
|
# @param id [String]
|
2510
2510
|
# @param [Hash] opts the optional parameters
|
2511
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-
|
2511
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2512
2512
|
# @return [Hash<String, Object>]
|
2513
2513
|
def get_push_tokens_for_profile(id, opts = {})
|
2514
2514
|
data, _status_code, _headers = get_push_tokens_for_profile_with_http_info(id, opts)
|
@@ -2522,7 +2522,7 @@ module KlaviyoAPI
|
|
2522
2522
|
# Return all push tokens that belong to the given profile.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
|
2523
2523
|
# @param id [String]
|
2524
2524
|
# @param [Hash] opts the optional parameters
|
2525
|
-
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-
|
2525
|
+
# @option opts [Array<String>] :fields_push_token For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2526
2526
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2527
2527
|
def get_push_tokens_for_profile_with_http_info(id, opts = {})
|
2528
2528
|
if @api_client.config.debugging
|
@@ -2546,7 +2546,7 @@ module KlaviyoAPI
|
|
2546
2546
|
# header parameters
|
2547
2547
|
header_params = opts[:header_params] || {}
|
2548
2548
|
# klaviyo api revision
|
2549
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2549
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
2550
2550
|
# HTTP header 'Accept' (if needed)
|
2551
2551
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2552
2552
|
|
@@ -2617,7 +2617,7 @@ module KlaviyoAPI
|
|
2617
2617
|
# header parameters
|
2618
2618
|
header_params = opts[:header_params] || {}
|
2619
2619
|
# klaviyo api revision
|
2620
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2620
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
2621
2621
|
# HTTP header 'Accept' (if needed)
|
2622
2622
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2623
2623
|
|
@@ -2657,7 +2657,7 @@ module KlaviyoAPI
|
|
2657
2657
|
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
|
2658
2658
|
# @param id [String]
|
2659
2659
|
# @param [Hash] opts the optional parameters
|
2660
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-
|
2660
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2661
2661
|
# @return [Hash<String, Object>]
|
2662
2662
|
def get_segments_for_profile(id, opts = {})
|
2663
2663
|
data, _status_code, _headers = get_segments_for_profile_with_http_info(id, opts)
|
@@ -2671,7 +2671,7 @@ module KlaviyoAPI
|
|
2671
2671
|
# Get segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
|
2672
2672
|
# @param id [String]
|
2673
2673
|
# @param [Hash] opts the optional parameters
|
2674
|
-
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-
|
2674
|
+
# @option opts [Array<String>] :fields_segment For more information please visit https://developers.klaviyo.com/en/v2025-07-15/reference/api-overview#sparse-fieldsets
|
2675
2675
|
# @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
|
2676
2676
|
def get_segments_for_profile_with_http_info(id, opts = {})
|
2677
2677
|
if @api_client.config.debugging
|
@@ -2695,7 +2695,7 @@ module KlaviyoAPI
|
|
2695
2695
|
# header parameters
|
2696
2696
|
header_params = opts[:header_params] || {}
|
2697
2697
|
# klaviyo api revision
|
2698
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2698
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
2699
2699
|
# HTTP header 'Accept' (if needed)
|
2700
2700
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2701
2701
|
|
@@ -2766,7 +2766,7 @@ module KlaviyoAPI
|
|
2766
2766
|
# header parameters
|
2767
2767
|
header_params = opts[:header_params] || {}
|
2768
2768
|
# klaviyo api revision
|
2769
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2769
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
2770
2770
|
# HTTP header 'Accept' (if needed)
|
2771
2771
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2772
2772
|
# HTTP header 'Content-Type'
|
@@ -2852,7 +2852,7 @@ module KlaviyoAPI
|
|
2852
2852
|
# header parameters
|
2853
2853
|
header_params = opts[:header_params] || {}
|
2854
2854
|
# klaviyo api revision
|
2855
|
-
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-
|
2855
|
+
header_params['revision'] = ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2025-07-15"
|
2856
2856
|
# HTTP header 'Accept' (if needed)
|
2857
2857
|
header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
|
2858
2858
|
# HTTP header 'Content-Type'
|