Read profiles, events, lists, segments, campaigns and supported marketing resources, and perform the JSON:API mutations described in the pinned stable Klaviyo API contract. Supply a scoped private API key, not a public site identifier.
Example workflows
Copy a prompt into your connected AI client after connecting this integration. Choose resources you can access and review the supported command before running it.
Get Accounts
Help me with this task in Klaviyo: Get Accounts. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.
Explore this command: klaviyo.get_accounts
Get Account
Help me with this task in Klaviyo: Get Account. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.
Explore this command: klaviyo.get_account
What you can do (423)
What you can do
Available commands: 423 (252 read, 171 write). Enable only the commands your application needs.
| Command | Effect |
|---|---|
Get Accounts — klaviyo.get_accounts |
Read |
Get Account — klaviyo.get_account |
Read |
List Billing Usage — klaviyo.list_billing_usage |
Read |
Get Billing Usage — klaviyo.get_billing_usage |
Read |
Get Brand Logos — klaviyo.get_brand_logos |
Read |
Create Brand Logo — klaviyo.create_brand_logo |
Write |
Get Brand Logo — klaviyo.get_brand_logo |
Read |
Update Brand Logo — klaviyo.update_brand_logo |
Write |
Delete Brand Logo — klaviyo.delete_brand_logo |
Write |
Get Brand Buttons — klaviyo.get_brand_buttons |
Read |
Create Brand Button — klaviyo.create_brand_button |
Write |
Get Brand Button — klaviyo.get_brand_button |
Read |
Update Brand Button — klaviyo.update_brand_button |
Write |
Delete Brand Button — klaviyo.delete_brand_button |
Write |
Get Brand Colors — klaviyo.get_brand_colors |
Read |
Create Brand Color — klaviyo.create_brand_color |
Write |
Get Brand Color — klaviyo.get_brand_color |
Read |
Update Brand Color — klaviyo.update_brand_color |
Write |
Delete Brand Color — klaviyo.delete_brand_color |
Write |
Get Brand Voice — klaviyo.get_brand_voice |
Read |
Update Brand Voice — klaviyo.update_brand_voice |
Write |
Get Brand Social Groups — klaviyo.get_brand_social_groups |
Read |
Create Brand Social Group — klaviyo.create_brand_social_group |
Write |
Get Brand Social Group — klaviyo.get_brand_social_group |
Read |
Update Brand Social Group — klaviyo.update_brand_social_group |
Write |
Delete Brand Social Group — klaviyo.delete_brand_social_group |
Write |
Get Brand Email Defaults — klaviyo.get_brand_email_defaults |
Read |
Get Brand Email Default — klaviyo.get_brand_email_default |
Read |
Update Brand Email Default — klaviyo.update_brand_email_default |
Write |
Get Campaigns — klaviyo.get_campaigns |
Read |
Create Campaign — klaviyo.create_campaign |
Write |
Get Campaign — klaviyo.get_campaign |
Read |
Update Campaign — klaviyo.update_campaign |
Write |
Delete Campaign — klaviyo.delete_campaign |
Write |
Get Campaign Messages — klaviyo.get_campaign_messages |
Read |
Create Campaign Message — klaviyo.create_campaign_message |
Write |
Get Campaign Message — klaviyo.get_campaign_message |
Read |
Update Campaign Message — klaviyo.update_campaign_message |
Write |
Delete Campaign Message — klaviyo.delete_campaign_message |
Write |
Get Campaign Send Job — klaviyo.get_campaign_send_job |
Read |
Cancel Campaign Send — klaviyo.cancel_campaign_send |
Write |
Get Campaign Recipient Estimation Job — klaviyo.get_campaign_recipient_estimation_job |
Read |
Get Campaign Recipient Estimation — klaviyo.get_campaign_recipient_estimation |
Read |
Get Campaign Audience — klaviyo.get_campaign_audience |
Read |
Update Campaign Audience — klaviyo.update_campaign_audience |
Write |
Delete Campaign Audience — klaviyo.delete_campaign_audience |
Write |
Get Campaign Variation — klaviyo.get_campaign_variation |
Read |
Update Campaign Variation — klaviyo.update_campaign_variation |
Write |
Delete Campaign Variation — klaviyo.delete_campaign_variation |
Write |
Clone Campaign — klaviyo.clone_campaign |
Write |
Assign Template to Campaign Message — klaviyo.assign_template_to_campaign_message |
Write |
Send Campaign — klaviyo.send_campaign |
Write |
Refresh Campaign Recipient Estimation — klaviyo.refresh_campaign_recipient_estimation |
Write |
Create Campaign Audience — klaviyo.create_campaign_audience |
Write |
Clone Campaign Audience — klaviyo.clone_campaign_audience |
Write |
Clone Campaign Message — klaviyo.clone_campaign_message |
Write |
Create Campaign Variation — klaviyo.create_campaign_variation |
Write |
Schedule Campaign Message — klaviyo.schedule_campaign_message |
Write |
Update Campaign Message Schedule — klaviyo.update_campaign_message_schedule |
Write |
Get Campaign for Campaign Message — klaviyo.get_campaign_for_campaign_message |
Read |
Get Campaign ID for Campaign Message — klaviyo.get_campaign_id_for_campaign_message |
Read |
Get Template for Campaign Message — klaviyo.get_template_for_campaign_message |
Read |
Get Template ID for Campaign Message — klaviyo.get_template_id_for_campaign_message |
Read |
Get Image for Campaign Message — klaviyo.get_image_for_campaign_message |
Read |
Get Image ID for Campaign Message — klaviyo.get_image_id_for_campaign_message |
Read |
Update Image for Campaign Message — klaviyo.update_image_for_campaign_message |
Write |
Get Audience for Campaign Message — klaviyo.get_audience_for_campaign_message |
Read |
Get Audience ID for Campaign Message — klaviyo.get_audience_id_for_campaign_message |
Read |
Get Tags for Campaign — klaviyo.get_tags_for_campaign |
Read |
Get Tag IDs for Campaign — klaviyo.get_tag_ids_for_campaign |
Read |
Get Tags for Campaign Message — klaviyo.get_tags_for_campaign_message |
Read |
Get Tag IDs for Campaign Message — klaviyo.get_tag_ids_for_campaign_message |
Read |
Get Messages for Campaign — klaviyo.get_messages_for_campaign |
Read |
Get Message IDs for Campaign — klaviyo.get_message_ids_for_campaign |
Read |
Get Campaign Audiences for Campaign — klaviyo.get_campaign_audiences_for_campaign |
Read |
Get Audience IDs for Campaign — klaviyo.get_audience_ids_for_campaign |
Read |
Get Campaign for Campaign Audience — klaviyo.get_campaign_for_campaign_audience |
Read |
Get Campaign ID for Campaign Audience — klaviyo.get_campaign_id_for_campaign_audience |
Read |
Get Campaign Messages for Campaign Audience — klaviyo.get_campaign_messages_for_campaign_audience |
Read |
Get Message IDs for Campaign Audience — klaviyo.get_message_ids_for_campaign_audience |
Read |
Get Message for Campaign Variation — klaviyo.get_message_for_campaign_variation |
Read |
Get Message ID for Campaign Variation — klaviyo.get_message_id_for_campaign_variation |
Read |
Get Translation for Campaign Variation — klaviyo.get_translation_for_campaign_variation |
Read |
Get Translation ID for Campaign Variation — klaviyo.get_translation_id_for_campaign_variation |
Read |
Get Image for Campaign Variation — klaviyo.get_image_for_campaign_variation |
Read |
Get Image ID for Campaign Variation — klaviyo.get_image_id_for_campaign_variation |
Read |
Get Variations for Campaign Message — klaviyo.get_variations_for_campaign_message |
Read |
Get Variation IDs for Campaign Message — klaviyo.get_variation_ids_for_campaign_message |
Read |
Get Catalog Items — klaviyo.get_catalog_items |
Read |
Create Catalog Item — klaviyo.create_catalog_item |
Write |
Get Catalog Item — klaviyo.get_catalog_item |
Read |
Update Catalog Item — klaviyo.update_catalog_item |
Write |
Delete Catalog Item — klaviyo.delete_catalog_item |
Write |
Get Catalog Variants — klaviyo.get_catalog_variants |
Read |
Create Catalog Variant — klaviyo.create_catalog_variant |
Write |
Get Catalog Variant — klaviyo.get_catalog_variant |
Read |
Update Catalog Variant — klaviyo.update_catalog_variant |
Write |
Delete Catalog Variant — klaviyo.delete_catalog_variant |
Write |
Get Catalog Categories — klaviyo.get_catalog_categories |
Read |
Create Catalog Category — klaviyo.create_catalog_category |
Write |
Get Catalog Category — klaviyo.get_catalog_category |
Read |
Update Catalog Category — klaviyo.update_catalog_category |
Write |
Delete Catalog Category — klaviyo.delete_catalog_category |
Write |
Get Bulk Create Catalog Items Jobs — klaviyo.get_bulk_create_catalog_items_jobs |
Read |
Bulk Create Catalog Items — klaviyo.bulk_create_catalog_items |
Write |
Get Bulk Create Catalog Items Job — klaviyo.get_bulk_create_catalog_items_job |
Read |
Get Bulk Update Catalog Items Jobs — klaviyo.get_bulk_update_catalog_items_jobs |
Read |
Bulk Update Catalog Items — klaviyo.bulk_update_catalog_items |
Write |
Get Bulk Update Catalog Items Job — klaviyo.get_bulk_update_catalog_items_job |
Read |
Get Bulk Delete Catalog Items Jobs — klaviyo.get_bulk_delete_catalog_items_jobs |
Read |
Bulk Delete Catalog Items — klaviyo.bulk_delete_catalog_items |
Write |
Get Bulk Delete Catalog Items Job — klaviyo.get_bulk_delete_catalog_items_job |
Read |
Get Bulk Create Variants Jobs — klaviyo.get_bulk_create_variants_jobs |
Read |
Bulk Create Catalog Variants — klaviyo.bulk_create_catalog_variants |
Write |
Get Bulk Create Variants Job — klaviyo.get_bulk_create_variants_job |
Read |
Get Bulk Update Variants Jobs — klaviyo.get_bulk_update_variants_jobs |
Read |
Bulk Update Catalog Variants — klaviyo.bulk_update_catalog_variants |
Write |
Get Bulk Update Variants Job — klaviyo.get_bulk_update_variants_job |
Read |
Get Bulk Delete Variants Jobs — klaviyo.get_bulk_delete_variants_jobs |
Read |
Bulk Delete Catalog Variants — klaviyo.bulk_delete_catalog_variants |
Write |
Get Bulk Delete Variants Job — klaviyo.get_bulk_delete_variants_job |
Read |
Get Bulk Create Categories Jobs — klaviyo.get_bulk_create_categories_jobs |
Read |
Bulk Create Catalog Categories — klaviyo.bulk_create_catalog_categories |
Write |
Get Bulk Create Categories Job — klaviyo.get_bulk_create_categories_job |
Read |
Get Bulk Update Categories Jobs — klaviyo.get_bulk_update_categories_jobs |
Read |
Bulk Update Catalog Categories — klaviyo.bulk_update_catalog_categories |
Write |
Get Bulk Update Categories Job — klaviyo.get_bulk_update_categories_job |
Read |
Get Bulk Delete Categories Jobs — klaviyo.get_bulk_delete_categories_jobs |
Read |
Bulk Delete Catalog Categories — klaviyo.bulk_delete_catalog_categories |
Write |
Get Bulk Delete Categories Job — klaviyo.get_bulk_delete_categories_job |
Read |
Create Back In Stock Subscription — klaviyo.create_back_in_stock_subscription |
Write |
Get Items for Catalog Category — klaviyo.get_items_for_catalog_category |
Read |
Get Item IDs for Catalog Category — klaviyo.get_item_ids_for_catalog_category |
Read |
Add Items to Catalog Category — klaviyo.add_items_to_catalog_category |
Write |
Update Items for Catalog Category — klaviyo.update_items_for_catalog_category |
Write |
Remove Items from Catalog Category — klaviyo.remove_items_from_catalog_category |
Write |
Get Variants for Catalog Item — klaviyo.get_variants_for_catalog_item |
Read |
Get Variant IDs for Catalog Item — klaviyo.get_variant_ids_for_catalog_item |
Read |
Get Categories for Catalog Item — klaviyo.get_categories_for_catalog_item |
Read |
Get Category IDs for Catalog Item — klaviyo.get_category_ids_for_catalog_item |
Read |
Add Categories to Catalog Item — klaviyo.add_categories_to_catalog_item |
Write |
Update Categories for Catalog Item — klaviyo.update_categories_for_catalog_item |
Write |
Remove Categories from Catalog Item — klaviyo.remove_categories_from_catalog_item |
Write |
Create Conversation Message — klaviyo.create_conversation_message |
Write |
Get Coupons — klaviyo.get_coupons |
Read |
Create Coupon — klaviyo.create_coupon |
Write |
Get Coupon — klaviyo.get_coupon |
Read |
Update Coupon — klaviyo.update_coupon |
Write |
Delete Coupon — klaviyo.delete_coupon |
Write |
Get Coupon Codes — klaviyo.get_coupon_codes |
Read |
Create Coupon Code — klaviyo.create_coupon_code |
Write |
Get Coupon Code — klaviyo.get_coupon_code |
Read |
Update Coupon Code — klaviyo.update_coupon_code |
Write |
Delete Coupon Code — klaviyo.delete_coupon_code |
Write |
Get Bulk Create Coupon Code Jobs — klaviyo.get_bulk_create_coupon_code_jobs |
Read |
Bulk Create Coupon Codes — klaviyo.bulk_create_coupon_codes |
Write |
Get Bulk Create Coupon Codes Job — klaviyo.get_bulk_create_coupon_codes_job |
Read |
Get Coupon For Coupon Code — klaviyo.get_coupon_for_coupon_code |
Read |
Get Coupon ID for Coupon Code — klaviyo.get_coupon_id_for_coupon_code |
Read |
Get Coupon Codes for Coupon — klaviyo.get_coupon_codes_for_coupon |
Read |
Get Coupon Code IDs for Coupon — klaviyo.get_coupon_code_ids_for_coupon |
Read |
Get Data Sources — klaviyo.get_data_sources |
Read |
Create Data Source — klaviyo.create_data_source |
Write |
Get Data Source — klaviyo.get_data_source |
Read |
Delete Data Source — klaviyo.delete_data_source |
Write |
Get Source Mapping — klaviyo.get_source_mapping |
Read |
Update Source Mapping — klaviyo.update_source_mapping |
Write |
Get Object Types — klaviyo.get_object_types |
Read |
Create Object Type — klaviyo.create_object_type |
Write |
Get Object Type — klaviyo.get_object_type |
Read |
Delete Object Type — klaviyo.delete_object_type |
Write |
Get Object Schema — klaviyo.get_object_schema |
Read |
Update Object Schema — klaviyo.update_object_schema |
Write |
Get Object Record — klaviyo.get_object_record |
Read |
Bulk Create Data Source Records — klaviyo.bulk_create_data_source_records |
Write |
Create Data Source Record — klaviyo.create_data_source_record |
Write |
Create Object Schema — klaviyo.create_object_schema |
Write |
Bulk Delete Object Records — klaviyo.bulk_delete_object_records |
Write |
Get Records for Object Type — klaviyo.get_records_for_object_type |
Read |
Get Record IDs for Object Type — klaviyo.get_record_ids_for_object_type |
Read |
Get Ingestion Logs for Object Type — klaviyo.get_ingestion_logs_for_object_type |
Read |
Get Ingestion Log IDs for Object Type — klaviyo.get_ingestion_log_ids_for_object_type |
Read |
Get Current Schema for Object Type — klaviyo.get_current_schema_for_object_type |
Read |
Get Current Schema ID for Object Type — klaviyo.get_current_schema_id_for_object_type |
Read |
Get Draft Schema for Object Type — klaviyo.get_draft_schema_for_object_type |
Read |
Get Draft Schema ID for Object Type — klaviyo.get_draft_schema_id_for_object_type |
Read |
Get Schema Versions for Object Type — klaviyo.get_schema_versions_for_object_type |
Read |
Get Schema Version IDs for Object Type — klaviyo.get_schema_version_ids_for_object_type |
Read |
Get Object Type Relationships — klaviyo.get_object_type_relationships |
Read |
Get Profile Type Relationships — klaviyo.get_profile_type_relationships |
Read |
Get Source Mapping for Object Schema — klaviyo.get_source_mapping_for_object_schema |
Read |
Get Source Mapping ID for Object Schema — klaviyo.get_source_mapping_id_for_object_schema |
Read |
Get Object Schema Relationships — klaviyo.get_object_schema_relationships |
Read |
Create Object Schema Relationship — klaviyo.create_object_schema_relationship |
Write |
Update Object Schema Relationship — klaviyo.update_object_schema_relationship |
Write |
Delete Object Schema Relationship — klaviyo.delete_object_schema_relationship |
Write |
Get Profile Schema Relationships — klaviyo.get_profile_schema_relationships |
Read |
Create Profile Schema Relationship — klaviyo.create_profile_schema_relationship |
Write |
Update Profile Schema Relationship — klaviyo.update_profile_schema_relationship |
Write |
Delete Profile Schema Relationship — klaviyo.delete_profile_schema_relationship |
Write |
Request Profile Deletion — klaviyo.request_profile_deletion |
Write |
Get Events — klaviyo.get_events |
Read |
Create Event — klaviyo.create_event |
Write |
Get Event — klaviyo.get_event |
Read |
Bulk Create Events — klaviyo.bulk_create_events |
Write |
Get Metric for Event — klaviyo.get_metric_for_event |
Read |
Get Metric ID for Event — klaviyo.get_metric_id_for_event |
Read |
Get Profile for Event — klaviyo.get_profile_for_event |
Read |
Get Profile ID for Event — klaviyo.get_profile_id_for_event |
Read |
Get Flows — klaviyo.get_flows |
Read |
Create Flow — klaviyo.create_flow |
Write |
Get Flow — klaviyo.get_flow |
Read |
Update Flow Status — klaviyo.update_flow |
Write |
Delete Flow — klaviyo.delete_flow |
Write |
Get Flow Action — klaviyo.get_flow_action |
Read |
Update Flow Action — klaviyo.update_flow_action |
Write |
Delete Flow Action — klaviyo.delete_flow_action |
Write |
Get Flow Message — klaviyo.get_flow_message |
Read |
Create Flow Action — klaviyo.create_flow_action |
Write |
Get Actions for Flow — klaviyo.get_actions_for_flow |
Read |
Get Action IDs for Flow — klaviyo.get_action_ids_for_flow |
Read |
Get Tags for Flow — klaviyo.get_tags_for_flow |
Read |
Get Tag IDs for Flow — klaviyo.get_tag_ids_for_flow |
Read |
Get Flow for Flow Action — klaviyo.get_flow_for_flow_action |
Read |
Get Flow ID for Flow Action — klaviyo.get_flow_id_for_flow_action |
Read |
Get Messages For Flow Action — klaviyo.get_flow_action_messages |
Read |
Get Message IDs for Flow Action — klaviyo.get_message_ids_for_flow_action |
Read |
Get Action for Flow Message — klaviyo.get_action_for_flow_message |
Read |
Get Action ID for Flow Message — klaviyo.get_action_id_for_flow_message |
Read |
Get Template for Flow Message — klaviyo.get_template_for_flow_message |
Read |
Get Template ID for Flow Message — klaviyo.get_template_id_for_flow_message |
Read |
Get Forms — klaviyo.get_forms |
Read |
Create Form — klaviyo.create_form |
Write |
Get Form — klaviyo.get_form |
Read |
Update Form — klaviyo.update_form |
Write |
Delete Form — klaviyo.delete_form |
Write |
Get Form Version — klaviyo.get_form_version |
Read |
Publish Form — klaviyo.publish_form |
Write |
Unpublish Form — klaviyo.unpublish_form |
Write |
Get Versions for Form — klaviyo.get_versions_for_form |
Read |
Get Version IDs for Form — klaviyo.get_version_ids_for_form |
Read |
Get Form for Form Version — klaviyo.get_form_for_form_version |
Read |
Get Form ID for Form Version — klaviyo.get_form_id_for_form_version |
Read |
Get Images — klaviyo.get_images |
Read |
Upload Image From URL — klaviyo.upload_image_from_url |
Write |
Get Image — klaviyo.get_image |
Read |
Update Image — klaviyo.update_image |
Write |
Get Lists — klaviyo.get_lists |
Read |
Create List — klaviyo.create_list |
Write |
Get List — klaviyo.get_list |
Read |
Update List — klaviyo.update_list |
Write |
Delete List — klaviyo.delete_list |
Write |
Get Tags for List — klaviyo.get_tags_for_list |
Read |
Get Tag IDs for List — klaviyo.get_tag_ids_for_list |
Read |
Get Profiles for List — klaviyo.get_profiles_for_list |
Read |
Get Profile IDs for List — klaviyo.get_profile_ids_for_list |
Read |
Add Profiles to List — klaviyo.add_profiles_to_list |
Write |
Remove Profiles from List — klaviyo.remove_profiles_from_list |
Write |
Get Flows Triggered by List — klaviyo.get_flows_triggered_by_list |
Read |
Get IDs for Flows Triggered by List — klaviyo.get_ids_for_flows_triggered_by_list |
Read |
Get Metrics — klaviyo.get_metrics |
Read |
Get Metric — klaviyo.get_metric |
Read |
Get Metric Property — klaviyo.get_metric_property |
Read |
Get Custom Metrics — klaviyo.get_custom_metrics |
Read |
Create Custom Metric — klaviyo.create_custom_metric |
Write |
Get Custom Metric — klaviyo.get_custom_metric |
Read |
Update Custom Metric — klaviyo.update_custom_metric |
Write |
Delete Custom Metric — klaviyo.delete_custom_metric |
Write |
Get Mapped Metrics — klaviyo.get_mapped_metrics |
Read |
Get Mapped Metric — klaviyo.get_mapped_metric |
Read |
Update Mapped Metric — klaviyo.update_mapped_metric |
Write |
Query Metric Aggregates — klaviyo.query_metric_aggregates |
Write |
Get Flows Triggered by Metric — klaviyo.get_flows_triggered_by_metric |
Read |
Get IDs for Flows Triggered by Metric — klaviyo.get_ids_for_flows_triggered_by_metric |
Read |
Get Properties for Metric — klaviyo.get_properties_for_metric |
Read |
Get Property IDs for Metric — klaviyo.get_property_ids_for_metric |
Read |
Get Metric for Metric Property — klaviyo.get_metric_for_metric_property |
Read |
Get Metric ID for Metric Property — klaviyo.get_metric_id_for_metric_property |
Read |
Get Metrics for Custom Metric — klaviyo.get_metrics_for_custom_metric |
Read |
Get Metric IDs for Custom Metric — klaviyo.get_metric_ids_for_custom_metric |
Read |
Get Metric for Mapped Metric — klaviyo.get_metric_for_mapped_metric |
Read |
Get Metric ID for Mapped Metric — klaviyo.get_metric_id_for_mapped_metric |
Read |
Get Custom Metric for Mapped Metric — klaviyo.get_custom_metric_for_mapped_metric |
Read |
Get Custom Metric ID for Mapped Metric — klaviyo.get_custom_metric_id_for_mapped_metric |
Read |
Get Profiles — klaviyo.get_profiles |
Read |
Create Profile — klaviyo.create_profile |
Write |
Get Profile — klaviyo.get_profile |
Read |
Update Profile — klaviyo.update_profile |
Write |
Get Bulk Import Profiles Jobs — klaviyo.get_bulk_import_profiles_jobs |
Read |
Bulk Import Profiles — klaviyo.bulk_import_profiles |
Write |
Get Bulk Import Profiles Job — klaviyo.get_bulk_import_profiles_job |
Read |
Get Bulk Suppress Profiles Jobs — klaviyo.get_bulk_suppress_profiles_jobs |
Read |
Bulk Suppress Profiles — klaviyo.bulk_suppress_profiles |
Write |
Get Bulk Suppress Profiles Job — klaviyo.get_bulk_suppress_profiles_job |
Read |
Get Bulk Unsuppress Profiles Jobs — klaviyo.get_bulk_unsuppress_profiles_jobs |
Read |
Bulk Unsuppress Profiles — klaviyo.bulk_unsuppress_profiles |
Write |
Get Bulk Unsuppress Profiles Job — klaviyo.get_bulk_unsuppress_profiles_job |
Read |
Get Push Tokens — klaviyo.get_push_tokens |
Read |
Create or Update Push Token — klaviyo.create_push_token |
Write |
Get Push Token — klaviyo.get_push_token |
Read |
Delete Push Token — klaviyo.delete_push_token |
Write |
Create or Update Profile — klaviyo.create_or_update_profile |
Write |
Merge Profiles — klaviyo.merge_profiles |
Write |
Bulk Subscribe Profiles — klaviyo.bulk_subscribe_profiles |
Write |
Bulk Unsubscribe Profiles — klaviyo.bulk_unsubscribe_profiles |
Write |
Get Push Tokens for Profile — klaviyo.get_push_tokens_for_profile |
Read |
Get Push Token IDs for Profile — klaviyo.get_push_token_ids_for_profile |
Read |
Get Lists for Profile — klaviyo.get_lists_for_profile |
Read |
Get List IDs for Profile — klaviyo.get_list_ids_for_profile |
Read |
Get Segments for Profile — klaviyo.get_segments_for_profile |
Read |
Get Segment IDs for Profile — klaviyo.get_segment_ids_for_profile |
Read |
Get Conversation for Profile — klaviyo.get_conversation_for_profile |
Read |
Get Conversation ID for Profile — klaviyo.get_conversation_id_for_profile |
Read |
Get Conversations for Profile — klaviyo.get_conversations_for_profile |
Read |
Get Conversation IDs for Profile — klaviyo.get_conversation_ids_for_profile |
Read |
Get List for Bulk Import Profiles Job — klaviyo.get_list_for_bulk_import_profiles_job |
Read |
Get List IDs for Bulk Import Profiles Job — klaviyo.get_list_ids_for_bulk_import_profiles_job |
Read |
Get Profiles for Bulk Import Profiles Job — klaviyo.get_profiles_for_bulk_import_profiles_job |
Read |
Get Profile IDs for Bulk Import Profiles Job — klaviyo.get_profile_ids_for_bulk_import_profiles_job |
Read |
Get Errors for Bulk Import Profiles Job — klaviyo.get_errors_for_bulk_import_profiles_job |
Read |
Get Profile for Push Token — klaviyo.get_profile_for_push_token |
Read |
Get Profile ID for Push Token — klaviyo.get_profile_id_for_push_token |
Read |
Query Campaign Values — klaviyo.query_campaign_values |
Write |
Query Flow Values — klaviyo.query_flow_values |
Write |
Query Flow Series — klaviyo.query_flow_series |
Write |
Query Form Values — klaviyo.query_form_values |
Write |
Query Form Series — klaviyo.query_form_series |
Write |
Query Segment Values — klaviyo.query_segment_values |
Write |
Query Segment Series — klaviyo.query_segment_series |
Write |
Get Reviews — klaviyo.get_reviews |
Read |
Get Review — klaviyo.get_review |
Read |
Update Review — klaviyo.update_review |
Write |
Get Segments — klaviyo.get_segments |
Read |
Create Segment — klaviyo.create_segment |
Write |
Get Segment — klaviyo.get_segment |
Read |
Update Segment — klaviyo.update_segment |
Write |
Delete Segment — klaviyo.delete_segment |
Write |
Get Tags for Segment — klaviyo.get_tags_for_segment |
Read |
Get Tag IDs for Segment — klaviyo.get_tag_ids_for_segment |
Read |
Get Profiles for Segment — klaviyo.get_profiles_for_segment |
Read |
Get Profile IDs for Segment — klaviyo.get_profile_ids_for_segment |
Read |
Get Flows Triggered by Segment — klaviyo.get_flows_triggered_by_segment |
Read |
Get IDs for Flows Triggered by Segment — klaviyo.get_ids_for_flows_triggered_by_segment |
Read |
Get Tags — klaviyo.get_tags |
Read |
Create Tag — klaviyo.create_tag |
Write |
Get Tag — klaviyo.get_tag |
Read |
Update Tag — klaviyo.update_tag |
Write |
Delete Tag — klaviyo.delete_tag |
Write |
Get Tag Groups — klaviyo.get_tag_groups |
Read |
Create Tag Group — klaviyo.create_tag_group |
Write |
Get Tag Group — klaviyo.get_tag_group |
Read |
Update Tag Group — klaviyo.update_tag_group |
Write |
Delete Tag Group — klaviyo.delete_tag_group |
Write |
Get Flow IDs for Tag — klaviyo.get_flow_ids_for_tag |
Read |
Tag Flows — klaviyo.tag_flows |
Write |
Remove Tag from Flows — klaviyo.remove_tag_from_flows |
Write |
Get Campaign IDs for Tag — klaviyo.get_campaign_ids_for_tag |
Read |
Tag Campaigns — klaviyo.tag_campaigns |
Write |
Remove Tag from Campaigns — klaviyo.remove_tag_from_campaigns |
Write |
Get List IDs for Tag — klaviyo.get_list_ids_for_tag |
Read |
Tag Lists — klaviyo.tag_lists |
Write |
Remove Tag from Lists — klaviyo.remove_tag_from_lists |
Write |
Get Segment IDs for Tag — klaviyo.get_segment_ids_for_tag |
Read |
Tag Segments — klaviyo.tag_segments |
Write |
Remove Tag from Segments — klaviyo.remove_tag_from_segments |
Write |
Get Tag Group for Tag — klaviyo.get_tag_group_for_tag |
Read |
Get Tag Group ID for Tag — klaviyo.get_tag_group_id_for_tag |
Read |
Get Tags for Tag Group — klaviyo.get_tags_for_tag_group |
Read |
Get Tag IDs for Tag Group — klaviyo.get_tag_ids_for_tag_group |
Read |
Get Templates — klaviyo.get_templates |
Read |
Create Template — klaviyo.create_template |
Write |
Get Template — klaviyo.get_template |
Read |
Update Template — klaviyo.update_template |
Write |
Delete Template — klaviyo.delete_template |
Write |
Get All Universal Content — klaviyo.get_all_universal_content |
Read |
Create Universal Content — klaviyo.create_universal_content |
Write |
Get Universal Content — klaviyo.get_universal_content |
Read |
Update Universal Content — klaviyo.update_universal_content |
Write |
Delete Universal Content — klaviyo.delete_universal_content |
Write |
Get Template Conversion Jobs — klaviyo.get_template_conversion_jobs |
Read |
Create Template Conversion Job — klaviyo.create_template_conversion_job |
Write |
Get Template Conversion Job — klaviyo.get_template_conversion_job |
Read |
Render Template — klaviyo.render_template |
Write |
Clone Template — klaviyo.clone_template |
Write |
Create Template Preview Send Job — klaviyo.create_template_preview_send_job |
Write |
Clone Universal Content — klaviyo.clone_universal_content |
Write |
Get Text Messaging Configuration — klaviyo.get_text_messaging_configuration |
Read |
Get Text Messaging Senders — klaviyo.get_text_messaging_senders |
Read |
Create Text Messaging Sender — klaviyo.create_text_messaging_sender |
Write |
Get Text Messaging Sender — klaviyo.get_text_messaging_sender |
Read |
Get Text Messaging Sender Registration — klaviyo.get_text_messaging_sender_registration |
Read |
Create Text Messaging Configuration — klaviyo.create_text_messaging_configuration |
Write |
Create Text Messaging Sender Registration — klaviyo.create_text_messaging_sender_registration |
Write |
Get Messaging Sender Registration for Text Messaging Sender — klaviyo.get_messaging_sender_registration_for_text_messaging_sender |
Read |
Get Messaging Sender Registration ID for Text Messaging Sender — klaviyo.get_messaging_sender_registration_id_for_text_messaging_sender |
Read |
Get Tracking Settings — klaviyo.get_tracking_settings |
Read |
Get Tracking Setting — klaviyo.get_tracking_setting |
Read |
Update Tracking Setting — klaviyo.update_tracking_setting |
Write |
Get Translations — klaviyo.get_translations |
Read |
Create Translation — klaviyo.create_translation |
Write |
Get Translation — klaviyo.get_translation |
Read |
Update Translation — klaviyo.update_translation |
Write |
Delete Translation — klaviyo.delete_translation |
Write |
Get Campaign Variation for Translation — klaviyo.get_campaign_variation_for_translation |
Read |
Get Campaign Variation ID for Translation — klaviyo.get_campaign_variation_id_for_translation |
Read |
Get Flow Message for Translation — klaviyo.get_flow_message_for_translation |
Read |
Get Flow Message ID for Translation — klaviyo.get_flow_message_id_for_translation |
Read |
Get Template for Translation — klaviyo.get_template_for_translation |
Read |
Get Template ID for Translation — klaviyo.get_template_id_for_translation |
Read |
Get Template Universal Content for Translation — klaviyo.get_template_universal_content_for_translation |
Read |
Get Template Universal Content ID for Translation — klaviyo.get_template_universal_content_id_for_translation |
Read |
Get Web Feeds — klaviyo.get_web_feeds |
Read |
Create Web Feed — klaviyo.create_web_feed |
Write |
Get Web Feed — klaviyo.get_web_feed |
Read |
Update Web Feed — klaviyo.update_web_feed |
Write |
Delete Web Feed — klaviyo.delete_web_feed |
Write |
Get Webhooks — klaviyo.get_webhooks |
Read |
Create Webhook — klaviyo.create_webhook |
Write |
Get Webhook — klaviyo.get_webhook |
Read |
Update Webhook — klaviyo.update_webhook |
Write |
Delete Webhook — klaviyo.delete_webhook |
Write |
Get Webhook Topics — klaviyo.get_webhook_topics |
Read |
Get Webhook Topic — klaviyo.get_webhook_topic |
Read |
Connect and use
This connection uses your provider account.
Connect this integration, enter your provider credentials, choose commands and save. Complete provider authorization if prompted.
Get your provider credentials
Follow these steps for Klaviyo, then enter the issued values in the connection form below.
- In Klaviyo, open Settings → Account → API Keys and create a private API key. Grant only needed read/write scopes; a public site ID cannot replace this key. Paste it into this connection’s Klaviyo private API key field. Save selected commands and use the displayed JSON:API data/type/attributes envelope. This pinned contract uses revision 2026-10-15 only; client-only public-key endpoints are excluded. Profiles, consent, events and campaign writes can change customer data or trigger delivery. Create a separate scoped Tooluse.net API key for your AI client and never expose the private Klaviyo key in its URL.
Where to enter credentials
In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.
| Connection field | Requirement |
|---|---|
| Klaviyo private API key | Required |
Open API keys and create a Tooluse.net key for the enabled commands.
Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.
Configure Claude Code, Codex or Cursor once
Permissions and results
If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.
Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.
Call from your client
Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.
Configure Claude Code, Codex or Cursor once
Discover your enabled tools
List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.
curl 'https://api.tooluse.net/v1/tools' \
-H "Authorization: Bearer $TOOLUSE_API_KEY"
Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.
HTTP call
curl 'https://api.tooluse.net/v1/tool-calls' \
-H "Authorization: Bearer $TOOLUSE_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: replace-with-a-new-call-id' \
--data '{
"type": "tool_use",
"id": "toolu_example",
"name": "svc_FROM_YOUR_TOOL_LIST",
"input": {
"headers": {
"revision": "2026-10-15"
}
}
}'
Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.
Commands
Get Accounts — klaviyo.get_accounts
Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[account] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[account][] |
string | Optional | enum: ["contact_information","contact_information.default_sender_email","contact_information.default_sender_name","contact_information.organization_name","contact_information.street_address","contact_information.street_address.address1","contact_information.street_address.address2","contact_information.street_address.city","contact_information.street_address.country","contact_information.street_address.region","contact_information.street_address.zip","contact_information.website_url","id","industry","locale","preferred_currency","public_api_key","test_account","timezone"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Account — klaviyo.get_account
Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated. Rate limits: Burst: 1/s Steady: 15/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the account | |
query |
object | Optional | additionalProperties: false |
|
query.fields[account] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[account][] |
string | Optional | enum: ["contact_information","contact_information.default_sender_email","contact_information.default_sender_name","contact_information.organization_name","contact_information.street_address","contact_information.street_address.address1","contact_information.street_address.address2","contact_information.street_address.city","contact_information.street_address.country","contact_information.street_address.region","contact_information.street_address.zip","contact_information.website_url","id","industry","locale","preferred_currency","public_api_key","test_account","timezone"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "AbC123"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
List Billing Usage — klaviyo.list_billing_usage
List current-period usage and plan caps for the account. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[billing-usage] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[billing-usage][] |
string | Optional | enum: ["as_of","id","period_end","period_start","unit","usage_max","usage_used"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any (string) |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Billing Usage — klaviyo.get_billing_usage
Get current-period usage and plan cap for a single usage type. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The usage type to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[billing-usage] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[billing-usage][] |
string | Optional | enum: ["as_of","id","period_end","period_start","unit","usage_max","usage_used"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "email_sends"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Brand Logos — klaviyo.get_brand_logos
Get all brand logos for the authenticated account. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-logo] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-logo][] |
string | Optional | enum: ["alt_text","height","id","link_url","name","width"] |
|
query.fields[image] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[image][] |
string | Optional | enum: ["format","hidden","id","image_url","name","size","updated_at"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["image"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Brand Logo — klaviyo.create_brand_logo
Create a new brand logo. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-logo] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-logo][] |
string | Optional | enum: ["alt_text","height","id","link_url","name","width"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/BrandLogoCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "brand-logo",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Brand Logo — klaviyo.get_brand_logo
Get the brand logo with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the brand logo. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-logo] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-logo][] |
string | Optional | enum: ["alt_text","height","id","link_url","name","width"] |
|
query.fields[image] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[image][] |
string | Optional | enum: ["format","hidden","id","image_url","name","size","updated_at"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["image"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "42"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Brand Logo — klaviyo.update_brand_logo
Update the brand logo with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the brand logo. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-logo] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-logo][] |
string | Optional | enum: ["alt_text","height","id","link_url","name","width"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/BrandLogoPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "42"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "brand-logo",
"id": "42",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Brand Logo — klaviyo.delete_brand_logo
Delete the brand logo with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the brand logo. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "42"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Brand Colors — klaviyo.get_brand_colors
Get all brand color groups for the authenticated account. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-color] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-color][] |
string | Optional | enum: ["colors","id","name"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Brand Color — klaviyo.create_brand_color
Create a new brand color group. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-color] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-color][] |
string | Optional | enum: ["colors","id","name"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/BrandColorCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "brand-color",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Brand Color — klaviyo.get_brand_color
Get the brand color group with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the brand color group. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-color] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-color][] |
string | Optional | enum: ["colors","id","name"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "42"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Brand Color — klaviyo.update_brand_color
Update the brand color group with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the brand color group. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-color] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-color][] |
string | Optional | enum: ["colors","id","name"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/BrandColorPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "42"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "brand-color",
"id": "42",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Brand Color — klaviyo.delete_brand_color
Delete the brand color group with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the brand color group. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "42"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Brand Voice — klaviyo.get_brand_voice
Get the brand voice for the authenticated company. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The company ID. Must match the authenticated account. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-voice] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-voice][] |
string | Optional | enum: ["id","language_patterns","tone_descriptors","version"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "abc123"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Brand Voice — klaviyo.update_brand_voice
Update the brand voice for the authenticated company. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The company ID. Must match the authenticated account. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-voice] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-voice][] |
string | Optional | enum: ["id","language_patterns","tone_descriptors","version"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/BrandVoicePartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "abc123"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "brand-voice",
"id": "abc123",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Brand Email Defaults — klaviyo.get_brand_email_defaults
List the brand email defaults for the authenticated account. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-button] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-button][] |
string | Optional | enum: ["border","border.border_color","border.border_style","border.border_width","border.is_border_active","id","is_primary","name","preview_page_hex","spacing","spacing.padding_bottom","spacing.padding_left","spacing.padding_right","spacing.padding_top","style","style.background_color","style.border_radius","style.box_shadow","style.is_shadow_active","text","text.color","text.font_family","text.font_size","text.font_style","text.font_weight","text.letter_spacing","text.text_decoration"] |
|
query.fields[brand-email-default] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-email-default][] |
string | Optional | enum: ["body","body.background_color","body.body_background_color","body.h1_text","body.h1_text.color","body.h1_text.font_family","body.h1_text.font_size","body.h1_text.font_style","body.h1_text.font_weight","body.h1_text.letter_spacing","body.h1_text.text_decoration","body.h2_text","body.h2_text.color","body.h2_text.font_family","body.h2_text.font_size","body.h2_text.font_style","body.h2_text.font_weight","body.h2_text.letter_spacing","body.h2_text.text_decoration","body.h3_text","body.h3_text.color","body.h3_text.font_family","body.h3_text.font_size","body.h3_text.font_style","body.h3_text.font_weight","body.h3_text.letter_spacing","body.h3_text.text_decoration","body.h4_text","body.h4_text.color","body.h4_text.font_family","body.h4_text.font_size","body.h4_text.font_style","body.h4_text.font_weight","body.h4_text.letter_spacing","body.h4_text.text_decoration","body.link_text","body.link_text.color","body.link_text.font_family","body.link_text.font_size","body.link_text.font_style","body.link_text.font_weight","body.link_text.letter_spacing","body.link_text.text_decoration","body.text","body.text.color","body.text.font_family","body.text.font_size","body.text.font_style","body.text.font_weight","body.text.letter_spacing","body.text.text_decoration","footer","footer.background_color","footer.link_text","footer.link_text.color","footer.link_text.font_family","footer.link_text.font_size","footer.link_text.font_style","footer.link_text.font_weight","footer.link_text.letter_spacing","footer.link_text.text_decoration","footer.social_group_color","footer.text","footer.text.color","footer.text.font_family","footer.text.font_size","footer.text.font_style","footer.text.font_weight","footer.text.letter_spacing","footer.text.text_decoration","header","header.background_color","header.link_text","header.link_text.color","header.link_text.font_family","header.link_text.font_size","header.link_text.font_style","header.link_text.font_weight","header.link_text.letter_spacing","header.link_text.text_decoration","header.links","header.logo_max_width","id"] |
|
query.fields[brand-logo] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-logo][] |
string | Optional | enum: ["alt_text","height","id","link_url","name","width"] |
|
query.fields[brand-social-group] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-social-group][] |
string | Optional | enum: ["id","name","social_links"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["brand-button","brand-logo","brand-social-group"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Brand Email Default — klaviyo.get_brand_email_default
Get the brand email defaults for the authenticated account. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the brand email defaults (must equal the account ID). | |
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-button] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-button][] |
string | Optional | enum: ["border","border.border_color","border.border_style","border.border_width","border.is_border_active","id","is_primary","name","preview_page_hex","spacing","spacing.padding_bottom","spacing.padding_left","spacing.padding_right","spacing.padding_top","style","style.background_color","style.border_radius","style.box_shadow","style.is_shadow_active","text","text.color","text.font_family","text.font_size","text.font_style","text.font_weight","text.letter_spacing","text.text_decoration"] |
|
query.fields[brand-email-default] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-email-default][] |
string | Optional | enum: ["body","body.background_color","body.body_background_color","body.h1_text","body.h1_text.color","body.h1_text.font_family","body.h1_text.font_size","body.h1_text.font_style","body.h1_text.font_weight","body.h1_text.letter_spacing","body.h1_text.text_decoration","body.h2_text","body.h2_text.color","body.h2_text.font_family","body.h2_text.font_size","body.h2_text.font_style","body.h2_text.font_weight","body.h2_text.letter_spacing","body.h2_text.text_decoration","body.h3_text","body.h3_text.color","body.h3_text.font_family","body.h3_text.font_size","body.h3_text.font_style","body.h3_text.font_weight","body.h3_text.letter_spacing","body.h3_text.text_decoration","body.h4_text","body.h4_text.color","body.h4_text.font_family","body.h4_text.font_size","body.h4_text.font_style","body.h4_text.font_weight","body.h4_text.letter_spacing","body.h4_text.text_decoration","body.link_text","body.link_text.color","body.link_text.font_family","body.link_text.font_size","body.link_text.font_style","body.link_text.font_weight","body.link_text.letter_spacing","body.link_text.text_decoration","body.text","body.text.color","body.text.font_family","body.text.font_size","body.text.font_style","body.text.font_weight","body.text.letter_spacing","body.text.text_decoration","footer","footer.background_color","footer.link_text","footer.link_text.color","footer.link_text.font_family","footer.link_text.font_size","footer.link_text.font_style","footer.link_text.font_weight","footer.link_text.letter_spacing","footer.link_text.text_decoration","footer.social_group_color","footer.text","footer.text.color","footer.text.font_family","footer.text.font_size","footer.text.font_style","footer.text.font_weight","footer.text.letter_spacing","footer.text.text_decoration","header","header.background_color","header.link_text","header.link_text.color","header.link_text.font_family","header.link_text.font_size","header.link_text.font_style","header.link_text.font_weight","header.link_text.letter_spacing","header.link_text.text_decoration","header.links","header.logo_max_width","id"] |
|
query.fields[brand-logo] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-logo][] |
string | Optional | enum: ["alt_text","height","id","link_url","name","width"] |
|
query.fields[brand-social-group] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-social-group][] |
string | Optional | enum: ["id","name","social_links"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["brand-button","brand-logo","brand-social-group"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "abc123"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Brand Email Default — klaviyo.update_brand_email_default
Partial update of the brand email defaults for the authenticated account. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the brand email defaults (must equal the account ID). | |
query |
object | Optional | additionalProperties: false |
|
query.fields[brand-email-default] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[brand-email-default][] |
string | Optional | enum: ["body","body.background_color","body.body_background_color","body.h1_text","body.h1_text.color","body.h1_text.font_family","body.h1_text.font_size","body.h1_text.font_style","body.h1_text.font_weight","body.h1_text.letter_spacing","body.h1_text.text_decoration","body.h2_text","body.h2_text.color","body.h2_text.font_family","body.h2_text.font_size","body.h2_text.font_style","body.h2_text.font_weight","body.h2_text.letter_spacing","body.h2_text.text_decoration","body.h3_text","body.h3_text.color","body.h3_text.font_family","body.h3_text.font_size","body.h3_text.font_style","body.h3_text.font_weight","body.h3_text.letter_spacing","body.h3_text.text_decoration","body.h4_text","body.h4_text.color","body.h4_text.font_family","body.h4_text.font_size","body.h4_text.font_style","body.h4_text.font_weight","body.h4_text.letter_spacing","body.h4_text.text_decoration","body.link_text","body.link_text.color","body.link_text.font_family","body.link_text.font_size","body.link_text.font_style","body.link_text.font_weight","body.link_text.letter_spacing","body.link_text.text_decoration","body.text","body.text.color","body.text.font_family","body.text.font_size","body.text.font_style","body.text.font_weight","body.text.letter_spacing","body.text.text_decoration","footer","footer.background_color","footer.link_text","footer.link_text.color","footer.link_text.font_family","footer.link_text.font_size","footer.link_text.font_style","footer.link_text.font_weight","footer.link_text.letter_spacing","footer.link_text.text_decoration","footer.social_group_color","footer.text","footer.text.color","footer.text.font_family","footer.text.font_size","footer.text.font_style","footer.text.font_weight","footer.text.letter_spacing","footer.text.text_decoration","header","header.background_color","header.link_text","header.link_text.color","header.link_text.font_family","header.link_text.font_size","header.link_text.font_style","header.link_text.font_weight","header.link_text.letter_spacing","header.link_text.text_decoration","header.links","header.logo_max_width","id"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/BrandEmailDefaultPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "abc123"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "brand-email-default",
"id": "abc123",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaigns — klaviyo.get_campaigns
Get all campaigns, with optional filtering. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-audience] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-audience][] |
string | Optional | enum: ["created","definition","definition.excluded","definition.included","definition.name","definition.priority","id","updated"] |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["created","definition","definition.ab_test","definition.ab_test.winner_metric","definition.ab_test.winner_percentage","definition.ab_test.winner_wait_hours","definition.name","definition.send_options","definition.send_options.is_ignoring_unsubscribes","definition.send_options.recipient_percentage","definition.send_options.send_strategy","definition.send_options.send_time","definition.send_options.send_times","definition.send_options.throttle_unit","definition.send_options.throttling_type","definition.status","definition.tracking_options","definition.tracking_options.is_add_utm","definition.tracking_options.is_tracking_clicks","definition.tracking_options.is_tracking_opens","definition.tracking_options.tracking_params","id","updated"] |
|
query.fields[campaign] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign][] |
string | Optional | enum: ["created_at","definition","definition.archived","definition.builder","definition.color","definition.description","definition.name","definition.send_settings","definition.send_settings.exit_condition_conversion_metric_id","definition.send_settings.exit_condition_enabled","definition.send_settings.send_passed_rltz_immediately","definition.send_settings.send_strategy","definition.send_settings.send_timezone","id","updated_at"] |
|
query.fields[tag] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag][] |
string | Optional | enum: ["id","name"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any (string) name: contains (string) archived: equals (boolean) builder: equals (string) created_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) updated_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["campaign-audiences","campaign-messages","tags"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created_at","-created_at","id","-id","name","-name","updated_at","-updated_at"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Campaign — klaviyo.create_campaign
Create a campaign with inline audiences, messages, and variations. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign][] |
string | Optional | enum: ["created_at","definition","definition.archived","definition.builder","definition.color","definition.description","definition.name","definition.send_settings","definition.send_settings.exit_condition_conversion_metric_id","definition.send_settings.exit_condition_enabled","definition.send_settings.send_passed_rltz_immediately","definition.send_settings.send_strategy","definition.send_settings.send_timezone","id","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CampaignCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign",
"attributes": {
"definition": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign — klaviyo.get_campaign
Get a campaign by ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The campaign ID to be retrieved | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-audience] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-audience][] |
string | Optional | enum: ["created","definition","definition.excluded","definition.included","definition.name","definition.priority","id","updated"] |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["created","definition","definition.ab_test","definition.ab_test.winner_metric","definition.ab_test.winner_percentage","definition.ab_test.winner_wait_hours","definition.name","definition.send_options","definition.send_options.is_ignoring_unsubscribes","definition.send_options.recipient_percentage","definition.send_options.send_strategy","definition.send_options.send_time","definition.send_options.send_times","definition.send_options.throttle_unit","definition.send_options.throttling_type","definition.status","definition.tracking_options","definition.tracking_options.is_add_utm","definition.tracking_options.is_tracking_clicks","definition.tracking_options.is_tracking_opens","definition.tracking_options.tracking_params","id","updated"] |
|
query.fields[campaign] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign][] |
string | Optional | enum: ["created_at","definition","definition.archived","definition.builder","definition.color","definition.description","definition.name","definition.send_settings","definition.send_settings.exit_condition_conversion_metric_id","definition.send_settings.exit_condition_enabled","definition.send_settings.send_passed_rltz_immediately","definition.send_settings.send_strategy","definition.send_settings.send_timezone","id","updated_at"] |
|
query.fields[tag] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag][] |
string | Optional | enum: ["id","name"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["campaign-audiences","campaign-messages","tags"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Campaign — klaviyo.update_campaign
Update a campaign with the given campaign ID. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The campaign ID to be updated | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign][] |
string | Optional | enum: ["created_at","definition","definition.archived","definition.builder","definition.color","definition.description","definition.name","definition.send_settings","definition.send_settings.exit_condition_conversion_metric_id","definition.send_settings.exit_condition_enabled","definition.send_settings.send_passed_rltz_immediately","definition.send_settings.send_strategy","definition.send_settings.send_timezone","id","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CampaignPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign",
"id": "example",
"attributes": {
"definition": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Campaign — klaviyo.delete_campaign
Delete a campaign with the given campaign ID. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The campaign ID to be deleted | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign Messages — klaviyo.get_campaign_messages
Returns campaign messages based on filters. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["created","definition","definition.ab_test","definition.ab_test.winner_metric","definition.ab_test.winner_percentage","definition.ab_test.winner_wait_hours","definition.name","definition.send_options","definition.send_options.is_ignoring_unsubscribes","definition.send_options.recipient_percentage","definition.send_options.send_strategy","definition.send_options.send_time","definition.send_options.send_times","definition.send_options.throttle_unit","definition.send_options.throttling_type","definition.status","definition.tracking_options","definition.tracking_options.is_add_utm","definition.tracking_options.is_tracking_clicks","definition.tracking_options.is_tracking_opens","definition.tracking_options.tracking_params","id","updated"] |
|
query.fields[campaign] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign][] |
string | Optional | enum: ["created_at","definition","definition.archived","definition.builder","definition.color","definition.description","definition.name","definition.send_settings","definition.send_settings.exit_condition_conversion_metric_id","definition.send_settings.exit_condition_enabled","definition.send_settings.send_passed_rltz_immediately","definition.send_settings.send_strategy","definition.send_settings.send_timezone","id","updated_at"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any, equals (string) campaign_id: equals (string) name: contains (string) status: equals (string) created: greater-or-equal, greater-than, less-or-equal, less-than (date-time) updated: greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["campaign","campaign-variations"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created","id","-id","name","-name","status","-status","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Campaign Message — klaviyo.create_campaign_message
Create a campaign message. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["created","definition","definition.ab_test","definition.ab_test.winner_metric","definition.ab_test.winner_percentage","definition.ab_test.winner_wait_hours","definition.name","definition.send_options","definition.send_options.is_ignoring_unsubscribes","definition.send_options.recipient_percentage","definition.send_options.send_strategy","definition.send_options.send_time","definition.send_options.send_times","definition.send_options.throttle_unit","definition.send_options.throttling_type","definition.status","definition.tracking_options","definition.tracking_options.is_add_utm","definition.tracking_options.is_tracking_clicks","definition.tracking_options.is_tracking_opens","definition.tracking_options.tracking_params","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/MessageCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-message",
"attributes": {
"definition": {}
},
"relationships": {
"campaign": {},
"campaign-audience": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign Message — klaviyo.get_campaign_message
Get a campaign message by ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the message | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["created","definition","definition.ab_test","definition.ab_test.winner_metric","definition.ab_test.winner_percentage","definition.ab_test.winner_wait_hours","definition.name","definition.send_options","definition.send_options.is_ignoring_unsubscribes","definition.send_options.recipient_percentage","definition.send_options.send_strategy","definition.send_options.send_time","definition.send_options.send_times","definition.send_options.throttle_unit","definition.send_options.throttling_type","definition.status","definition.tracking_options","definition.tracking_options.is_add_utm","definition.tracking_options.is_tracking_clicks","definition.tracking_options.is_tracking_opens","definition.tracking_options.tracking_params","id","updated"] |
|
query.fields[campaign-variation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-variation][] |
string | Optional | enum: ["created","definition","definition.details","definition.details.action_buttons","definition.details.add_info_link","definition.details.add_opt_out_language","definition.details.add_org_prefix","definition.details.android_deep_link","definition.details.badge","definition.details.badge_config","definition.details.badge_value","definition.details.bcc_email","definition.details.body","definition.details.cc_email","definition.details.channel","definition.details.content_available","definition.details.cost","definition.details.dynamic_media_template","definition.details.from_email","definition.details.from_label","definition.details.include_contact_card","definition.details.ios_deep_link","definition.details.kv_pairs","definition.details.message_hierarchy","definition.details.mms_dynamic_image_template","definition.details.mms_static_image_asset_id","definition.details.mutable_content","definition.details.open_action","definition.details.preview_text","definition.details.push_platform_target","definition.details.push_type","definition.details.reply_to_email","definition.details.send_to_inbox","definition.details.send_to_primary","definition.details.shorten_links","definition.details.sound","definition.details.sound_file_name","definition.details.static_asset_id","definition.details.subject","definition.details.template_id","definition.details.text_message_type","definition.details.title","definition.details.video_asset_id","definition.details.web_url","definition.name","id","updated"] |
|
query.fields[campaign] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign][] |
string | Optional | enum: ["created_at","definition","definition.archived","definition.builder","definition.color","definition.description","definition.name","definition.send_settings","definition.send_settings.exit_condition_conversion_metric_id","definition.send_settings.exit_condition_enabled","definition.send_settings.send_passed_rltz_immediately","definition.send_settings.send_strategy","definition.send_settings.send_timezone","id","updated_at"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["campaign","campaign-variations"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Campaign Message — klaviyo.update_campaign_message
Update a campaign message. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the message | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["created","definition","definition.ab_test","definition.ab_test.winner_metric","definition.ab_test.winner_percentage","definition.ab_test.winner_wait_hours","definition.name","definition.send_options","definition.send_options.is_ignoring_unsubscribes","definition.send_options.recipient_percentage","definition.send_options.send_strategy","definition.send_options.send_time","definition.send_options.send_times","definition.send_options.throttle_unit","definition.send_options.throttling_type","definition.status","definition.tracking_options","definition.tracking_options.is_add_utm","definition.tracking_options.is_tracking_clicks","definition.tracking_options.is_tracking_opens","definition.tracking_options.tracking_params","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/MessagePartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-message",
"id": "example",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Campaign Message — klaviyo.delete_campaign_message
Delete a campaign message. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the message | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign Send Job — klaviyo.get_campaign_send_job
Get a campaign send job Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the campaign to send | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-send-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-send-job][] |
string | Optional | enum: ["id","status"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Cancel Campaign Send — klaviyo.cancel_campaign_send
Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to DRAFT Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the currently sending campaign to cancel or revert | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CampaignSendJobPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-send-job",
"id": "example",
"attributes": {
"action": "cancel"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign Recipient Estimation Job — klaviyo.get_campaign_recipient_estimation_job
Retrieve the status of a recipient estimation job triggered with the Create Campaign Recipient Estimation Job endpoint. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the campaign to get recipient estimation status | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-recipient-estimation-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-recipient-estimation-job][] |
string | Optional | enum: ["id","status"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign Recipient Estimation — klaviyo.get_campaign_recipient_estimation
Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using the Create Campaign Recipient Estimation Job endpoint. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the campaign for which to get the estimated number of recipients | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-recipient-estimation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-recipient-estimation][] |
string | Optional | enum: ["estimated_recipient_count","id"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign Audience — klaviyo.get_campaign_audience
Get the campaign audience with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the audience | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-audience] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-audience][] |
string | Optional | enum: ["created","definition","definition.excluded","definition.included","definition.name","definition.priority","id","updated"] |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["created","definition","definition.ab_test","definition.ab_test.winner_metric","definition.ab_test.winner_percentage","definition.ab_test.winner_wait_hours","definition.name","definition.send_options","definition.send_options.is_ignoring_unsubscribes","definition.send_options.recipient_percentage","definition.send_options.send_strategy","definition.send_options.send_time","definition.send_options.send_times","definition.send_options.throttle_unit","definition.send_options.throttling_type","definition.status","definition.tracking_options","definition.tracking_options.is_add_utm","definition.tracking_options.is_tracking_clicks","definition.tracking_options.is_tracking_opens","definition.tracking_options.tracking_params","id","updated"] |
|
query.fields[campaign] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign][] |
string | Optional | enum: ["created_at","definition","definition.archived","definition.builder","definition.color","definition.description","definition.name","definition.send_settings","definition.send_settings.exit_condition_conversion_metric_id","definition.send_settings.exit_condition_enabled","definition.send_settings.send_passed_rltz_immediately","definition.send_settings.send_strategy","definition.send_settings.send_timezone","id","updated_at"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["campaign","campaign-messages"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Campaign Audience — klaviyo.update_campaign_audience
Update the campaign audience with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the audience | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-audience] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-audience][] |
string | Optional | enum: ["created","definition","definition.excluded","definition.included","definition.name","definition.priority","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/AudienceUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-audience",
"id": "925e385b52fb405715f3616c337cc65c",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Campaign Audience — klaviyo.delete_campaign_audience
Delete the campaign audience with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the audience | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign Variation — klaviyo.get_campaign_variation
Get the campaign variation with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the variation | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["created","definition","definition.ab_test","definition.ab_test.winner_metric","definition.ab_test.winner_percentage","definition.ab_test.winner_wait_hours","definition.name","definition.send_options","definition.send_options.is_ignoring_unsubscribes","definition.send_options.recipient_percentage","definition.send_options.send_strategy","definition.send_options.send_time","definition.send_options.send_times","definition.send_options.throttle_unit","definition.send_options.throttling_type","definition.status","definition.tracking_options","definition.tracking_options.is_add_utm","definition.tracking_options.is_tracking_clicks","definition.tracking_options.is_tracking_opens","definition.tracking_options.tracking_params","id","updated"] |
|
query.fields[campaign-variation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-variation][] |
string | Optional | enum: ["created","definition","definition.details","definition.details.action_buttons","definition.details.add_info_link","definition.details.add_opt_out_language","definition.details.add_org_prefix","definition.details.android_deep_link","definition.details.badge","definition.details.badge_config","definition.details.badge_value","definition.details.bcc_email","definition.details.body","definition.details.cc_email","definition.details.channel","definition.details.content_available","definition.details.cost","definition.details.dynamic_media_template","definition.details.from_email","definition.details.from_label","definition.details.include_contact_card","definition.details.ios_deep_link","definition.details.kv_pairs","definition.details.message_hierarchy","definition.details.mms_dynamic_image_template","definition.details.mms_static_image_asset_id","definition.details.mutable_content","definition.details.open_action","definition.details.preview_text","definition.details.push_platform_target","definition.details.push_type","definition.details.reply_to_email","definition.details.send_to_inbox","definition.details.send_to_primary","definition.details.shorten_links","definition.details.sound","definition.details.sound_file_name","definition.details.static_asset_id","definition.details.subject","definition.details.template_id","definition.details.text_message_type","definition.details.title","definition.details.video_asset_id","definition.details.web_url","definition.name","id","updated"] |
|
query.fields[image] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[image][] |
string | Optional | enum: ["format","hidden","id","image_url","name","size","updated_at"] |
|
query.fields[translation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[translation][] |
string | Optional | enum: ["channel","created","fallback_locale","id","metadata","source_locale","target_locales","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["campaign-message","image","translation"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Campaign Variation — klaviyo.update_campaign_variation
Update the campaign variation with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the variation | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-variation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-variation][] |
string | Optional | enum: ["created","definition","definition.details","definition.details.action_buttons","definition.details.add_info_link","definition.details.add_opt_out_language","definition.details.add_org_prefix","definition.details.android_deep_link","definition.details.badge","definition.details.badge_config","definition.details.badge_value","definition.details.bcc_email","definition.details.body","definition.details.cc_email","definition.details.channel","definition.details.content_available","definition.details.cost","definition.details.dynamic_media_template","definition.details.from_email","definition.details.from_label","definition.details.include_contact_card","definition.details.ios_deep_link","definition.details.kv_pairs","definition.details.message_hierarchy","definition.details.mms_dynamic_image_template","definition.details.mms_static_image_asset_id","definition.details.mutable_content","definition.details.open_action","definition.details.preview_text","definition.details.push_platform_target","definition.details.push_type","definition.details.reply_to_email","definition.details.send_to_inbox","definition.details.send_to_primary","definition.details.shorten_links","definition.details.sound","definition.details.sound_file_name","definition.details.static_asset_id","definition.details.subject","definition.details.template_id","definition.details.text_message_type","definition.details.title","definition.details.video_asset_id","definition.details.web_url","definition.name","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/VariationPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-variation",
"id": "925e385b52fb405715f3616c337cc65c",
"attributes": {
"definition": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Campaign Variation — klaviyo.delete_campaign_variation
Delete the campaign variation with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the variation | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Clone Campaign — klaviyo.clone_campaign
Clones an existing campaign, returning a new campaign based on the original with a new ID and name. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign][] |
string | Optional | enum: ["created_at","definition","definition.archived","definition.builder","definition.color","definition.description","definition.name","definition.send_settings","definition.send_settings.exit_condition_conversion_metric_id","definition.send_settings.exit_condition_enabled","definition.send_settings.send_passed_rltz_immediately","definition.send_settings.send_strategy","definition.send_settings.send_timezone","id","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CampaignCloneQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign",
"id": "example",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Assign Template to Campaign Message — klaviyo.assign_template_to_campaign_message
Creates a non-reusable version of the template and assigns it to the message. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["channel","content","content.bcc_email","content.body","content.cc_email","content.from_email","content.from_label","content.media_url","content.preview_text","content.reply_to_email","content.subject","created_at","id","label","render_options","render_options.add_info_link","render_options.add_opt_out_language","render_options.add_org_prefix","render_options.shorten_links","send_times","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CampaignMessageAssignTemplateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-message",
"id": "example",
"relationships": {
"template": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Send Campaign — klaviyo.send_campaign
Trigger a campaign to send asynchronously Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-send-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-send-job][] |
string | Optional | enum: ["id","status"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CampaignSendJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-send-job",
"id": "example"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Refresh Campaign Recipient Estimation — klaviyo.refresh_campaign_recipient_estimation
Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the Get Campaign Recipient Estimation Job endpoint to retrieve the status of this estimation job. Use the Get Campaign Recipient Estimation endpoint to retrieve the estimated recipient count for a given campaign. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-recipient-estimation-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-recipient-estimation-job][] |
string | Optional | enum: ["id","status"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CampaignRecipientEstimationJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-recipient-estimation-job",
"id": "example"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Campaign Audience — klaviyo.create_campaign_audience
Create a campaign audience. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-audience] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-audience][] |
string | Optional | enum: ["created","definition","definition.excluded","definition.included","definition.name","definition.priority","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/AudienceCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-audience",
"attributes": {
"definition": {}
},
"relationships": {
"campaign": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Clone Campaign Audience — klaviyo.clone_campaign_audience
Clone an existing campaign audience to a target campaign. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-audience] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-audience][] |
string | Optional | enum: ["created","definition","definition.excluded","definition.included","definition.name","definition.priority","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/AudienceCloneQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-audience-clone",
"id": "925e385b52fb405715f3616c337cc65c",
"attributes": {
"id": "925e385b52fb405715f3616c337cc65c"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Clone Campaign Message — klaviyo.clone_campaign_message
Clone an existing campaign message to a target audience. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["created","definition","definition.ab_test","definition.ab_test.winner_metric","definition.ab_test.winner_percentage","definition.ab_test.winner_wait_hours","definition.name","definition.send_options","definition.send_options.is_ignoring_unsubscribes","definition.send_options.recipient_percentage","definition.send_options.send_strategy","definition.send_options.send_time","definition.send_options.send_times","definition.send_options.throttle_unit","definition.send_options.throttling_type","definition.status","definition.tracking_options","definition.tracking_options.is_add_utm","definition.tracking_options.is_tracking_clicks","definition.tracking_options.is_tracking_opens","definition.tracking_options.tracking_params","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/MessageCloneQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-message",
"id": "example",
"attributes": {
"id": "example"
},
"relationships": {
"campaign-audience": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Campaign Variation — klaviyo.create_campaign_variation
Create a campaign variation. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-variation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-variation][] |
string | Optional | enum: ["created","definition","definition.details","definition.details.action_buttons","definition.details.add_info_link","definition.details.add_opt_out_language","definition.details.add_org_prefix","definition.details.android_deep_link","definition.details.badge","definition.details.badge_config","definition.details.badge_value","definition.details.bcc_email","definition.details.body","definition.details.cc_email","definition.details.channel","definition.details.content_available","definition.details.cost","definition.details.dynamic_media_template","definition.details.from_email","definition.details.from_label","definition.details.include_contact_card","definition.details.ios_deep_link","definition.details.kv_pairs","definition.details.message_hierarchy","definition.details.mms_dynamic_image_template","definition.details.mms_static_image_asset_id","definition.details.mutable_content","definition.details.open_action","definition.details.preview_text","definition.details.push_platform_target","definition.details.push_type","definition.details.reply_to_email","definition.details.send_to_inbox","definition.details.send_to_primary","definition.details.shorten_links","definition.details.sound","definition.details.sound_file_name","definition.details.static_asset_id","definition.details.subject","definition.details.template_id","definition.details.text_message_type","definition.details.title","definition.details.video_asset_id","definition.details.web_url","definition.name","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/VariationCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-variation",
"attributes": {
"definition": {}
},
"relationships": {
"campaign-message": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Schedule Campaign Message — klaviyo.schedule_campaign_message
Schedule a single campaign message. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-message-schedule] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message-schedule][] |
string | Optional | enum: ["id","send_date","send_time","strategy","throttle_unit","throttling_percentage"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CampaignMessageScheduleQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-message-schedule",
"attributes": {
"strategy": "static"
},
"relationships": {
"campaign-message": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Campaign Message Schedule — klaviyo.update_campaign_message_schedule
Cancel or revert a scheduled campaign message. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CampaignMessageScheduleUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-message-schedule",
"id": "example",
"attributes": {
"action": "cancel"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign for Campaign Message — klaviyo.get_campaign_for_campaign_message
Return the related omnicampaign Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the message | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign][] |
string | Optional | enum: ["created_at","definition","definition.archived","definition.builder","definition.color","definition.description","definition.name","definition.send_settings","definition.send_settings.exit_condition_conversion_metric_id","definition.send_settings.exit_condition_enabled","definition.send_settings.send_passed_rltz_immediately","definition.send_settings.send_strategy","definition.send_settings.send_timezone","id","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign ID for Campaign Message — klaviyo.get_campaign_id_for_campaign_message
Returns the ID of the related omnicampaign Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the message | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Template for Campaign Message — klaviyo.get_template_for_campaign_message
Return the related template Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[template] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template][] |
string | Optional | enum: ["amp","created","editor_type","html","id","name","screenshot_url","text","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Template ID for Campaign Message — klaviyo.get_template_id_for_campaign_message
Returns the ID of the related template Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Image for Campaign Message — klaviyo.get_image_for_campaign_message
Return the related image for a given campaign message Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[image] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[image][] |
string | Optional | enum: ["format","hidden","id","image_url","name","size","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Image ID for Campaign Message — klaviyo.get_image_id_for_campaign_message
Returns the ID of the related image Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Image for Campaign Message — klaviyo.update_image_for_campaign_message
Update a campaign message image Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CampaignMessageImageUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "image",
"id": "14254"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Audience for Campaign Message — klaviyo.get_audience_for_campaign_message
Get the campaign audience for the given campaign message ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the message | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-audience] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-audience][] |
string | Optional | enum: ["created","definition","definition.excluded","definition.included","definition.name","definition.priority","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Audience ID for Campaign Message — klaviyo.get_audience_id_for_campaign_message
Get the campaign audience relationship for the given campaign message ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the message | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tag IDs for Campaign — klaviyo.get_tag_ids_for_campaign
Returns the IDs of all tags associated with the given campaign. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tag IDs for Campaign Message — klaviyo.get_tag_ids_for_campaign_message
Get all tag relationships for the given campaign message ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Messages for Campaign — klaviyo.get_messages_for_campaign
Get all messages for the given campaign. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The campaign ID | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["created","definition","definition.ab_test","definition.ab_test.winner_metric","definition.ab_test.winner_percentage","definition.ab_test.winner_wait_hours","definition.name","definition.send_options","definition.send_options.is_ignoring_unsubscribes","definition.send_options.recipient_percentage","definition.send_options.send_strategy","definition.send_options.send_time","definition.send_options.send_times","definition.send_options.throttle_unit","definition.send_options.throttling_type","definition.status","definition.tracking_options","definition.tracking_options.is_add_utm","definition.tracking_options.is_tracking_clicks","definition.tracking_options.is_tracking_opens","definition.tracking_options.tracking_params","id","updated"] |
|
query.fields[campaign] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign][] |
string | Optional | enum: ["created_at","definition","definition.archived","definition.builder","definition.color","definition.description","definition.name","definition.send_settings","definition.send_settings.exit_condition_conversion_metric_id","definition.send_settings.exit_condition_enabled","definition.send_settings.send_passed_rltz_immediately","definition.send_settings.send_strategy","definition.send_settings.send_timezone","id","updated_at"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["campaign"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Message IDs for Campaign — klaviyo.get_message_ids_for_campaign
Get all campaign message relationships for the given campaign ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The campaign ID | |
query |
object | Optional | additionalProperties: false |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign Audiences for Campaign — klaviyo.get_campaign_audiences_for_campaign
Get all campaign audiences for the given campaign ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The campaign ID | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-audience] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-audience][] |
string | Optional | enum: ["created","definition","definition.excluded","definition.included","definition.name","definition.priority","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Audience IDs for Campaign — klaviyo.get_audience_ids_for_campaign
Get all campaign audience relationships for the given campaign ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The campaign ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign for Campaign Audience — klaviyo.get_campaign_for_campaign_audience
Get the campaign for the given campaign audience ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the audience | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign][] |
string | Optional | enum: ["created_at","definition","definition.archived","definition.builder","definition.color","definition.description","definition.name","definition.send_settings","definition.send_settings.exit_condition_conversion_metric_id","definition.send_settings.exit_condition_enabled","definition.send_settings.send_passed_rltz_immediately","definition.send_settings.send_strategy","definition.send_settings.send_timezone","id","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign ID for Campaign Audience — klaviyo.get_campaign_id_for_campaign_audience
Get the campaign relationship for the given campaign audience ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the audience | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign Messages for Campaign Audience — klaviyo.get_campaign_messages_for_campaign_audience
Get all campaign messages for the given campaign audience ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the audience | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["created","definition","definition.ab_test","definition.ab_test.winner_metric","definition.ab_test.winner_percentage","definition.ab_test.winner_wait_hours","definition.name","definition.send_options","definition.send_options.is_ignoring_unsubscribes","definition.send_options.recipient_percentage","definition.send_options.send_strategy","definition.send_options.send_time","definition.send_options.send_times","definition.send_options.throttle_unit","definition.send_options.throttling_type","definition.status","definition.tracking_options","definition.tracking_options.is_add_utm","definition.tracking_options.is_tracking_clicks","definition.tracking_options.is_tracking_opens","definition.tracking_options.tracking_params","id","updated"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Message IDs for Campaign Audience — klaviyo.get_message_ids_for_campaign_audience
Get all campaign messages relationships for the given campaign audience ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the audience | |
query |
object | Optional | additionalProperties: false |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Message for Campaign Variation — klaviyo.get_message_for_campaign_variation
Get the campaign message for the given campaign variation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the variation | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-message][] |
string | Optional | enum: ["created","definition","definition.ab_test","definition.ab_test.winner_metric","definition.ab_test.winner_percentage","definition.ab_test.winner_wait_hours","definition.name","definition.send_options","definition.send_options.is_ignoring_unsubscribes","definition.send_options.recipient_percentage","definition.send_options.send_strategy","definition.send_options.send_time","definition.send_options.send_times","definition.send_options.throttle_unit","definition.send_options.throttling_type","definition.status","definition.tracking_options","definition.tracking_options.is_add_utm","definition.tracking_options.is_tracking_clicks","definition.tracking_options.is_tracking_opens","definition.tracking_options.tracking_params","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Message ID for Campaign Variation — klaviyo.get_message_id_for_campaign_variation
Get the campaign message relationship for the given campaign variation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the variation | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Translation for Campaign Variation — klaviyo.get_translation_for_campaign_variation
Get the translation for the given campaign variation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the variation | |
query |
object | Optional | additionalProperties: false |
|
query.fields[translation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[translation][] |
string | Optional | enum: ["channel","created","fallback_locale","id","metadata","source_locale","target_locales","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Translation ID for Campaign Variation — klaviyo.get_translation_id_for_campaign_variation
Get the translation relationship for the given campaign variation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the variation | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Image for Campaign Variation — klaviyo.get_image_for_campaign_variation
Get the image for the given campaign variation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the variation | |
query |
object | Optional | additionalProperties: false |
|
query.fields[image] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[image][] |
string | Optional | enum: ["format","hidden","id","image_url","name","size","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Image ID for Campaign Variation — klaviyo.get_image_id_for_campaign_variation
Get the image relationship for the given campaign variation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the variation | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Variations for Campaign Message — klaviyo.get_variations_for_campaign_message
Get all campaign variations for the given campaign message ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the message | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-variation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-variation][] |
string | Optional | enum: ["created","definition","definition.details","definition.details.action_buttons","definition.details.add_info_link","definition.details.add_opt_out_language","definition.details.add_org_prefix","definition.details.android_deep_link","definition.details.badge","definition.details.badge_config","definition.details.badge_value","definition.details.bcc_email","definition.details.body","definition.details.cc_email","definition.details.channel","definition.details.content_available","definition.details.cost","definition.details.dynamic_media_template","definition.details.from_email","definition.details.from_label","definition.details.include_contact_card","definition.details.ios_deep_link","definition.details.kv_pairs","definition.details.message_hierarchy","definition.details.mms_dynamic_image_template","definition.details.mms_static_image_asset_id","definition.details.mutable_content","definition.details.open_action","definition.details.preview_text","definition.details.push_platform_target","definition.details.push_type","definition.details.reply_to_email","definition.details.send_to_inbox","definition.details.send_to_primary","definition.details.shorten_links","definition.details.sound","definition.details.sound_file_name","definition.details.static_asset_id","definition.details.subject","definition.details.template_id","definition.details.text_message_type","definition.details.title","definition.details.video_asset_id","definition.details.web_url","definition.name","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Variation IDs for Campaign Message — klaviyo.get_variation_ids_for_campaign_message
Get all campaign variation relationships for the given campaign message ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the message | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Catalog Items — klaviyo.get_catalog_items
Get all catalog items in an account.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","price","published","title","updated","url"] |
|
query.fields[catalog-variant] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","inventory_policy","inventory_quantity","price","published","sku","title","updated","url"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): ids: any (string) category.id: equals (string) title: contains (string) published: equals (boolean) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["variants"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Catalog Item — klaviyo.create_catalog_item
Create a new catalog item. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","price","published","title","updated","url"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogItemCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-item",
"attributes": {
"external_id": "SAMPLE-DATA-ITEM-1",
"title": "Ocean Blue Shirt (Sample)",
"description": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.",
"url": "https://via.placeholder.com/150"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Catalog Item — klaviyo.get_catalog_item
Get a specific catalog item with the given item ID. Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","price","published","title","updated","url"] |
|
query.fields[catalog-variant] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","inventory_policy","inventory_quantity","price","published","sku","title","updated","url"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["variants"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Catalog Item — klaviyo.update_catalog_item
Update a catalog item with the given item ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","price","published","title","updated","url"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogItemUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-item",
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Catalog Item — klaviyo.delete_catalog_item
Delete a catalog item with the given item ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Catalog Variants — klaviyo.get_catalog_variants
Get all variants in an account.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","inventory_policy","inventory_quantity","price","published","sku","title","updated","url"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): ids: any (string) item.id: equals (string) sku: equals (string) title: contains (string) published: equals (boolean) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Catalog Variant — klaviyo.create_catalog_variant
Create a new variant for a related catalog item. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","inventory_policy","inventory_quantity","price","published","sku","title","updated","url"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogVariantCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-variant",
"attributes": {
"external_id": "SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"title": "Ocean Blue Shirt (Sample) Variant Medium",
"description": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.",
"sku": "OBS-MD",
"inventory_quantity": 25,
"price": 42,
"url": "https://via.placeholder.com/150"
},
"relationships": {
"item": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Catalog Variant — klaviyo.get_catalog_variant
Get a catalog item variant with the given variant ID. Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog variant ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","inventory_policy","inventory_quantity","price","published","sku","title","updated","url"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Catalog Variant — klaviyo.update_catalog_variant
Update a catalog item variant with the given variant ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog variant ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","inventory_policy","inventory_quantity","price","published","sku","title","updated","url"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogVariantUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-variant",
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Catalog Variant — klaviyo.delete_catalog_variant
Delete a catalog item variant with the given variant ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog variant ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Catalog Categories — klaviyo.get_catalog_categories
Get all catalog categories in an account.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category][] |
string | Optional | enum: ["external_id","id","name","updated"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): ids: any (string) item.id: equals (string) name: contains (string) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Catalog Category — klaviyo.create_catalog_category
Create a new catalog category. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category][] |
string | Optional | enum: ["external_id","id","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogCategoryCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-category",
"attributes": {
"external_id": "SAMPLE-DATA-CATEGORY-APPAREL",
"name": "Sample Data Category Apparel"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Catalog Category — klaviyo.get_catalog_category
Get a catalog category with the given category ID. Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog category ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category][] |
string | Optional | enum: ["external_id","id","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Catalog Category — klaviyo.update_catalog_category
Update a catalog category with the given category ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog category ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category][] |
string | Optional | enum: ["external_id","id","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogCategoryUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-category",
"id": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Catalog Category — klaviyo.delete_catalog_category
Delete a catalog category using the given category ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog category ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Create Catalog Items Jobs — klaviyo.get_bulk_create_catalog_items_jobs
Get all catalog item bulk create jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: equals (allowed values: 'queued', 'processing', 'complete', 'cancelled') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Create Catalog Items — klaviyo.bulk_create_catalog_items
Create a catalog item bulk create job to create a batch of catalog items.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogItemCreateJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-item-bulk-create-job",
"attributes": {
"items": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Create Catalog Items Job — klaviyo.get_bulk_create_catalog_items_job
Get a catalog item bulk create job with the given job ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.fields[catalog-item] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","price","published","title","updated","url"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["items"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Update Catalog Items Jobs — klaviyo.get_bulk_update_catalog_items_jobs
Get all catalog item bulk update jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item-bulk-update-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item-bulk-update-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: equals (allowed values: 'queued', 'processing', 'complete', 'cancelled') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Update Catalog Items — klaviyo.bulk_update_catalog_items
Create a catalog item bulk update job to update a batch of catalog items.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item-bulk-update-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item-bulk-update-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogItemUpdateJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-item-bulk-update-job",
"attributes": {
"items": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Update Catalog Items Job — klaviyo.get_bulk_update_catalog_items_job
Get a catalog item bulk update job with the given job ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item-bulk-update-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item-bulk-update-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.fields[catalog-item] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","price","published","title","updated","url"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["items"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Delete Catalog Items Jobs — klaviyo.get_bulk_delete_catalog_items_jobs
Get all catalog item bulk delete jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item-bulk-delete-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item-bulk-delete-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: equals (allowed values: 'queued', 'processing', 'complete', 'cancelled') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Delete Catalog Items — klaviyo.bulk_delete_catalog_items
Create a catalog item bulk delete job to delete a batch of catalog items.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item-bulk-delete-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item-bulk-delete-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogItemDeleteJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-item-bulk-delete-job",
"attributes": {
"items": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Delete Catalog Items Job — klaviyo.get_bulk_delete_catalog_items_job
Get a catalog item bulk delete job with the given job ID. Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item-bulk-delete-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item-bulk-delete-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Create Variants Jobs — klaviyo.get_bulk_create_variants_jobs
Get all catalog variant bulk create jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: equals (allowed values: 'queued', 'processing', 'complete', 'cancelled') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Create Catalog Variants — klaviyo.bulk_create_catalog_variants
Create a catalog variant bulk create job to create a batch of catalog variants.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogVariantCreateJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-variant-bulk-create-job",
"attributes": {
"variants": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Create Variants Job — klaviyo.get_bulk_create_variants_job
Get a catalog variant bulk create job with the given job ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.fields[catalog-variant] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","inventory_policy","inventory_quantity","price","published","sku","title","updated","url"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["variants"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Update Variants Jobs — klaviyo.get_bulk_update_variants_jobs
Get all catalog variant bulk update jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant-bulk-update-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant-bulk-update-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: equals (allowed values: 'queued', 'processing', 'complete', 'cancelled') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Update Catalog Variants — klaviyo.bulk_update_catalog_variants
Create a catalog variant bulk update job to update a batch of catalog variants.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant-bulk-update-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant-bulk-update-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogVariantUpdateJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-variant-bulk-update-job",
"attributes": {
"variants": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Update Variants Job — klaviyo.get_bulk_update_variants_job
Get a catalog variate bulk update job with the given job ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant-bulk-update-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant-bulk-update-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.fields[catalog-variant] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","inventory_policy","inventory_quantity","price","published","sku","title","updated","url"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["variants"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Delete Variants Jobs — klaviyo.get_bulk_delete_variants_jobs
Get all catalog variant bulk delete jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant-bulk-delete-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant-bulk-delete-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: equals (allowed values: 'queued', 'processing', 'complete', 'cancelled') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Delete Catalog Variants — klaviyo.bulk_delete_catalog_variants
Create a catalog variant bulk delete job to delete a batch of catalog variants.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant-bulk-delete-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant-bulk-delete-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogVariantDeleteJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-variant-bulk-delete-job",
"attributes": {
"variants": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Delete Variants Job — klaviyo.get_bulk_delete_variants_job
Get a catalog variant bulk delete job with the given job ID. Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant-bulk-delete-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant-bulk-delete-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Create Categories Jobs — klaviyo.get_bulk_create_categories_jobs
Get all catalog category bulk create jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: equals (allowed values: 'queued', 'processing', 'complete', 'cancelled') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Create Catalog Categories — klaviyo.bulk_create_catalog_categories
Create a catalog category bulk create job to create a batch of catalog categories.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogCategoryCreateJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-category-bulk-create-job",
"attributes": {
"categories": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Create Categories Job — klaviyo.get_bulk_create_categories_job
Get a catalog category bulk create job with the given job ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.fields[catalog-category] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category][] |
string | Optional | enum: ["external_id","id","name","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["categories"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Update Categories Jobs — klaviyo.get_bulk_update_categories_jobs
Get all catalog category bulk update jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category-bulk-update-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category-bulk-update-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: equals (allowed values: 'queued', 'processing', 'complete', 'cancelled') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Update Catalog Categories — klaviyo.bulk_update_catalog_categories
Create a catalog category bulk update job to update a batch of catalog categories.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category-bulk-update-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category-bulk-update-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogCategoryUpdateJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-category-bulk-update-job",
"attributes": {
"categories": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Update Categories Job — klaviyo.get_bulk_update_categories_job
Get a catalog category bulk update job with the given job ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category-bulk-update-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category-bulk-update-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.fields[catalog-category] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category][] |
string | Optional | enum: ["external_id","id","name","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["categories"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Delete Categories Jobs — klaviyo.get_bulk_delete_categories_jobs
Get all catalog category bulk delete jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category-bulk-delete-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category-bulk-delete-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: equals (allowed values: 'queued', 'processing', 'complete', 'cancelled') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Delete Catalog Categories — klaviyo.bulk_delete_catalog_categories
Create a catalog category bulk delete job to delete a batch of catalog categories.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category-bulk-delete-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category-bulk-delete-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogCategoryDeleteJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "catalog-category-bulk-delete-job",
"attributes": {
"categories": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Delete Categories Job — klaviyo.get_bulk_delete_categories_job
Get a catalog category bulk delete job with the given job ID. Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category-bulk-delete-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category-bulk-delete-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Back In Stock Subscription — klaviyo.create_back_in_stock_subscription
Subscribe a profile to receive back in stock notifications. Check out our Back in Stock API guide for more details.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ServerBISSubscriptionCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "back-in-stock-subscription",
"attributes": {
"channels": [
"EMAIL",
"SMS"
]
},
"relationships": {
"variant": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Items for Catalog Category — klaviyo.get_items_for_catalog_category
Get all items in a category with the given category ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | null | Required | The catalog category ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-item] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-item][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","price","published","title","updated","url"] |
|
query.fields[catalog-variant] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","inventory_policy","inventory_quantity","price","published","sku","title","updated","url"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): ids: any (string) category.id: equals (string) title: contains (string) published: equals (boolean) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["variants"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Item IDs for Catalog Category — klaviyo.get_item_ids_for_catalog_category
Get all items in the given category ID. Returns a maximum of 100 items per request. Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | null | Required | The catalog category ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
query |
object | Optional | additionalProperties: false |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): ids: any (string) category.id: equals (string) title: contains (string) published: equals (boolean) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add Items to Catalog Category — klaviyo.add_items_to_catalog_category
Create a new item relationship for the given category ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog category ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogCategoryItemOp" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Items for Catalog Category — klaviyo.update_items_for_catalog_category
Update item relationships for the given category ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog category ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogCategoryItemOp" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Items from Catalog Category — klaviyo.remove_items_from_catalog_category
Delete item relationships for the given category ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog category ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogCategoryItemOp" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Variants for Catalog Item — klaviyo.get_variants_for_catalog_item
Get all variants related to the given item ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | null | Required | The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-variant] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-variant][] |
string | Optional | enum: ["created","custom_metadata","description","external_id","id","image_full_url","image_thumbnail_url","images","inventory_policy","inventory_quantity","price","published","sku","title","updated","url"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): ids: any (string) item.id: equals (string) sku: equals (string) title: contains (string) published: equals (boolean) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Variant IDs for Catalog Item — klaviyo.get_variant_ids_for_catalog_item
Get all variants related to the given item ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | null | Required | The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
query |
object | Optional | additionalProperties: false |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): ids: any (string) item.id: equals (string) sku: equals (string) title: contains (string) published: equals (boolean) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Categories for Catalog Item — klaviyo.get_categories_for_catalog_item
Get all catalog categories that an item with the given item ID is in.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | null | Required | The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
query |
object | Optional | additionalProperties: false |
|
query.fields[catalog-category] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[catalog-category][] |
string | Optional | enum: ["external_id","id","name","updated"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): ids: any (string) item.id: equals (string) name: contains (string) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Category IDs for Catalog Item — klaviyo.get_category_ids_for_catalog_item
Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request. Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | null | Required | The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
query |
object | Optional | additionalProperties: false |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): ids: any (string) item.id: equals (string) name: contains (string) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add Categories to Catalog Item — klaviyo.add_categories_to_catalog_item
Create a new catalog category relationship for the given item ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogItemCategoryOp" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Categories for Catalog Item — klaviyo.update_categories_for_catalog_item
Update catalog category relationships for the given item ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogItemCategoryOp" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Categories from Catalog Item — klaviyo.remove_categories_from_catalog_item
Delete catalog category relationships for the given item ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default. |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CatalogItemCategoryOp" |
Full JSON Schema
Example input
{
"path": {
"id": "$custom:::$default:::SAMPLE-DATA-ITEM-1"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Conversation Message — klaviyo.create_conversation_message
Send an outbound message to a conversation.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ConversationMessageCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "conversation-message",
"attributes": {
"body": "example"
},
"relationships": {
"conversation": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Coupons — klaviyo.get_coupons
Get all coupons in an account.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[coupon] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon][] |
string | Optional | enum: ["assigner_configuration","assigner_configuration.unused_expired","assigner_configuration.used","description","external_id","id","monitor_configuration"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Coupon — klaviyo.create_coupon
Creates a new coupon. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[coupon] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon][] |
string | Optional | enum: ["assigner_configuration","assigner_configuration.unused_expired","assigner_configuration.used","description","external_id","id","monitor_configuration"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CouponCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "coupon",
"attributes": {
"external_id": "10OFF"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Coupon — klaviyo.get_coupon
Get a specific coupon with the given coupon ID. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The internal id of a Coupon is equivalent to its external id stored within an integration. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[coupon] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon][] |
string | Optional | enum: ["assigner_configuration","assigner_configuration.unused_expired","assigner_configuration.used","description","external_id","id","monitor_configuration"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "10OFF"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Coupon — klaviyo.update_coupon
Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The internal id of a Coupon is equivalent to its external id stored within an integration. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[coupon] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon][] |
string | Optional | enum: ["assigner_configuration","assigner_configuration.unused_expired","assigner_configuration.used","description","external_id","id","monitor_configuration"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CouponUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "10OFF"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "coupon",
"id": "10OFF",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Coupon — klaviyo.delete_coupon
Delete the coupon with the given coupon ID. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The internal id of a Coupon is equivalent to its external id stored within an integration. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "10OFF"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Coupon Codes — klaviyo.get_coupon_codes
Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Required | additionalProperties: false |
|
query.fields[coupon-code] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon-code][] |
string | Optional | enum: ["expires_at","id","status","unique_code"] |
|
query.fields[coupon] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon][] |
string | Optional | enum: ["assigner_configuration","assigner_configuration.unused_expired","assigner_configuration.used","description","external_id","id","monitor_configuration"] |
|
query.filter |
string | Required | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): expires_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) status: equals (allowed values: 'UNASSIGNED', 'PROCESSING', 'ASSIGNED_TO_PROFILE', 'VERSION_NOT_ACTIVE', 'DELETING', 'USED') coupon.id: any, equals (string) profile.id: any, equals (string) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["coupon"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"query": {
"filter": "equals(coupon.id,'10OFF')"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Coupon Code — klaviyo.create_coupon_code
Synchronously creates a coupon code for the given coupon. Rate limits: Burst: 350/s Steady: 3500/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[coupon-code] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon-code][] |
string | Optional | enum: ["expires_at","id","status","unique_code"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CouponCodeCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "coupon-code",
"attributes": {
"unique_code": "ASD325FHK324UJDOI2M3JNES99"
},
"relationships": {
"coupon": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Coupon Code — klaviyo.get_coupon_code
Returns a Coupon Code specified by the given identifier. Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[coupon-code] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon-code][] |
string | Optional | enum: ["expires_at","id","status","unique_code"] |
|
query.fields[coupon] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon][] |
string | Optional | enum: ["assigner_configuration","assigner_configuration.unused_expired","assigner_configuration.used","description","external_id","id","monitor_configuration"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["coupon"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "10OFF-ASD325FHK324UJDOI2M3JNES99"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Coupon Code — klaviyo.update_coupon_code
Updates a coupon code specified by the given identifier synchronously. We allow updating the 'status' and 'expires_at' of coupon codes. Rate limits: Burst: 350/s Steady: 3500/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[coupon-code] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon-code][] |
string | Optional | enum: ["expires_at","id","status","unique_code"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CouponCodeUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "10OFF-ASD325FHK324UJDOI2M3JNES99"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "coupon-code",
"id": "10OFF-ASD325FHK324UJDOI2M3JNES99",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Coupon Code — klaviyo.delete_coupon_code
Deletes a coupon code specified by the given identifier synchronously. If a profile has been assigned to the coupon code, an exception will be raised Rate limits: Burst: 350/s Steady: 3500/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "10OFF-ASD325FHK324UJDOI2M3JNES99"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Create Coupon Code Jobs — klaviyo.get_bulk_create_coupon_code_jobs
Get all coupon code bulk create jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[coupon-code-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon-code-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: equals (allowed values: 'queued', 'processing', 'complete', 'cancelled') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Create Coupon Codes — klaviyo.bulk_create_coupon_codes
Create a coupon-code-bulk-create-job to bulk create a list of coupon codes.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[coupon-code-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon-code-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CouponCodeCreateJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "coupon-code-bulk-create-job",
"attributes": {
"coupon-codes": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Create Coupon Codes Job — klaviyo.get_bulk_create_coupon_codes_job
Get a coupon code bulk create job with the given job ID. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[coupon-code-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon-code-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","errors","expires_at","failed_count","id","status","total_count"] |
|
query.fields[coupon-code] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon-code][] |
string | Optional | enum: ["expires_at","id","status","unique_code"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["coupon-codes"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Coupon For Coupon Code — klaviyo.get_coupon_for_coupon_code
Get the coupon associated with a given coupon code ID. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the coupon to look up the relationship of. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[coupon] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon][] |
string | Optional | enum: ["assigner_configuration","assigner_configuration.unused_expired","assigner_configuration.used","description","external_id","id","monitor_configuration"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "10OFF"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Coupon ID for Coupon Code — klaviyo.get_coupon_id_for_coupon_code
Gets the coupon relationship associated with the given coupon code id Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the coupon to look up the relationship of. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "10OFF"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Coupon Codes for Coupon — klaviyo.get_coupon_codes_for_coupon
Gets a list of coupon codes associated with the given coupon id Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the coupon to look up the relationship of. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[coupon-code] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[coupon-code][] |
string | Optional | enum: ["expires_at","id","status","unique_code"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): expires_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) status: equals (allowed values: 'UNASSIGNED', 'PROCESSING', 'ASSIGNED_TO_PROFILE', 'VERSION_NOT_ACTIVE', 'DELETING', 'USED') profile.id: any, equals (string) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "10OFF"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Coupon Code IDs for Coupon — klaviyo.get_coupon_code_ids_for_coupon
Gets a list of coupon code relationships associated with the given coupon id Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the coupon to look up the relationship of. | |
query |
object | Optional | additionalProperties: false |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): expires_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) status: equals (allowed values: 'UNASSIGNED', 'PROCESSING', 'ASSIGNED_TO_PROFILE', 'VERSION_NOT_ACTIVE', 'DELETING', 'USED') profile.id: any, equals (string) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 100. Min: 1. Max: 100. | default: 100; minimum: 1; maximum: 100 |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "10OFF"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Data Sources — klaviyo.get_data_sources
Get all data sources in an account. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[data-source] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[data-source][] |
string | Optional | enum: ["description","id","namespace","title","visibility"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): namespace: equals (string) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Data Source — klaviyo.create_data_source
Create a new data source in an account Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[data-source] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[data-source][] |
string | Optional | enum: ["description","id","namespace","title","visibility"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/DataSourceCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "data-source",
"attributes": {
"title": "example"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Data Source — klaviyo.get_data_source
Retrieve a data source in an account. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the data source | |
query |
object | Optional | additionalProperties: false |
|
query.fields[data-source] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[data-source][] |
string | Optional | enum: ["description","id","namespace","title","visibility"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Data Source — klaviyo.delete_data_source
Delete a data source in an account. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the data source to delete | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Source Mapping — klaviyo.get_source_mapping
Get the source mapping with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the source mapping | |
query |
object | Optional | additionalProperties: false |
|
query.fields[source-mapping] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[source-mapping][] |
string | Optional | enum: ["id","property_mappings","relationship_mappings"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5HQC66PGHV35SYJC5ZV3DZA"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Source Mapping — klaviyo.update_source_mapping
Update the source mapping with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the source mapping | |
query |
object | Optional | additionalProperties: false |
|
query.fields[source-mapping] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[source-mapping][] |
string | Optional | enum: ["id","property_mappings","relationship_mappings"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/SourceMappingPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5HQC66PGHV35SYJC5ZV3DZA"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "source-mapping",
"id": "01K5HQC66PGHV35SYJC5ZV3DZA",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Object Types — klaviyo.get_object_types
Get all object types in an account. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[object-schema] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-schema][] |
string | Optional | enum: ["description","id","properties","published_at","required","status","title","visibility"] |
|
query.fields[object-type] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-type][] |
string | Optional | enum: ["created_at","description","id","namespace","status","title","updated_at"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): namespace: equals (string) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["current-schema","draft-schema"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Object Type — klaviyo.create_object_type
Create an object type. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[object-type] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-type][] |
string | Optional | enum: ["created_at","description","id","namespace","status","title","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ObjectTypeCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "object-type",
"attributes": {
"title": "Pet Care Subscription"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Object Type — klaviyo.get_object_type
Get the object type with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[object-schema] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-schema][] |
string | Optional | enum: ["description","id","properties","published_at","required","status","title","visibility"] |
|
query.fields[object-type] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-type][] |
string | Optional | enum: ["created_at","description","id","namespace","status","title","updated_at"] |
|
query.fields[profile-object-type] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile-object-type][] |
string | Optional | enum: ["id"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["current-schema","draft-schema","object-types","profile-object-types","schema-versions"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Object Type — klaviyo.delete_object_type
Delete the object type with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Object Schema — klaviyo.get_object_schema
Get the object schema with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object schema. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[object-schema] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-schema][] |
string | Optional | enum: ["description","id","properties","published_at","required","status","title","visibility"] |
|
query.fields[profile-object-schema] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile-object-schema][] |
string | Optional | enum: ["id"] |
|
query.fields[source-mapping] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[source-mapping][] |
string | Optional | enum: ["id","property_mappings","relationship_mappings"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["object-schemas","profile-object-schemas","source-mapping"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K61DKJ7EKJ0ES9VE456XF5JG"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Object Schema — klaviyo.update_object_schema
Update the object schema with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object schema. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[object-schema] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-schema][] |
string | Optional | enum: ["description","id","properties","published_at","required","status","title","visibility"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ObjectSchemaPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "01K61DKJ7EKJ0ES9VE456XF5JG"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "object-schema",
"id": "01K61DKJ7EKJ0ES9VE456XF5JG",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Object Record — klaviyo.get_object_record
Get the object record with the given compound ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The compound ID of the object record, formatted as object_type_id:::object_record_id | |
query |
object | Optional | additionalProperties: false |
|
query.fields[object-record] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-record][] |
string | Optional | enum: ["id","record_properties"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01JXKYCN9A5M3QPVR8T2WE4BLD:::sub-001"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Create Data Source Records — klaviyo.bulk_create_data_source_records
Create a bulk data source record import job to create a batch of records.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/DataSourceRecordBulkCreateJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "data-source-record-bulk-create-job",
"attributes": {
"data-source-records": {
"data": [
{
"type": "data-source-record",
"attributes": {
"record": {
"object_record": {
"subscription_id": "sub-001",
"service_plan": "Monthly Grooming",
"visits_per_month": 2,
"monthly_rate": 79.99,
"is_active": true,
"next_appointment": "2026-08-15T10:00:00Z",
"pet_id": "pet-001"
},
"relationships": {
"owners": [
{
"id": "sub-001",
"email": "[email protected]",
"phone": "+15550001000"
},
{
"id": "sub-001",
"email": "[email protected]",
"phone": "+15550001001"
}
]
}
}
}
}
]
}
},
"relationships": {
"data-source": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Data Source Record — klaviyo.create_data_source_record
Create a data source record import job to create a single record.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/DataSourceRecordCreateJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "data-source-record-create-job",
"attributes": {
"data-source-record": {
"data": {
"type": "data-source-record",
"attributes": {
"record": {
"object_record": {
"subscription_id": "sub-001",
"service_plan": "Monthly Grooming",
"visits_per_month": 2,
"monthly_rate": 79.99,
"is_active": true,
"next_appointment": "2026-08-15T10:00:00Z",
"pet_id": "pet-001"
},
"relationships": {
"owners": [
{
"id": "sub-001",
"email": "[email protected]",
"phone": "+15550001000"
},
{
"id": "sub-001",
"email": "[email protected]",
"phone": "+15550001001"
}
]
}
}
}
}
}
},
"relationships": {
"data-source": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Object Schema — klaviyo.create_object_schema
Create an object schema. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[object-schema] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-schema][] |
string | Optional | enum: ["description","id","properties","published_at","required","status","title","visibility"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ObjectSchemaCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "object-schema",
"attributes": {
"title": "Pet Care Subscription",
"properties": []
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Delete Object Records — klaviyo.bulk_delete_object_records
Delete a batch of object records.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ObjectRecordDeleteJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "object-record-bulk-delete-job",
"relationships": {
"object-records": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Records for Object Type — klaviyo.get_records_for_object_type
Get all object records for a given object type. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[object-record] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-record][] |
string | Optional | enum: ["id","record_properties"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Record IDs for Object Type — klaviyo.get_record_ids_for_object_type
Get all object records for a given object type. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
query |
object | Optional | additionalProperties: false |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Ingestion Logs for Object Type — klaviyo.get_ingestion_logs_for_object_type
Get the ingestion logs for a given object type.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[object-ingestion-log] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-ingestion-log][] |
string | Optional | enum: ["errors","event_type","id","status","summary","timestamp"] |
|
query.fields[object-record] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-record][] |
string | Optional | enum: ["id","record_properties"] |
|
query.fields[object-type] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-type][] |
string | Optional | enum: ["created_at","description","id","namespace","status","title","updated_at"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): record_id: equals (string) status: any, equals (allowed values: 'error', 'warning', 'info') event_type: any, equals (allowed values: 'validation_error') timestamp: greater-or-equal, less-than (date-time) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["object-record","object-type"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Ingestion Log IDs for Object Type — klaviyo.get_ingestion_log_ids_for_object_type
Get the ingestion logs for a given object type.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
query |
object | Optional | additionalProperties: false |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): record_id: equals (string) status: any, equals (allowed values: 'error', 'warning', 'info') event_type: any, equals (allowed values: 'validation_error') timestamp: greater-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Current Schema for Object Type — klaviyo.get_current_schema_for_object_type
Get current schema for an object type Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[object-schema] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-schema][] |
string | Optional | enum: ["description","id","properties","published_at","required","status","title","visibility"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Current Schema ID for Object Type — klaviyo.get_current_schema_id_for_object_type
Get current schema for an object type Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Draft Schema for Object Type — klaviyo.get_draft_schema_for_object_type
Get draft schema for an object type Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[object-schema] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-schema][] |
string | Optional | enum: ["description","id","properties","published_at","required","status","title","visibility"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Draft Schema ID for Object Type — klaviyo.get_draft_schema_id_for_object_type
Get draft schema for an object type Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Schema Versions for Object Type — klaviyo.get_schema_versions_for_object_type
Get all schema versions for an object type Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[object-schema] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[object-schema][] |
string | Optional | enum: ["description","id","properties","published_at","required","status","title","visibility"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Schema Version IDs for Object Type — klaviyo.get_schema_version_ids_for_object_type
Get all schema versions for an object type Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Object Type Relationships — klaviyo.get_object_type_relationships
Get related object types for an object type Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profile Type Relationships — klaviyo.get_profile_type_relationships
Get related profile object types for an object type Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object type. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Source Mapping for Object Schema — klaviyo.get_source_mapping_for_object_schema
Get source mapping for an object schema Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object schema. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[source-mapping] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[source-mapping][] |
string | Optional | enum: ["id","property_mappings","relationship_mappings"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K61DKJ7EKJ0ES9VE456XF5JG"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Source Mapping ID for Object Schema — klaviyo.get_source_mapping_id_for_object_schema
Get source mapping for an object schema Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object schema. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K61DKJ7EKJ0ES9VE456XF5JG"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Object Schema Relationships — klaviyo.get_object_schema_relationships
Get related object schemas for an object schema Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object schema. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K61DKJ7EKJ0ES9VE456XF5JG"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Object Schema Relationship — klaviyo.create_object_schema_relationship
Create a relationship between object schemas.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object schema. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ObjectSchemaRelationshipCreateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "01K61DKJ7EKJ0ES9VE456XF5JG"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Object Schema Relationship — klaviyo.update_object_schema_relationship
Update a relationship between object schemas Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object schema. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ObjectSchemaRelationshipPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "01K61DKJ7EKJ0ES9VE456XF5JG"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "object-schema",
"id": "01K5YKKQKM819VVGCPZZKGE6D4"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Object Schema Relationship — klaviyo.delete_object_schema_relationship
Delete a relationship between object schemas Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object schema. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ObjectSchemaRelationshipDeleteQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "01K61DKJ7EKJ0ES9VE456XF5JG"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profile Schema Relationships — klaviyo.get_profile_schema_relationships
Get related profile object schemas for an object schema Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object schema. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01K61DKJ7EKJ0ES9VE456XF5JG"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Profile Schema Relationship — klaviyo.create_profile_schema_relationship
Create a relationship between an object schema and a profile Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object schema. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ProfileObjectSchemaRelationshipCreateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "01K61DKJ7EKJ0ES9VE456XF5JG"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Profile Schema Relationship — klaviyo.update_profile_schema_relationship
Update a relationship between an object schema and a profile Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object schema. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ProfileObjectSchemaRelationshipPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "01K61DKJ7EKJ0ES9VE456XF5JG"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "profile-object-schema",
"id": "profile"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Profile Schema Relationship — klaviyo.delete_profile_schema_relationship
Delete a relationship between an object schema and a profile Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ULID ID of the object schema. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ProfileObjectSchemaRelationshipDeleteQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "01K61DKJ7EKJ0ES9VE456XF5JG"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Request Profile Deletion — klaviyo.request_profile_deletion
Request a deletion for the profiles corresponding to one of the following identifiers: email, phone_number, or id. If multiple identifiers are provided, we will return an error.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/DataPrivacyCreateDeletionJobQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "data-privacy-deletion-job",
"attributes": {
"profile": {
"data": {
"type": "profile",
"attributes": {}
}
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Events — klaviyo.get_events
Get all events in an account
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[attribution] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[attribution][] |
string | Optional | enum: ["id"] |
|
query.fields[event] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[event][] |
string | Optional | enum: ["datetime","event_properties","id","timestamp","uuid"] |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","properties","title","updated"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): metric_id: equals (string) profile_id: equals (string) profile: has metric: has properties.<key>: equals datetime: greater-or-equal, greater-than, less-or-equal, less-than (date-time) timestamp: greater-or-equal, greater-than, less-or-equal, less-than (number) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["attributions","metric","profile"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 200. Min: 1. Max: 1000. | default: 200; minimum: 1; maximum: 1000 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["datetime","-datetime","timestamp","-timestamp"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Event — klaviyo.create_event
Create a new event to track a profile's activity.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/EventCreateQueryV2" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "event",
"attributes": {
"properties": {
"Brand": "Kids Book",
"ProductID": 1111,
"ProductName": "Winnie the Pooh"
},
"metric": {
"data": {
"type": "metric",
"attributes": {
"name": "Viewed Product"
}
}
},
"profile": {
"data": {
"type": "profile",
"attributes": {}
}
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Event — klaviyo.get_event
Get an event with the given event ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the event | |
query |
object | Optional | additionalProperties: false |
|
query.fields[attribution] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[attribution][] |
string | Optional | enum: ["id"] |
|
query.fields[event] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[event][] |
string | Optional | enum: ["datetime","event_properties","id","timestamp","uuid"] |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","properties","title","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["attributions","metric","profile"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Create Events — klaviyo.bulk_create_events
Create a batch of events for one or more profiles.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/EventsBulkCreateJob" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "event-bulk-create-job",
"attributes": {
"events-bulk-create": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Metric for Event — klaviyo.get_metric_for_event
Get the metric for an event with the given event ID. Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the event | |
query |
object | Optional | additionalProperties: false |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Metric ID for Event — klaviyo.get_metric_id_for_event
Get a list of related Metrics for an Event Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the event | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profile for Event — klaviyo.get_profile_for_event
Get the profile associated with an event with the given event ID. Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the event | |
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[profile] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | |
query.additional-fields[profile][] |
string | Optional | enum: ["subscriptions","predictive_analytics"] |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","predictive_analytics","predictive_analytics.average_days_between_orders","predictive_analytics.average_order_value","predictive_analytics.churn_probability","predictive_analytics.expected_date_of_next_order","predictive_analytics.historic_clv","predictive_analytics.historic_number_of_orders","predictive_analytics.predicted_clv","predictive_analytics.predicted_number_of_orders","predictive_analytics.ranked_channel_affinity","predictive_analytics.total_clv","properties","subscriptions","subscriptions.email","subscriptions.email.click_tracking","subscriptions.email.click_tracking.can_receive","subscriptions.email.click_tracking.consent","subscriptions.email.click_tracking.consent_timestamp","subscriptions.email.click_tracking.created_timestamp","subscriptions.email.click_tracking.last_updated","subscriptions.email.click_tracking.metadata","subscriptions.email.click_tracking.valid_until","subscriptions.email.marketing","subscriptions.email.marketing.can_receive_email_marketing","subscriptions.email.marketing.consent","subscriptions.email.marketing.consent_timestamp","subscriptions.email.marketing.custom_method_detail","subscriptions.email.marketing.double_optin","subscriptions.email.marketing.last_updated","subscriptions.email.marketing.list_suppressions","subscriptions.email.marketing.method","subscriptions.email.marketing.method_detail","subscriptions.email.marketing.suppression","subscriptions.email.open_tracking","subscriptions.email.open_tracking.can_receive","subscriptions.email.open_tracking.consent","subscriptions.email.open_tracking.consent_timestamp","subscriptions.email.open_tracking.created_timestamp","subscriptions.email.open_tracking.last_updated","subscriptions.email.open_tracking.metadata","subscriptions.email.open_tracking.valid_until","subscriptions.mobile_push","subscriptions.mobile_push.marketing","subscriptions.mobile_push.marketing.can_receive_push_marketing","subscriptions.mobile_push.marketing.consent","subscriptions.mobile_push.marketing.consent_timestamp","subscriptions.sms","subscriptions.sms.marketing","subscriptions.sms.marketing.can_receive_sms_marketing","subscriptions.sms.marketing.consent","subscriptions.sms.marketing.consent_timestamp","subscriptions.sms.marketing.last_updated","subscriptions.sms.marketing.method","subscriptions.sms.marketing.method_detail","subscriptions.sms.transactional","subscriptions.sms.transactional.can_receive_sms_transactional","subscriptions.sms.transactional.consent","subscriptions.sms.transactional.consent_timestamp","subscriptions.sms.transactional.last_updated","subscriptions.sms.transactional.method","subscriptions.sms.transactional.method_detail","subscriptions.whatsapp","subscriptions.whatsapp.conversational","subscriptions.whatsapp.conversational.can_receive","subscriptions.whatsapp.conversational.consent","subscriptions.whatsapp.conversational.consent_timestamp","subscriptions.whatsapp.conversational.created_timestamp","subscriptions.whatsapp.conversational.last_updated","subscriptions.whatsapp.conversational.metadata","subscriptions.whatsapp.conversational.phone_number","subscriptions.whatsapp.conversational.valid_until","subscriptions.whatsapp.marketing","subscriptions.whatsapp.marketing.can_receive","subscriptions.whatsapp.marketing.consent","subscriptions.whatsapp.marketing.consent_timestamp","subscriptions.whatsapp.marketing.created_timestamp","subscriptions.whatsapp.marketing.last_updated","subscriptions.whatsapp.marketing.metadata","subscriptions.whatsapp.marketing.phone_number","subscriptions.whatsapp.marketing.valid_until","subscriptions.whatsapp.transactional","subscriptions.whatsapp.transactional.can_receive","subscriptions.whatsapp.transactional.consent","subscriptions.whatsapp.transactional.consent_timestamp","subscriptions.whatsapp.transactional.created_timestamp","subscriptions.whatsapp.transactional.last_updated","subscriptions.whatsapp.transactional.metadata","subscriptions.whatsapp.transactional.phone_number","subscriptions.whatsapp.transactional.valid_until","title","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profile ID for Event — klaviyo.get_profile_id_for_event
Get profile relationships for an event with the given event ID. Rate limits: Burst: 350/s Steady: 3500/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the event | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Flows — klaviyo.get_flows
Get all flows in an account.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[flow-action] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-action][] |
string | Optional | enum: ["created","definition","definition.data","definition.data.action_output_filter","definition.data.action_output_filter.condition_groups","definition.data.branches","definition.data.concluded_experiment_id","definition.data.current_experiment","definition.data.current_experiment.allocations","definition.data.current_experiment.automatic_winner_selection_settings","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty","definition.data.current_experiment.automatic_winner_selection_settings.enabled","definition.data.current_experiment.id","definition.data.current_experiment.name","definition.data.current_experiment.started","definition.data.current_experiment.variations","definition.data.current_experiment.winner_metric","definition.data.delay_until_time","definition.data.delay_until_weekdays","definition.data.experiment_status","definition.data.list_id","definition.data.main_action","definition.data.main_action.data","definition.data.main_action.data.message","definition.data.main_action.data.message.action_buttons","definition.data.main_action.data.message.add_info_link","definition.data.main_action.data.message.add_opt_out_language","definition.data.main_action.data.message.add_org_prefix","definition.data.main_action.data.message.add_tracking_params","definition.data.main_action.data.message.additional_filters","definition.data.main_action.data.message.additional_filters.condition_groups","definition.data.main_action.data.message.android_link","definition.data.main_action.data.message.automation_id","definition.data.main_action.data.message.badge","definition.data.main_action.data.message.badge_options","definition.data.main_action.data.message.badge_options.badge_config","definition.data.main_action.data.message.badge_options.set_from_property","definition.data.main_action.data.message.badge_options.value","definition.data.main_action.data.message.bcc_email","definition.data.main_action.data.message.body","definition.data.main_action.data.message.cc_email","definition.data.main_action.data.message.conversion_metric_id","definition.data.main_action.data.message.custom_tracking_params","definition.data.main_action.data.message.dynamic_image","definition.data.main_action.data.message.expiry_hours","definition.data.main_action.data.message.from_email","definition.data.main_action.data.message.from_label","definition.data.main_action.data.message.id","definition.data.main_action.data.message.image_id","definition.data.main_action.data.message.include_contact_card","definition.data.main_action.data.message.ios_link","definition.data.main_action.data.message.kv_pairs","definition.data.main_action.data.message.message_hierarchy","definition.data.main_action.data.message.name","definition.data.main_action.data.message.on_open","definition.data.main_action.data.message.preview_text","definition.data.main_action.data.message.push_type","definition.data.main_action.data.message.reply_to_email","definition.data.main_action.data.message.shorten_links","definition.data.main_action.data.message.smart_sending_enabled","definition.data.main_action.data.message.sms_quiet_hours_enabled","definition.data.main_action.data.message.sound","definition.data.main_action.data.message.subject_line","definition.data.main_action.data.message.template_id","definition.data.main_action.data.message.title","definition.data.main_action.data.message.transactional","definition.data.main_action.data.message.vendor_id","definition.data.main_action.data.message.video_asset_id","definition.data.main_action.data.message.web_url","definition.data.main_action.data.status","definition.data.main_action.id","definition.data.main_action.links","definition.data.main_action.links.next","definition.data.main_action.temporary_id","definition.data.main_action.type","definition.data.message","definition.data.message.action_buttons","definition.data.message.add_info_link","definition.data.message.add_opt_out_language","definition.data.message.add_org_prefix","definition.data.message.add_tracking_params","definition.data.message.additional_filters","definition.data.message.additional_filters.condition_groups","definition.data.message.android_link","definition.data.message.automation_id","definition.data.message.badge","definition.data.message.badge_options","definition.data.message.badge_options.badge_config","definition.data.message.badge_options.set_from_property","definition.data.message.badge_options.value","definition.data.message.bcc_email","definition.data.message.body","definition.data.message.cc_email","definition.data.message.conversion_metric_id","definition.data.message.custom_tracking_params","definition.data.message.dynamic_image","definition.data.message.expiry_hours","definition.data.message.from_email","definition.data.message.from_label","definition.data.message.headers","definition.data.message.id","definition.data.message.image_id","definition.data.message.include_contact_card","definition.data.message.ios_link","definition.data.message.kv_pairs","definition.data.message.message_hierarchy","definition.data.message.name","definition.data.message.on_open","definition.data.message.preview_text","definition.data.message.push_type","definition.data.message.reply_to_email","definition.data.message.shorten_links","definition.data.message.smart_sending_enabled","definition.data.message.sms_quiet_hours_enabled","definition.data.message.sound","definition.data.message.subject_line","definition.data.message.template_id","definition.data.message.title","definition.data.message.to_emails","definition.data.message.transactional","definition.data.message.url","definition.data.message.vendor_id","definition.data.message.video_asset_id","definition.data.message.web_url","definition.data.name","definition.data.on_execution","definition.data.profile_filter","definition.data.profile_filter.condition_groups","definition.data.profile_operations","definition.data.secondary_value","definition.data.service_configuration","definition.data.service_configuration.event_key","definition.data.service_configuration.event_payload","definition.data.service_configuration.report_id","definition.data.service_configuration.service_method_type","definition.data.service_configuration.tracking_company_id","definition.data.status","definition.data.target_days","definition.data.target_time","definition.data.timezone","definition.data.trigger_filter","definition.data.trigger_filter.condition_groups","definition.data.trigger_id","definition.data.trigger_subtype","definition.data.trigger_type","definition.data.unit","definition.data.value","definition.data.winning_variation_id","definition.id","definition.links","definition.links.next","definition.links.next_if_false","definition.links.next_if_true","definition.temporary_id","definition.type","id","updated"] |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
query.fields[tag] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag][] |
string | Optional | enum: ["id","name"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any (string) name: contains, ends-with, equals, starts-with (string) status: equals (string) archived: equals (boolean) created: equals, greater-or-equal, greater-than, less-or-equal, less-than (date-time) updated: equals, greater-or-equal, greater-than, less-or-equal, less-than (date-time) trigger_type: equals (allowed values: 'Metric', 'Added to List', 'Unconfigured', 'Date Based', 'Price Drop', 'Low Inventory') |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["flow-actions","tags"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 50. Min: 1. Max: 50. | default: 50; minimum: 1; maximum: 50 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created","id","-id","name","-name","status","-status","trigger_type","-trigger_type","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Flow — klaviyo.create_flow
Create a new flow using an encoded flow definition.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[flow] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'definition' | |
query.additional-fields[flow][] |
string | Optional | enum: ["definition"] |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","definition","definition.actions","definition.entry_action_id","definition.profile_filter","definition.profile_filter.condition_groups","definition.reentry_criteria","definition.reentry_criteria.duration","definition.reentry_criteria.unit","definition.triggers","id","name","status","trigger_type","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/FlowCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "flow",
"attributes": {
"name": "Welcome Flow",
"definition": {
"triggers": [],
"actions": [],
"entry_action_id": "123"
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Flow — klaviyo.get_flow
Get a flow with the given flow ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[flow] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'definition' | |
query.additional-fields[flow][] |
string | Optional | enum: ["definition"] |
|
query.fields[flow-action] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-action][] |
string | Optional | enum: ["created","definition","definition.data","definition.data.action_output_filter","definition.data.action_output_filter.condition_groups","definition.data.branches","definition.data.concluded_experiment_id","definition.data.current_experiment","definition.data.current_experiment.allocations","definition.data.current_experiment.automatic_winner_selection_settings","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty","definition.data.current_experiment.automatic_winner_selection_settings.enabled","definition.data.current_experiment.id","definition.data.current_experiment.name","definition.data.current_experiment.started","definition.data.current_experiment.variations","definition.data.current_experiment.winner_metric","definition.data.delay_until_time","definition.data.delay_until_weekdays","definition.data.experiment_status","definition.data.list_id","definition.data.main_action","definition.data.main_action.data","definition.data.main_action.data.message","definition.data.main_action.data.message.action_buttons","definition.data.main_action.data.message.add_info_link","definition.data.main_action.data.message.add_opt_out_language","definition.data.main_action.data.message.add_org_prefix","definition.data.main_action.data.message.add_tracking_params","definition.data.main_action.data.message.additional_filters","definition.data.main_action.data.message.additional_filters.condition_groups","definition.data.main_action.data.message.android_link","definition.data.main_action.data.message.automation_id","definition.data.main_action.data.message.badge","definition.data.main_action.data.message.badge_options","definition.data.main_action.data.message.badge_options.badge_config","definition.data.main_action.data.message.badge_options.set_from_property","definition.data.main_action.data.message.badge_options.value","definition.data.main_action.data.message.bcc_email","definition.data.main_action.data.message.body","definition.data.main_action.data.message.cc_email","definition.data.main_action.data.message.conversion_metric_id","definition.data.main_action.data.message.custom_tracking_params","definition.data.main_action.data.message.dynamic_image","definition.data.main_action.data.message.expiry_hours","definition.data.main_action.data.message.from_email","definition.data.main_action.data.message.from_label","definition.data.main_action.data.message.id","definition.data.main_action.data.message.image_id","definition.data.main_action.data.message.include_contact_card","definition.data.main_action.data.message.ios_link","definition.data.main_action.data.message.kv_pairs","definition.data.main_action.data.message.message_hierarchy","definition.data.main_action.data.message.name","definition.data.main_action.data.message.on_open","definition.data.main_action.data.message.preview_text","definition.data.main_action.data.message.push_type","definition.data.main_action.data.message.reply_to_email","definition.data.main_action.data.message.shorten_links","definition.data.main_action.data.message.smart_sending_enabled","definition.data.main_action.data.message.sms_quiet_hours_enabled","definition.data.main_action.data.message.sound","definition.data.main_action.data.message.subject_line","definition.data.main_action.data.message.template_id","definition.data.main_action.data.message.title","definition.data.main_action.data.message.transactional","definition.data.main_action.data.message.vendor_id","definition.data.main_action.data.message.video_asset_id","definition.data.main_action.data.message.web_url","definition.data.main_action.data.status","definition.data.main_action.id","definition.data.main_action.links","definition.data.main_action.links.next","definition.data.main_action.temporary_id","definition.data.main_action.type","definition.data.message","definition.data.message.action_buttons","definition.data.message.add_info_link","definition.data.message.add_opt_out_language","definition.data.message.add_org_prefix","definition.data.message.add_tracking_params","definition.data.message.additional_filters","definition.data.message.additional_filters.condition_groups","definition.data.message.android_link","definition.data.message.automation_id","definition.data.message.badge","definition.data.message.badge_options","definition.data.message.badge_options.badge_config","definition.data.message.badge_options.set_from_property","definition.data.message.badge_options.value","definition.data.message.bcc_email","definition.data.message.body","definition.data.message.cc_email","definition.data.message.conversion_metric_id","definition.data.message.custom_tracking_params","definition.data.message.dynamic_image","definition.data.message.expiry_hours","definition.data.message.from_email","definition.data.message.from_label","definition.data.message.headers","definition.data.message.id","definition.data.message.image_id","definition.data.message.include_contact_card","definition.data.message.ios_link","definition.data.message.kv_pairs","definition.data.message.message_hierarchy","definition.data.message.name","definition.data.message.on_open","definition.data.message.preview_text","definition.data.message.push_type","definition.data.message.reply_to_email","definition.data.message.shorten_links","definition.data.message.smart_sending_enabled","definition.data.message.sms_quiet_hours_enabled","definition.data.message.sound","definition.data.message.subject_line","definition.data.message.template_id","definition.data.message.title","definition.data.message.to_emails","definition.data.message.transactional","definition.data.message.url","definition.data.message.vendor_id","definition.data.message.video_asset_id","definition.data.message.web_url","definition.data.name","definition.data.on_execution","definition.data.profile_filter","definition.data.profile_filter.condition_groups","definition.data.profile_operations","definition.data.secondary_value","definition.data.service_configuration","definition.data.service_configuration.event_key","definition.data.service_configuration.event_payload","definition.data.service_configuration.report_id","definition.data.service_configuration.service_method_type","definition.data.service_configuration.tracking_company_id","definition.data.status","definition.data.target_days","definition.data.target_time","definition.data.timezone","definition.data.trigger_filter","definition.data.trigger_filter.condition_groups","definition.data.trigger_id","definition.data.trigger_subtype","definition.data.trigger_type","definition.data.unit","definition.data.value","definition.data.winning_variation_id","definition.id","definition.links","definition.links.next","definition.links.next_if_false","definition.links.next_if_true","definition.temporary_id","definition.type","id","updated"] |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","definition","definition.actions","definition.entry_action_id","definition.profile_filter","definition.profile_filter.condition_groups","definition.reentry_criteria","definition.reentry_criteria.duration","definition.reentry_criteria.unit","definition.triggers","id","name","status","trigger_type","updated"] |
|
query.fields[tag] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag][] |
string | Optional | enum: ["id","name"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["flow-actions","tags"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Flow Status — klaviyo.update_flow
Update the status of a flow with the given flow ID, and all actions in that flow. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the Flow to update. Ex: XVTP5Q | |
query |
object | Optional | additionalProperties: false |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/FlowUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "flow",
"id": "example",
"attributes": {
"status": "example"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Flow — klaviyo.delete_flow
Delete a flow with the given flow ID. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the Flow to delete. Ex: XVTP5Q | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Flow Action — klaviyo.get_flow_action
Get a flow action from a flow with the given flow action ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[flow-action] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-action][] |
string | Optional | enum: ["created","definition","definition.data","definition.data.action_output_filter","definition.data.action_output_filter.condition_groups","definition.data.branches","definition.data.concluded_experiment_id","definition.data.current_experiment","definition.data.current_experiment.allocations","definition.data.current_experiment.automatic_winner_selection_settings","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty","definition.data.current_experiment.automatic_winner_selection_settings.enabled","definition.data.current_experiment.id","definition.data.current_experiment.name","definition.data.current_experiment.started","definition.data.current_experiment.variations","definition.data.current_experiment.winner_metric","definition.data.delay_until_time","definition.data.delay_until_weekdays","definition.data.experiment_status","definition.data.list_id","definition.data.main_action","definition.data.main_action.data","definition.data.main_action.data.message","definition.data.main_action.data.message.action_buttons","definition.data.main_action.data.message.add_info_link","definition.data.main_action.data.message.add_opt_out_language","definition.data.main_action.data.message.add_org_prefix","definition.data.main_action.data.message.add_tracking_params","definition.data.main_action.data.message.additional_filters","definition.data.main_action.data.message.additional_filters.condition_groups","definition.data.main_action.data.message.android_link","definition.data.main_action.data.message.automation_id","definition.data.main_action.data.message.badge","definition.data.main_action.data.message.badge_options","definition.data.main_action.data.message.badge_options.badge_config","definition.data.main_action.data.message.badge_options.set_from_property","definition.data.main_action.data.message.badge_options.value","definition.data.main_action.data.message.bcc_email","definition.data.main_action.data.message.body","definition.data.main_action.data.message.cc_email","definition.data.main_action.data.message.conversion_metric_id","definition.data.main_action.data.message.custom_tracking_params","definition.data.main_action.data.message.dynamic_image","definition.data.main_action.data.message.expiry_hours","definition.data.main_action.data.message.from_email","definition.data.main_action.data.message.from_label","definition.data.main_action.data.message.id","definition.data.main_action.data.message.image_id","definition.data.main_action.data.message.include_contact_card","definition.data.main_action.data.message.ios_link","definition.data.main_action.data.message.kv_pairs","definition.data.main_action.data.message.message_hierarchy","definition.data.main_action.data.message.name","definition.data.main_action.data.message.on_open","definition.data.main_action.data.message.preview_text","definition.data.main_action.data.message.push_type","definition.data.main_action.data.message.reply_to_email","definition.data.main_action.data.message.shorten_links","definition.data.main_action.data.message.smart_sending_enabled","definition.data.main_action.data.message.sms_quiet_hours_enabled","definition.data.main_action.data.message.sound","definition.data.main_action.data.message.subject_line","definition.data.main_action.data.message.template_id","definition.data.main_action.data.message.title","definition.data.main_action.data.message.transactional","definition.data.main_action.data.message.vendor_id","definition.data.main_action.data.message.video_asset_id","definition.data.main_action.data.message.web_url","definition.data.main_action.data.status","definition.data.main_action.id","definition.data.main_action.links","definition.data.main_action.links.next","definition.data.main_action.temporary_id","definition.data.main_action.type","definition.data.message","definition.data.message.action_buttons","definition.data.message.add_info_link","definition.data.message.add_opt_out_language","definition.data.message.add_org_prefix","definition.data.message.add_tracking_params","definition.data.message.additional_filters","definition.data.message.additional_filters.condition_groups","definition.data.message.android_link","definition.data.message.automation_id","definition.data.message.badge","definition.data.message.badge_options","definition.data.message.badge_options.badge_config","definition.data.message.badge_options.set_from_property","definition.data.message.badge_options.value","definition.data.message.bcc_email","definition.data.message.body","definition.data.message.cc_email","definition.data.message.conversion_metric_id","definition.data.message.custom_tracking_params","definition.data.message.dynamic_image","definition.data.message.expiry_hours","definition.data.message.from_email","definition.data.message.from_label","definition.data.message.headers","definition.data.message.id","definition.data.message.image_id","definition.data.message.include_contact_card","definition.data.message.ios_link","definition.data.message.kv_pairs","definition.data.message.message_hierarchy","definition.data.message.name","definition.data.message.on_open","definition.data.message.preview_text","definition.data.message.push_type","definition.data.message.reply_to_email","definition.data.message.shorten_links","definition.data.message.smart_sending_enabled","definition.data.message.sms_quiet_hours_enabled","definition.data.message.sound","definition.data.message.subject_line","definition.data.message.template_id","definition.data.message.title","definition.data.message.to_emails","definition.data.message.transactional","definition.data.message.url","definition.data.message.vendor_id","definition.data.message.video_asset_id","definition.data.message.web_url","definition.data.name","definition.data.on_execution","definition.data.profile_filter","definition.data.profile_filter.condition_groups","definition.data.profile_operations","definition.data.secondary_value","definition.data.service_configuration","definition.data.service_configuration.event_key","definition.data.service_configuration.event_payload","definition.data.service_configuration.report_id","definition.data.service_configuration.service_method_type","definition.data.service_configuration.tracking_company_id","definition.data.status","definition.data.target_days","definition.data.target_time","definition.data.timezone","definition.data.trigger_filter","definition.data.trigger_filter.condition_groups","definition.data.trigger_id","definition.data.trigger_subtype","definition.data.trigger_type","definition.data.unit","definition.data.value","definition.data.winning_variation_id","definition.id","definition.links","definition.links.next","definition.links.next_if_false","definition.links.next_if_true","definition.temporary_id","definition.type","id","updated"] |
|
query.fields[flow-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-message][] |
string | Optional | enum: ["channel","created","definition","definition.action_buttons","definition.add_info_link","definition.add_opt_out_language","definition.add_org_prefix","definition.add_tracking_params","definition.additional_filters","definition.additional_filters.condition_groups","definition.android_link","definition.automation_id","definition.badge","definition.badge_options","definition.badge_options.badge_config","definition.badge_options.set_from_property","definition.badge_options.value","definition.bcc_email","definition.body","definition.cc_email","definition.conversion_metric_id","definition.custom_tracking_params","definition.dynamic_image","definition.expiry_hours","definition.from_email","definition.from_label","definition.headers","definition.id","definition.image_id","definition.include_contact_card","definition.ios_link","definition.kv_pairs","definition.message_hierarchy","definition.name","definition.on_open","definition.preview_text","definition.push_type","definition.reply_to_email","definition.shorten_links","definition.smart_sending_enabled","definition.sms_quiet_hours_enabled","definition.sound","definition.subject_line","definition.template_id","definition.title","definition.to_emails","definition.transactional","definition.url","definition.vendor_id","definition.video_asset_id","definition.web_url","id","updated"] |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["flow","flow-messages"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Flow Action — klaviyo.update_flow_action
Update a flow action. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[flow-action] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-action][] |
string | Optional | enum: ["created","definition","definition.data","definition.data.action_output_filter","definition.data.action_output_filter.condition_groups","definition.data.branches","definition.data.concluded_experiment_id","definition.data.current_experiment","definition.data.current_experiment.allocations","definition.data.current_experiment.automatic_winner_selection_settings","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty","definition.data.current_experiment.automatic_winner_selection_settings.enabled","definition.data.current_experiment.id","definition.data.current_experiment.name","definition.data.current_experiment.started","definition.data.current_experiment.variations","definition.data.current_experiment.winner_metric","definition.data.delay_until_time","definition.data.delay_until_weekdays","definition.data.experiment_status","definition.data.list_id","definition.data.main_action","definition.data.main_action.data","definition.data.main_action.data.message","definition.data.main_action.data.message.action_buttons","definition.data.main_action.data.message.add_info_link","definition.data.main_action.data.message.add_opt_out_language","definition.data.main_action.data.message.add_org_prefix","definition.data.main_action.data.message.add_tracking_params","definition.data.main_action.data.message.additional_filters","definition.data.main_action.data.message.additional_filters.condition_groups","definition.data.main_action.data.message.android_link","definition.data.main_action.data.message.automation_id","definition.data.main_action.data.message.badge","definition.data.main_action.data.message.badge_options","definition.data.main_action.data.message.badge_options.badge_config","definition.data.main_action.data.message.badge_options.set_from_property","definition.data.main_action.data.message.badge_options.value","definition.data.main_action.data.message.bcc_email","definition.data.main_action.data.message.body","definition.data.main_action.data.message.cc_email","definition.data.main_action.data.message.conversion_metric_id","definition.data.main_action.data.message.custom_tracking_params","definition.data.main_action.data.message.dynamic_image","definition.data.main_action.data.message.expiry_hours","definition.data.main_action.data.message.from_email","definition.data.main_action.data.message.from_label","definition.data.main_action.data.message.id","definition.data.main_action.data.message.image_id","definition.data.main_action.data.message.include_contact_card","definition.data.main_action.data.message.ios_link","definition.data.main_action.data.message.kv_pairs","definition.data.main_action.data.message.message_hierarchy","definition.data.main_action.data.message.name","definition.data.main_action.data.message.on_open","definition.data.main_action.data.message.preview_text","definition.data.main_action.data.message.push_type","definition.data.main_action.data.message.reply_to_email","definition.data.main_action.data.message.shorten_links","definition.data.main_action.data.message.smart_sending_enabled","definition.data.main_action.data.message.sms_quiet_hours_enabled","definition.data.main_action.data.message.sound","definition.data.main_action.data.message.subject_line","definition.data.main_action.data.message.template_id","definition.data.main_action.data.message.title","definition.data.main_action.data.message.transactional","definition.data.main_action.data.message.vendor_id","definition.data.main_action.data.message.video_asset_id","definition.data.main_action.data.message.web_url","definition.data.main_action.data.status","definition.data.main_action.id","definition.data.main_action.links","definition.data.main_action.links.next","definition.data.main_action.temporary_id","definition.data.main_action.type","definition.data.message","definition.data.message.action_buttons","definition.data.message.add_info_link","definition.data.message.add_opt_out_language","definition.data.message.add_org_prefix","definition.data.message.add_tracking_params","definition.data.message.additional_filters","definition.data.message.additional_filters.condition_groups","definition.data.message.android_link","definition.data.message.automation_id","definition.data.message.badge","definition.data.message.badge_options","definition.data.message.badge_options.badge_config","definition.data.message.badge_options.set_from_property","definition.data.message.badge_options.value","definition.data.message.bcc_email","definition.data.message.body","definition.data.message.cc_email","definition.data.message.conversion_metric_id","definition.data.message.custom_tracking_params","definition.data.message.dynamic_image","definition.data.message.expiry_hours","definition.data.message.from_email","definition.data.message.from_label","definition.data.message.headers","definition.data.message.id","definition.data.message.image_id","definition.data.message.include_contact_card","definition.data.message.ios_link","definition.data.message.kv_pairs","definition.data.message.message_hierarchy","definition.data.message.name","definition.data.message.on_open","definition.data.message.preview_text","definition.data.message.push_type","definition.data.message.reply_to_email","definition.data.message.shorten_links","definition.data.message.smart_sending_enabled","definition.data.message.sms_quiet_hours_enabled","definition.data.message.sound","definition.data.message.subject_line","definition.data.message.template_id","definition.data.message.title","definition.data.message.to_emails","definition.data.message.transactional","definition.data.message.url","definition.data.message.vendor_id","definition.data.message.video_asset_id","definition.data.message.web_url","definition.data.name","definition.data.on_execution","definition.data.profile_filter","definition.data.profile_filter.condition_groups","definition.data.profile_operations","definition.data.secondary_value","definition.data.service_configuration","definition.data.service_configuration.event_key","definition.data.service_configuration.event_payload","definition.data.service_configuration.report_id","definition.data.service_configuration.service_method_type","definition.data.service_configuration.tracking_company_id","definition.data.status","definition.data.target_days","definition.data.target_time","definition.data.timezone","definition.data.trigger_filter","definition.data.trigger_filter.condition_groups","definition.data.trigger_id","definition.data.trigger_subtype","definition.data.trigger_type","definition.data.unit","definition.data.value","definition.data.winning_variation_id","definition.id","definition.links","definition.links.next","definition.links.next_if_false","definition.links.next_if_true","definition.temporary_id","definition.type","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/FlowActionUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "flow-action",
"id": "example",
"attributes": {
"definition": {
"type": "action-output-split"
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Flow Action — klaviyo.delete_flow_action
Delete a flow action. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the flow action to delete. Ex: 01GDDKASAP8TKDDA2GRZDSVP4H | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Flow Message — klaviyo.get_flow_message
Get a flow message from a flow with the given flow message ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[flow-action] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-action][] |
string | Optional | enum: ["created","definition","definition.data","definition.data.action_output_filter","definition.data.action_output_filter.condition_groups","definition.data.branches","definition.data.concluded_experiment_id","definition.data.current_experiment","definition.data.current_experiment.allocations","definition.data.current_experiment.automatic_winner_selection_settings","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty","definition.data.current_experiment.automatic_winner_selection_settings.enabled","definition.data.current_experiment.id","definition.data.current_experiment.name","definition.data.current_experiment.started","definition.data.current_experiment.variations","definition.data.current_experiment.winner_metric","definition.data.delay_until_time","definition.data.delay_until_weekdays","definition.data.experiment_status","definition.data.list_id","definition.data.main_action","definition.data.main_action.data","definition.data.main_action.data.message","definition.data.main_action.data.message.action_buttons","definition.data.main_action.data.message.add_info_link","definition.data.main_action.data.message.add_opt_out_language","definition.data.main_action.data.message.add_org_prefix","definition.data.main_action.data.message.add_tracking_params","definition.data.main_action.data.message.additional_filters","definition.data.main_action.data.message.additional_filters.condition_groups","definition.data.main_action.data.message.android_link","definition.data.main_action.data.message.automation_id","definition.data.main_action.data.message.badge","definition.data.main_action.data.message.badge_options","definition.data.main_action.data.message.badge_options.badge_config","definition.data.main_action.data.message.badge_options.set_from_property","definition.data.main_action.data.message.badge_options.value","definition.data.main_action.data.message.bcc_email","definition.data.main_action.data.message.body","definition.data.main_action.data.message.cc_email","definition.data.main_action.data.message.conversion_metric_id","definition.data.main_action.data.message.custom_tracking_params","definition.data.main_action.data.message.dynamic_image","definition.data.main_action.data.message.expiry_hours","definition.data.main_action.data.message.from_email","definition.data.main_action.data.message.from_label","definition.data.main_action.data.message.id","definition.data.main_action.data.message.image_id","definition.data.main_action.data.message.include_contact_card","definition.data.main_action.data.message.ios_link","definition.data.main_action.data.message.kv_pairs","definition.data.main_action.data.message.message_hierarchy","definition.data.main_action.data.message.name","definition.data.main_action.data.message.on_open","definition.data.main_action.data.message.preview_text","definition.data.main_action.data.message.push_type","definition.data.main_action.data.message.reply_to_email","definition.data.main_action.data.message.shorten_links","definition.data.main_action.data.message.smart_sending_enabled","definition.data.main_action.data.message.sms_quiet_hours_enabled","definition.data.main_action.data.message.sound","definition.data.main_action.data.message.subject_line","definition.data.main_action.data.message.template_id","definition.data.main_action.data.message.title","definition.data.main_action.data.message.transactional","definition.data.main_action.data.message.vendor_id","definition.data.main_action.data.message.video_asset_id","definition.data.main_action.data.message.web_url","definition.data.main_action.data.status","definition.data.main_action.id","definition.data.main_action.links","definition.data.main_action.links.next","definition.data.main_action.temporary_id","definition.data.main_action.type","definition.data.message","definition.data.message.action_buttons","definition.data.message.add_info_link","definition.data.message.add_opt_out_language","definition.data.message.add_org_prefix","definition.data.message.add_tracking_params","definition.data.message.additional_filters","definition.data.message.additional_filters.condition_groups","definition.data.message.android_link","definition.data.message.automation_id","definition.data.message.badge","definition.data.message.badge_options","definition.data.message.badge_options.badge_config","definition.data.message.badge_options.set_from_property","definition.data.message.badge_options.value","definition.data.message.bcc_email","definition.data.message.body","definition.data.message.cc_email","definition.data.message.conversion_metric_id","definition.data.message.custom_tracking_params","definition.data.message.dynamic_image","definition.data.message.expiry_hours","definition.data.message.from_email","definition.data.message.from_label","definition.data.message.headers","definition.data.message.id","definition.data.message.image_id","definition.data.message.include_contact_card","definition.data.message.ios_link","definition.data.message.kv_pairs","definition.data.message.message_hierarchy","definition.data.message.name","definition.data.message.on_open","definition.data.message.preview_text","definition.data.message.push_type","definition.data.message.reply_to_email","definition.data.message.shorten_links","definition.data.message.smart_sending_enabled","definition.data.message.sms_quiet_hours_enabled","definition.data.message.sound","definition.data.message.subject_line","definition.data.message.template_id","definition.data.message.title","definition.data.message.to_emails","definition.data.message.transactional","definition.data.message.url","definition.data.message.vendor_id","definition.data.message.video_asset_id","definition.data.message.web_url","definition.data.name","definition.data.on_execution","definition.data.profile_filter","definition.data.profile_filter.condition_groups","definition.data.profile_operations","definition.data.secondary_value","definition.data.service_configuration","definition.data.service_configuration.event_key","definition.data.service_configuration.event_payload","definition.data.service_configuration.report_id","definition.data.service_configuration.service_method_type","definition.data.service_configuration.tracking_company_id","definition.data.status","definition.data.target_days","definition.data.target_time","definition.data.timezone","definition.data.trigger_filter","definition.data.trigger_filter.condition_groups","definition.data.trigger_id","definition.data.trigger_subtype","definition.data.trigger_type","definition.data.unit","definition.data.value","definition.data.winning_variation_id","definition.id","definition.links","definition.links.next","definition.links.next_if_false","definition.links.next_if_true","definition.temporary_id","definition.type","id","updated"] |
|
query.fields[flow-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-message][] |
string | Optional | enum: ["channel","created","definition","definition.action_buttons","definition.add_info_link","definition.add_opt_out_language","definition.add_org_prefix","definition.add_tracking_params","definition.additional_filters","definition.additional_filters.condition_groups","definition.android_link","definition.automation_id","definition.badge","definition.badge_options","definition.badge_options.badge_config","definition.badge_options.set_from_property","definition.badge_options.value","definition.bcc_email","definition.body","definition.cc_email","definition.conversion_metric_id","definition.custom_tracking_params","definition.dynamic_image","definition.expiry_hours","definition.from_email","definition.from_label","definition.headers","definition.id","definition.image_id","definition.include_contact_card","definition.ios_link","definition.kv_pairs","definition.message_hierarchy","definition.name","definition.on_open","definition.preview_text","definition.push_type","definition.reply_to_email","definition.shorten_links","definition.smart_sending_enabled","definition.sms_quiet_hours_enabled","definition.sound","definition.subject_line","definition.template_id","definition.title","definition.to_emails","definition.transactional","definition.url","definition.vendor_id","definition.video_asset_id","definition.web_url","id","updated"] |
|
query.fields[template] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template][] |
string | Optional | enum: ["amp","created","editor_type","html","id","name","screenshot_url","text","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["flow-action","template"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Flow Action — klaviyo.create_flow_action
Insert a new action into an existing flow.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[flow-action] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-action][] |
string | Optional | enum: ["created","definition","definition.data","definition.data.action_output_filter","definition.data.action_output_filter.condition_groups","definition.data.branches","definition.data.concluded_experiment_id","definition.data.current_experiment","definition.data.current_experiment.allocations","definition.data.current_experiment.automatic_winner_selection_settings","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty","definition.data.current_experiment.automatic_winner_selection_settings.enabled","definition.data.current_experiment.id","definition.data.current_experiment.name","definition.data.current_experiment.started","definition.data.current_experiment.variations","definition.data.current_experiment.winner_metric","definition.data.delay_until_time","definition.data.delay_until_weekdays","definition.data.experiment_status","definition.data.list_id","definition.data.main_action","definition.data.main_action.data","definition.data.main_action.data.message","definition.data.main_action.data.message.action_buttons","definition.data.main_action.data.message.add_info_link","definition.data.main_action.data.message.add_opt_out_language","definition.data.main_action.data.message.add_org_prefix","definition.data.main_action.data.message.add_tracking_params","definition.data.main_action.data.message.additional_filters","definition.data.main_action.data.message.additional_filters.condition_groups","definition.data.main_action.data.message.android_link","definition.data.main_action.data.message.automation_id","definition.data.main_action.data.message.badge","definition.data.main_action.data.message.badge_options","definition.data.main_action.data.message.badge_options.badge_config","definition.data.main_action.data.message.badge_options.set_from_property","definition.data.main_action.data.message.badge_options.value","definition.data.main_action.data.message.bcc_email","definition.data.main_action.data.message.body","definition.data.main_action.data.message.cc_email","definition.data.main_action.data.message.conversion_metric_id","definition.data.main_action.data.message.custom_tracking_params","definition.data.main_action.data.message.dynamic_image","definition.data.main_action.data.message.expiry_hours","definition.data.main_action.data.message.from_email","definition.data.main_action.data.message.from_label","definition.data.main_action.data.message.id","definition.data.main_action.data.message.image_id","definition.data.main_action.data.message.include_contact_card","definition.data.main_action.data.message.ios_link","definition.data.main_action.data.message.kv_pairs","definition.data.main_action.data.message.message_hierarchy","definition.data.main_action.data.message.name","definition.data.main_action.data.message.on_open","definition.data.main_action.data.message.preview_text","definition.data.main_action.data.message.push_type","definition.data.main_action.data.message.reply_to_email","definition.data.main_action.data.message.shorten_links","definition.data.main_action.data.message.smart_sending_enabled","definition.data.main_action.data.message.sms_quiet_hours_enabled","definition.data.main_action.data.message.sound","definition.data.main_action.data.message.subject_line","definition.data.main_action.data.message.template_id","definition.data.main_action.data.message.title","definition.data.main_action.data.message.transactional","definition.data.main_action.data.message.vendor_id","definition.data.main_action.data.message.video_asset_id","definition.data.main_action.data.message.web_url","definition.data.main_action.data.status","definition.data.main_action.id","definition.data.main_action.links","definition.data.main_action.links.next","definition.data.main_action.temporary_id","definition.data.main_action.type","definition.data.message","definition.data.message.action_buttons","definition.data.message.add_info_link","definition.data.message.add_opt_out_language","definition.data.message.add_org_prefix","definition.data.message.add_tracking_params","definition.data.message.additional_filters","definition.data.message.additional_filters.condition_groups","definition.data.message.android_link","definition.data.message.automation_id","definition.data.message.badge","definition.data.message.badge_options","definition.data.message.badge_options.badge_config","definition.data.message.badge_options.set_from_property","definition.data.message.badge_options.value","definition.data.message.bcc_email","definition.data.message.body","definition.data.message.cc_email","definition.data.message.conversion_metric_id","definition.data.message.custom_tracking_params","definition.data.message.dynamic_image","definition.data.message.expiry_hours","definition.data.message.from_email","definition.data.message.from_label","definition.data.message.headers","definition.data.message.id","definition.data.message.image_id","definition.data.message.include_contact_card","definition.data.message.ios_link","definition.data.message.kv_pairs","definition.data.message.message_hierarchy","definition.data.message.name","definition.data.message.on_open","definition.data.message.preview_text","definition.data.message.push_type","definition.data.message.reply_to_email","definition.data.message.shorten_links","definition.data.message.smart_sending_enabled","definition.data.message.sms_quiet_hours_enabled","definition.data.message.sound","definition.data.message.subject_line","definition.data.message.template_id","definition.data.message.title","definition.data.message.to_emails","definition.data.message.transactional","definition.data.message.url","definition.data.message.vendor_id","definition.data.message.video_asset_id","definition.data.message.web_url","definition.data.name","definition.data.on_execution","definition.data.profile_filter","definition.data.profile_filter.condition_groups","definition.data.profile_operations","definition.data.secondary_value","definition.data.service_configuration","definition.data.service_configuration.event_key","definition.data.service_configuration.event_payload","definition.data.service_configuration.report_id","definition.data.service_configuration.service_method_type","definition.data.service_configuration.tracking_company_id","definition.data.status","definition.data.target_days","definition.data.target_time","definition.data.timezone","definition.data.trigger_filter","definition.data.trigger_filter.condition_groups","definition.data.trigger_id","definition.data.trigger_subtype","definition.data.trigger_type","definition.data.unit","definition.data.value","definition.data.winning_variation_id","definition.id","definition.links","definition.links.next","definition.links.next_if_false","definition.links.next_if_true","definition.temporary_id","definition.type","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/FlowActionInsertQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "flow-action",
"attributes": {
"definition": {
"type": "time-delay",
"temporary_id": "new-delay",
"data": {
"unit": "hours",
"value": 1
}
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Actions for Flow — klaviyo.get_actions_for_flow
Get all flow actions associated with the given flow ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[flow-action] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-action][] |
string | Optional | enum: ["created","definition","definition.data","definition.data.action_output_filter","definition.data.action_output_filter.condition_groups","definition.data.branches","definition.data.concluded_experiment_id","definition.data.current_experiment","definition.data.current_experiment.allocations","definition.data.current_experiment.automatic_winner_selection_settings","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty","definition.data.current_experiment.automatic_winner_selection_settings.enabled","definition.data.current_experiment.id","definition.data.current_experiment.name","definition.data.current_experiment.started","definition.data.current_experiment.variations","definition.data.current_experiment.winner_metric","definition.data.delay_until_time","definition.data.delay_until_weekdays","definition.data.experiment_status","definition.data.list_id","definition.data.main_action","definition.data.main_action.data","definition.data.main_action.data.message","definition.data.main_action.data.message.action_buttons","definition.data.main_action.data.message.add_info_link","definition.data.main_action.data.message.add_opt_out_language","definition.data.main_action.data.message.add_org_prefix","definition.data.main_action.data.message.add_tracking_params","definition.data.main_action.data.message.additional_filters","definition.data.main_action.data.message.additional_filters.condition_groups","definition.data.main_action.data.message.android_link","definition.data.main_action.data.message.automation_id","definition.data.main_action.data.message.badge","definition.data.main_action.data.message.badge_options","definition.data.main_action.data.message.badge_options.badge_config","definition.data.main_action.data.message.badge_options.set_from_property","definition.data.main_action.data.message.badge_options.value","definition.data.main_action.data.message.bcc_email","definition.data.main_action.data.message.body","definition.data.main_action.data.message.cc_email","definition.data.main_action.data.message.conversion_metric_id","definition.data.main_action.data.message.custom_tracking_params","definition.data.main_action.data.message.dynamic_image","definition.data.main_action.data.message.expiry_hours","definition.data.main_action.data.message.from_email","definition.data.main_action.data.message.from_label","definition.data.main_action.data.message.id","definition.data.main_action.data.message.image_id","definition.data.main_action.data.message.include_contact_card","definition.data.main_action.data.message.ios_link","definition.data.main_action.data.message.kv_pairs","definition.data.main_action.data.message.message_hierarchy","definition.data.main_action.data.message.name","definition.data.main_action.data.message.on_open","definition.data.main_action.data.message.preview_text","definition.data.main_action.data.message.push_type","definition.data.main_action.data.message.reply_to_email","definition.data.main_action.data.message.shorten_links","definition.data.main_action.data.message.smart_sending_enabled","definition.data.main_action.data.message.sms_quiet_hours_enabled","definition.data.main_action.data.message.sound","definition.data.main_action.data.message.subject_line","definition.data.main_action.data.message.template_id","definition.data.main_action.data.message.title","definition.data.main_action.data.message.transactional","definition.data.main_action.data.message.vendor_id","definition.data.main_action.data.message.video_asset_id","definition.data.main_action.data.message.web_url","definition.data.main_action.data.status","definition.data.main_action.id","definition.data.main_action.links","definition.data.main_action.links.next","definition.data.main_action.temporary_id","definition.data.main_action.type","definition.data.message","definition.data.message.action_buttons","definition.data.message.add_info_link","definition.data.message.add_opt_out_language","definition.data.message.add_org_prefix","definition.data.message.add_tracking_params","definition.data.message.additional_filters","definition.data.message.additional_filters.condition_groups","definition.data.message.android_link","definition.data.message.automation_id","definition.data.message.badge","definition.data.message.badge_options","definition.data.message.badge_options.badge_config","definition.data.message.badge_options.set_from_property","definition.data.message.badge_options.value","definition.data.message.bcc_email","definition.data.message.body","definition.data.message.cc_email","definition.data.message.conversion_metric_id","definition.data.message.custom_tracking_params","definition.data.message.dynamic_image","definition.data.message.expiry_hours","definition.data.message.from_email","definition.data.message.from_label","definition.data.message.headers","definition.data.message.id","definition.data.message.image_id","definition.data.message.include_contact_card","definition.data.message.ios_link","definition.data.message.kv_pairs","definition.data.message.message_hierarchy","definition.data.message.name","definition.data.message.on_open","definition.data.message.preview_text","definition.data.message.push_type","definition.data.message.reply_to_email","definition.data.message.shorten_links","definition.data.message.smart_sending_enabled","definition.data.message.sms_quiet_hours_enabled","definition.data.message.sound","definition.data.message.subject_line","definition.data.message.template_id","definition.data.message.title","definition.data.message.to_emails","definition.data.message.transactional","definition.data.message.url","definition.data.message.vendor_id","definition.data.message.video_asset_id","definition.data.message.web_url","definition.data.name","definition.data.on_execution","definition.data.profile_filter","definition.data.profile_filter.condition_groups","definition.data.profile_operations","definition.data.secondary_value","definition.data.service_configuration","definition.data.service_configuration.event_key","definition.data.service_configuration.event_payload","definition.data.service_configuration.report_id","definition.data.service_configuration.service_method_type","definition.data.service_configuration.tracking_company_id","definition.data.status","definition.data.target_days","definition.data.target_time","definition.data.timezone","definition.data.trigger_filter","definition.data.trigger_filter.condition_groups","definition.data.trigger_id","definition.data.trigger_subtype","definition.data.trigger_type","definition.data.unit","definition.data.value","definition.data.winning_variation_id","definition.id","definition.links","definition.links.next","definition.links.next_if_false","definition.links.next_if_true","definition.temporary_id","definition.type","id","updated"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any (string) action_type: any, equals (string) status: equals (string) created: equals, greater-or-equal, greater-than, less-or-equal, less-than (date-time) updated: equals, greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 50. Min: 1. Max: 50. | default: 50; minimum: 1; maximum: 50 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["action_type","-action_type","created","-created","id","-id","status","-status","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Action IDs for Flow — klaviyo.get_action_ids_for_flow
Get all relationships for flow actions associated with the given flow ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any (string) action_type: any, equals (string) status: equals (string) created: equals, greater-or-equal, greater-than, less-or-equal, less-than (date-time) updated: equals, greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 50. Min: 1. Max: 50. | default: 50; minimum: 1; maximum: 50 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["action_type","-action_type","created","-created","id","-id","status","-status","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tag IDs for Flow — klaviyo.get_tag_ids_for_flow
Return the tag IDs of all tags associated with the given flow. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Flow for Flow Action — klaviyo.get_flow_for_flow_action
Get the flow associated with the given action ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Flow ID for Flow Action — klaviyo.get_flow_id_for_flow_action
Get the flow associated with the given action ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Messages For Flow Action — klaviyo.get_flow_action_messages
Get all flow messages associated with the given flow action ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[flow-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-message][] |
string | Optional | enum: ["channel","created","definition","definition.action_buttons","definition.add_info_link","definition.add_opt_out_language","definition.add_org_prefix","definition.add_tracking_params","definition.additional_filters","definition.additional_filters.condition_groups","definition.android_link","definition.automation_id","definition.badge","definition.badge_options","definition.badge_options.badge_config","definition.badge_options.set_from_property","definition.badge_options.value","definition.bcc_email","definition.body","definition.cc_email","definition.conversion_metric_id","definition.custom_tracking_params","definition.dynamic_image","definition.expiry_hours","definition.from_email","definition.from_label","definition.headers","definition.id","definition.image_id","definition.include_contact_card","definition.ios_link","definition.kv_pairs","definition.message_hierarchy","definition.name","definition.on_open","definition.preview_text","definition.push_type","definition.reply_to_email","definition.shorten_links","definition.smart_sending_enabled","definition.sms_quiet_hours_enabled","definition.sound","definition.subject_line","definition.template_id","definition.title","definition.to_emails","definition.transactional","definition.url","definition.vendor_id","definition.video_asset_id","definition.web_url","id","updated"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any (string) name: contains, ends-with, equals, starts-with (string) created: equals, greater-or-equal, greater-than, less-or-equal, less-than (date-time) updated: equals, greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 50. Min: 1. Max: 50. | default: 50; minimum: 1; maximum: 50 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created","id","-id","name","-name","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Message IDs for Flow Action — klaviyo.get_message_ids_for_flow_action
Get all relationships for flow messages associated with the given flow action ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): name: contains, ends-with, equals, starts-with (string) created: equals, greater-or-equal, greater-than, less-or-equal, less-than (date-time) updated: equals, greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 50. Min: 1. Max: 50. | default: 50; minimum: 1; maximum: 50 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created","id","-id","name","-name","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Action for Flow Message — klaviyo.get_action_for_flow_message
Get the flow action for a flow message with the given message ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[flow-action] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-action][] |
string | Optional | enum: ["created","definition","definition.data","definition.data.action_output_filter","definition.data.action_output_filter.condition_groups","definition.data.branches","definition.data.concluded_experiment_id","definition.data.current_experiment","definition.data.current_experiment.allocations","definition.data.current_experiment.automatic_winner_selection_settings","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date","definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty","definition.data.current_experiment.automatic_winner_selection_settings.enabled","definition.data.current_experiment.id","definition.data.current_experiment.name","definition.data.current_experiment.started","definition.data.current_experiment.variations","definition.data.current_experiment.winner_metric","definition.data.delay_until_time","definition.data.delay_until_weekdays","definition.data.experiment_status","definition.data.list_id","definition.data.main_action","definition.data.main_action.data","definition.data.main_action.data.message","definition.data.main_action.data.message.action_buttons","definition.data.main_action.data.message.add_info_link","definition.data.main_action.data.message.add_opt_out_language","definition.data.main_action.data.message.add_org_prefix","definition.data.main_action.data.message.add_tracking_params","definition.data.main_action.data.message.additional_filters","definition.data.main_action.data.message.additional_filters.condition_groups","definition.data.main_action.data.message.android_link","definition.data.main_action.data.message.automation_id","definition.data.main_action.data.message.badge","definition.data.main_action.data.message.badge_options","definition.data.main_action.data.message.badge_options.badge_config","definition.data.main_action.data.message.badge_options.set_from_property","definition.data.main_action.data.message.badge_options.value","definition.data.main_action.data.message.bcc_email","definition.data.main_action.data.message.body","definition.data.main_action.data.message.cc_email","definition.data.main_action.data.message.conversion_metric_id","definition.data.main_action.data.message.custom_tracking_params","definition.data.main_action.data.message.dynamic_image","definition.data.main_action.data.message.expiry_hours","definition.data.main_action.data.message.from_email","definition.data.main_action.data.message.from_label","definition.data.main_action.data.message.id","definition.data.main_action.data.message.image_id","definition.data.main_action.data.message.include_contact_card","definition.data.main_action.data.message.ios_link","definition.data.main_action.data.message.kv_pairs","definition.data.main_action.data.message.message_hierarchy","definition.data.main_action.data.message.name","definition.data.main_action.data.message.on_open","definition.data.main_action.data.message.preview_text","definition.data.main_action.data.message.push_type","definition.data.main_action.data.message.reply_to_email","definition.data.main_action.data.message.shorten_links","definition.data.main_action.data.message.smart_sending_enabled","definition.data.main_action.data.message.sms_quiet_hours_enabled","definition.data.main_action.data.message.sound","definition.data.main_action.data.message.subject_line","definition.data.main_action.data.message.template_id","definition.data.main_action.data.message.title","definition.data.main_action.data.message.transactional","definition.data.main_action.data.message.vendor_id","definition.data.main_action.data.message.video_asset_id","definition.data.main_action.data.message.web_url","definition.data.main_action.data.status","definition.data.main_action.id","definition.data.main_action.links","definition.data.main_action.links.next","definition.data.main_action.temporary_id","definition.data.main_action.type","definition.data.message","definition.data.message.action_buttons","definition.data.message.add_info_link","definition.data.message.add_opt_out_language","definition.data.message.add_org_prefix","definition.data.message.add_tracking_params","definition.data.message.additional_filters","definition.data.message.additional_filters.condition_groups","definition.data.message.android_link","definition.data.message.automation_id","definition.data.message.badge","definition.data.message.badge_options","definition.data.message.badge_options.badge_config","definition.data.message.badge_options.set_from_property","definition.data.message.badge_options.value","definition.data.message.bcc_email","definition.data.message.body","definition.data.message.cc_email","definition.data.message.conversion_metric_id","definition.data.message.custom_tracking_params","definition.data.message.dynamic_image","definition.data.message.expiry_hours","definition.data.message.from_email","definition.data.message.from_label","definition.data.message.headers","definition.data.message.id","definition.data.message.image_id","definition.data.message.include_contact_card","definition.data.message.ios_link","definition.data.message.kv_pairs","definition.data.message.message_hierarchy","definition.data.message.name","definition.data.message.on_open","definition.data.message.preview_text","definition.data.message.push_type","definition.data.message.reply_to_email","definition.data.message.shorten_links","definition.data.message.smart_sending_enabled","definition.data.message.sms_quiet_hours_enabled","definition.data.message.sound","definition.data.message.subject_line","definition.data.message.template_id","definition.data.message.title","definition.data.message.to_emails","definition.data.message.transactional","definition.data.message.url","definition.data.message.vendor_id","definition.data.message.video_asset_id","definition.data.message.web_url","definition.data.name","definition.data.on_execution","definition.data.profile_filter","definition.data.profile_filter.condition_groups","definition.data.profile_operations","definition.data.secondary_value","definition.data.service_configuration","definition.data.service_configuration.event_key","definition.data.service_configuration.event_payload","definition.data.service_configuration.report_id","definition.data.service_configuration.service_method_type","definition.data.service_configuration.tracking_company_id","definition.data.status","definition.data.target_days","definition.data.target_time","definition.data.timezone","definition.data.trigger_filter","definition.data.trigger_filter.condition_groups","definition.data.trigger_id","definition.data.trigger_subtype","definition.data.trigger_type","definition.data.unit","definition.data.value","definition.data.winning_variation_id","definition.id","definition.links","definition.links.next","definition.links.next_if_false","definition.links.next_if_true","definition.temporary_id","definition.type","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Action ID for Flow Message — klaviyo.get_action_id_for_flow_message
Get the relationship for a flow message's flow action, given the flow ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Template for Flow Message — klaviyo.get_template_for_flow_message
Return the related template Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[template] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template][] |
string | Optional | enum: ["amp","created","editor_type","html","id","name","screenshot_url","text","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Template ID for Flow Message — klaviyo.get_template_id_for_flow_message
Returns the ID of the related template Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Forms — klaviyo.get_forms
Get all forms in an account. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[form] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[form][] |
string | Optional | enum: ["ab_test","created_at","id","name","status","updated_at"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any, equals (string) name: any, contains, equals (string) ab_test: equals (boolean) updated_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) created_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) status: equals (allowed values: 'live', 'draft') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created_at","-created_at","updated_at","-updated_at"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Form — klaviyo.create_form
Create a new form. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[form] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[form][] |
string | Optional | enum: ["ab_test","created_at","definition","definition.versions","id","name","status","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/FormCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "form",
"attributes": {
"definition": {
"versions": []
},
"status": "draft",
"ab_test": false,
"name": "Cyber Monday Deals"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Form — klaviyo.get_form
Get the form with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the form | |
query |
object | Optional | additionalProperties: false |
|
query.fields[form] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[form][] |
string | Optional | enum: ["ab_test","created_at","definition","definition.versions","id","name","status","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Form — klaviyo.update_form
Update a form.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the form. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[form] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[form][] |
string | Optional | enum: ["ab_test","created_at","definition","definition.versions","id","name","status","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/FormPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "form",
"id": "Y6nRLr",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Form — klaviyo.delete_form
Delete a given form. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the form | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Form Version — klaviyo.get_form_version
Get the form version with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the form version | |
query |
object | Optional | additionalProperties: false |
|
query.fields[form-version] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[form-version][] |
string | Optional | enum: ["ab_test","ab_test.variation_name","created_at","form_type","id","status","updated_at","variation_name"] |
|
query.fields[form] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[form][] |
string | Optional | enum: ["ab_test","created_at","id","name","status","updated_at"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["form"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "1234567"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Publish Form — klaviyo.publish_form
Publish the draft version of a form.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[form-publish-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[form-publish-job][] |
string | Optional | enum: ["created_at","id","status"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/FormPublishJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "form-publish-job",
"relationships": {
"form": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Unpublish Form — klaviyo.unpublish_form
Unpublish the live version of a form.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[form-unpublish-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[form-unpublish-job][] |
string | Optional | enum: ["created_at","id","status"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/FormUnpublishJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "form-unpublish-job",
"relationships": {
"form": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Versions for Form — klaviyo.get_versions_for_form
Get the form versions for the given form. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | null | Required | The ID of the form | |
query |
object | Optional | additionalProperties: false |
|
query.fields[form-version] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[form-version][] |
string | Optional | enum: ["ab_test","ab_test.variation_name","created_at","form_type","id","status","updated_at","variation_name"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): form_type: any, equals (allowed values: 'popup', 'embed', 'full_page', 'flyout', 'banner') status: equals (allowed values: 'live', 'draft') updated_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) created_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created_at","-created_at","updated_at","-updated_at"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Version IDs for Form — klaviyo.get_version_ids_for_form
Get the IDs of the form versions for the given form. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | null | Required | The ID of the form | |
query |
object | Optional | additionalProperties: false |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): form_type: any, equals (allowed values: 'popup', 'embed', 'full_page', 'flyout', 'banner') status: equals (allowed values: 'live', 'draft') updated_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) created_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created_at","-created_at","updated_at","-updated_at"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Form for Form Version — klaviyo.get_form_for_form_version
Get the form associated with the given form version. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the form version | |
query |
object | Optional | additionalProperties: false |
|
query.fields[form] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[form][] |
string | Optional | enum: ["ab_test","created_at","id","name","status","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "1234567"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Form ID for Form Version — klaviyo.get_form_id_for_form_version
Get the ID of the form associated with the given form version. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the form version | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "1234567"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Images — klaviyo.get_images
Get all images in an account. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[image] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[image][] |
string | Optional | enum: ["format","hidden","id","image_url","name","size","updated_at"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any, equals (string) updated_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) format: any, equals (string) name: any, contains, ends-with, equals, starts-with (string) size: greater-or-equal, greater-than, less-or-equal, less-than (integer) hidden: any, equals (boolean) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["format","-format","id","-id","name","-name","size","-size","updated_at","-updated_at"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Upload Image From URL — klaviyo.upload_image_from_url
Import an image from a url or data uri.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[image] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[image][] |
string | Optional | enum: ["format","hidden","id","image_url","name","size","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ImageCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "image",
"attributes": {
"import_from_url": "https://www.example.com/example.jpg"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Image — klaviyo.get_image
Get the image with the given image ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the image | |
query |
object | Optional | additionalProperties: false |
|
query.fields[image] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[image][] |
string | Optional | enum: ["format","hidden","id","image_url","name","size","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "7"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Image — klaviyo.update_image
Update the image with the given image ID. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the image | |
query |
object | Optional | additionalProperties: false |
|
query.fields[image] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[image][] |
string | Optional | enum: ["format","hidden","id","image_url","name","size","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ImagePartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "7"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "image",
"id": "7",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Lists — klaviyo.get_lists
Get all lists in an account.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
query.fields[list] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[list][] |
string | Optional | enum: ["created","id","name","opt_in_process","updated"] |
|
query.fields[tag] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag][] |
string | Optional | enum: ["id","name"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): name: any, equals (string) id: any, equals (string) created: greater-than (date-time) updated: greater-than (date-time) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["flow-triggers","tags"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 10. Min: 1. Max: 10. | default: 10; minimum: 1; maximum: 10 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created","id","-id","name","-name","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create List — klaviyo.create_list
Create a new list. Rate limits: Burst: 10/s Steady: 150/m Daily: 150/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[list] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[list][] |
string | Optional | enum: ["created","id","name","opt_in_process","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ListCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "list",
"attributes": {
"name": "Newsletter"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get List — klaviyo.get_list
Get a list with the given list ID. Rate limits: Burst: 75/s Steady: 750/m Rate limits when using the additional-fields[list]=profile_count parameter in your API request: Burst: 1/s Steady: 15/m To learn more about how the additional-fields parameter impacts rate limits, check out our Rate limits, status codes, and errors guide.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[list] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'profile_count' | |
query.additional-fields[list][] |
string | Optional | enum: ["profile_count"] |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
query.fields[list] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[list][] |
string | Optional | enum: ["created","id","name","opt_in_process","profile_count","updated"] |
|
query.fields[tag] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag][] |
string | Optional | enum: ["id","name"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["flow-triggers","tags"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update List — klaviyo.update_list
Update the name of a list with the given list ID. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[list] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[list][] |
string | Optional | enum: ["created","id","name","opt_in_process","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ListPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "list",
"id": "Y6nRLr",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete List — klaviyo.delete_list
Delete a list with the given list ID. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tag IDs for List — klaviyo.get_tag_ids_for_list
Return all tags associated with the given list ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profiles for List — klaviyo.get_profiles_for_list
Get all profiles within a list with the given list ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[profile] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | |
query.additional-fields[profile][] |
string | Optional | enum: ["subscriptions","predictive_analytics"] |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","joined_group_at","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","predictive_analytics","predictive_analytics.average_days_between_orders","predictive_analytics.average_order_value","predictive_analytics.churn_probability","predictive_analytics.expected_date_of_next_order","predictive_analytics.historic_clv","predictive_analytics.historic_number_of_orders","predictive_analytics.predicted_clv","predictive_analytics.predicted_number_of_orders","predictive_analytics.ranked_channel_affinity","predictive_analytics.total_clv","properties","subscriptions","subscriptions.email","subscriptions.email.click_tracking","subscriptions.email.click_tracking.can_receive","subscriptions.email.click_tracking.consent","subscriptions.email.click_tracking.consent_timestamp","subscriptions.email.click_tracking.created_timestamp","subscriptions.email.click_tracking.last_updated","subscriptions.email.click_tracking.metadata","subscriptions.email.click_tracking.valid_until","subscriptions.email.marketing","subscriptions.email.marketing.can_receive_email_marketing","subscriptions.email.marketing.consent","subscriptions.email.marketing.consent_timestamp","subscriptions.email.marketing.custom_method_detail","subscriptions.email.marketing.double_optin","subscriptions.email.marketing.last_updated","subscriptions.email.marketing.list_suppressions","subscriptions.email.marketing.method","subscriptions.email.marketing.method_detail","subscriptions.email.marketing.suppression","subscriptions.email.open_tracking","subscriptions.email.open_tracking.can_receive","subscriptions.email.open_tracking.consent","subscriptions.email.open_tracking.consent_timestamp","subscriptions.email.open_tracking.created_timestamp","subscriptions.email.open_tracking.last_updated","subscriptions.email.open_tracking.metadata","subscriptions.email.open_tracking.valid_until","subscriptions.mobile_push","subscriptions.mobile_push.marketing","subscriptions.mobile_push.marketing.can_receive_push_marketing","subscriptions.mobile_push.marketing.consent","subscriptions.mobile_push.marketing.consent_timestamp","subscriptions.sms","subscriptions.sms.marketing","subscriptions.sms.marketing.can_receive_sms_marketing","subscriptions.sms.marketing.consent","subscriptions.sms.marketing.consent_timestamp","subscriptions.sms.marketing.last_updated","subscriptions.sms.marketing.method","subscriptions.sms.marketing.method_detail","subscriptions.sms.transactional","subscriptions.sms.transactional.can_receive_sms_transactional","subscriptions.sms.transactional.consent","subscriptions.sms.transactional.consent_timestamp","subscriptions.sms.transactional.last_updated","subscriptions.sms.transactional.method","subscriptions.sms.transactional.method_detail","subscriptions.whatsapp","subscriptions.whatsapp.conversational","subscriptions.whatsapp.conversational.can_receive","subscriptions.whatsapp.conversational.consent","subscriptions.whatsapp.conversational.consent_timestamp","subscriptions.whatsapp.conversational.created_timestamp","subscriptions.whatsapp.conversational.last_updated","subscriptions.whatsapp.conversational.metadata","subscriptions.whatsapp.conversational.phone_number","subscriptions.whatsapp.conversational.valid_until","subscriptions.whatsapp.marketing","subscriptions.whatsapp.marketing.can_receive","subscriptions.whatsapp.marketing.consent","subscriptions.whatsapp.marketing.consent_timestamp","subscriptions.whatsapp.marketing.created_timestamp","subscriptions.whatsapp.marketing.last_updated","subscriptions.whatsapp.marketing.metadata","subscriptions.whatsapp.marketing.phone_number","subscriptions.whatsapp.marketing.valid_until","subscriptions.whatsapp.transactional","subscriptions.whatsapp.transactional.can_receive","subscriptions.whatsapp.transactional.consent","subscriptions.whatsapp.transactional.consent_timestamp","subscriptions.whatsapp.transactional.created_timestamp","subscriptions.whatsapp.transactional.last_updated","subscriptions.whatsapp.transactional.metadata","subscriptions.whatsapp.transactional.phone_number","subscriptions.whatsapp.transactional.valid_until","title","updated"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): email: any, equals (string) phone_number: any, equals (string) push_token: any, equals (string) _kx: equals (string) joined_group_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["joined_group_at","-joined_group_at"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profile IDs for List — klaviyo.get_profile_ids_for_list
Get profile membership relationships for a list with the given list ID. Rate limits: Burst: 75/s Steady: 750/m Rate limits when using the additional-fields[profile]=predictive_analytics parameter in your API request: Burst: 10/s Steady: 150/m To learn more about how the additional-fields parameter impacts rate limits, check out our Rate limits, status codes, and errors guide.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
query |
object | Optional | additionalProperties: false |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): email: any, equals (string) phone_number: any, equals (string) push_token: any, equals (string) _kx: equals (string) joined_group_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["joined_group_at","-joined_group_at"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Add Profiles to List — klaviyo.add_profiles_to_list
Add a profile to a list with the given list ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ListMembersAddQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Profiles from List — klaviyo.remove_profiles_from_list
Remove a profile from a list with the given list ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ListMembersDeleteQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Flows Triggered by List — klaviyo.get_flows_triggered_by_list
Get all flows where the given list ID is being used as the trigger. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get IDs for Flows Triggered by List — klaviyo.get_ids_for_flows_triggered_by_list
Get the IDs of all flows where the given list is being used as the trigger. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this list. Generated by Klaviyo. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Metrics — klaviyo.get_metrics
Get all metrics in an account.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): integration.name: equals (string) integration.category: equals (string) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["flow-triggers"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Metric — klaviyo.get_metric
Get a metric with the given metric ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Metric ID | |
query |
object | Optional | additionalProperties: false |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["flow-triggers"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Metric Property — klaviyo.get_metric_property
Get a metric property with the given metric property ID. Rate limits: Burst: 1/s Steady: 15/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the metric property | |
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[metric-property] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'sample_values' | |
query.additional-fields[metric-property][] |
string | Optional | enum: ["sample_values"] |
|
query.fields[metric-property] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric-property][] |
string | Optional | enum: ["id","inferred_type","label","property","sample_values"] |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["metric"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Custom Metrics — klaviyo.get_custom_metrics
Get all custom metrics in an account. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[custom-metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[custom-metric][] |
string | Optional | enum: ["created","definition","definition.aggregation_method","definition.metric_groups","id","name","updated"] |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["metrics"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Custom Metric — klaviyo.create_custom_metric
Create a new custom metric.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[custom-metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[custom-metric][] |
string | Optional | enum: ["created","definition","definition.aggregation_method","definition.metric_groups","id","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CustomMetricCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "custom-metric",
"attributes": {
"name": "My custom metric",
"definition": {
"aggregation_method": "count",
"metric_groups": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Custom Metric — klaviyo.get_custom_metric
Get a custom metric with the given custom metric ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the custom metric | |
query |
object | Optional | additionalProperties: false |
|
query.fields[custom-metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[custom-metric][] |
string | Optional | enum: ["created","definition","definition.aggregation_method","definition.metric_groups","id","name","updated"] |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["metrics"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Custom Metric — klaviyo.update_custom_metric
Update a custom metric with the given custom metric ID. Rate limits: Burst: 1/s Steady: 15/m Daily: 15/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the custom metric | |
query |
object | Optional | additionalProperties: false |
|
query.fields[custom-metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[custom-metric][] |
string | Optional | enum: ["created","definition","definition.aggregation_method","definition.metric_groups","id","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CustomMetricPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "custom-metric",
"id": "925e385b52fb405715f3616c337cc65c",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Custom Metric — klaviyo.delete_custom_metric
Delete a custom metric with the given custom metric ID. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the custom metric | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Mapped Metrics — klaviyo.get_mapped_metrics
Get all mapped metrics in an account. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[custom-metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[custom-metric][] |
string | Optional | enum: ["created","definition","definition.aggregation_method","definition.metric_groups","id","name","updated"] |
|
query.fields[mapped-metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[mapped-metric][] |
string | Optional | enum: ["id","updated"] |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["custom-metric","metric"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Mapped Metric — klaviyo.get_mapped_metric
Get the mapped metric with the given ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The type of mapping. | enum: ["added_to_cart","cancelled_sales","ordered_product","refunded_sales","revenue","started_checkout","viewed_product"] |
query |
object | Optional | additionalProperties: false |
|
query.fields[custom-metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[custom-metric][] |
string | Optional | enum: ["created","definition","definition.aggregation_method","definition.metric_groups","id","name","updated"] |
|
query.fields[mapped-metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[mapped-metric][] |
string | Optional | enum: ["id","updated"] |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["custom-metric","metric"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "revenue"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Mapped Metric — klaviyo.update_mapped_metric
Update the mapped metric with the given ID. Rate limits: Burst: 1/s Steady: 15/m Daily: 30/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The type of mapping. | enum: ["added_to_cart","cancelled_sales","ordered_product","refunded_sales","revenue","started_checkout","viewed_product"] |
query |
object | Optional | additionalProperties: false |
|
query.fields[mapped-metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[mapped-metric][] |
string | Optional | enum: ["id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/MappedMetricPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "revenue"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "mapped-metric",
"id": "revenue"
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Query Metric Aggregates — klaviyo.query_metric_aggregates
Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events (not to be confused with custom metrics, which are not supported at this time). Queries must be passed in the JSON body of your POST request.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[metric-aggregate] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric-aggregate][] |
string | Optional | enum: ["data","dates","id"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/MetricAggregateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "metric-aggregate",
"attributes": {
"metric_id": "0rG4eQ",
"measurements": [
"count"
],
"filter": [
"greater-or-equal(datetime,2022-12-01T00:00:00)",
"less-than(datetime,2022-12-08T00:00:00)"
]
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Flows Triggered by Metric — klaviyo.get_flows_triggered_by_metric
Get all flows where the given metric is being used as the trigger. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get IDs for Flows Triggered by Metric — klaviyo.get_ids_for_flows_triggered_by_metric
Get the IDs of all flows where the given metric is being used as the trigger. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Properties for Metric — klaviyo.get_properties_for_metric
Get the metric properties for the given metric ID. Rate limits: Burst: 1/s Steady: 15/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the metric | |
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[metric-property] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'sample_values' | |
query.additional-fields[metric-property][] |
string | Optional | enum: ["sample_values"] |
|
query.fields[metric-property] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric-property][] |
string | Optional | enum: ["id","inferred_type","label","property","sample_values"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e38"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Property IDs for Metric — klaviyo.get_property_ids_for_metric
Get the IDs of metric properties for the given metric. Rate limits: Burst: 1/s Steady: 15/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the metric | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e38"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Metric for Metric Property — klaviyo.get_metric_for_metric_property
Get the metric for the given metric property ID. Rate limits: Burst: 1/s Steady: 15/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the metric property | |
query |
object | Optional | additionalProperties: false |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Metric ID for Metric Property — klaviyo.get_metric_id_for_metric_property
Get the ID of the metric for the given metric property. Rate limits: Burst: 1/s Steady: 15/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the metric property | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Metrics for Custom Metric — klaviyo.get_metrics_for_custom_metric
Get all metrics for the given custom metric ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the custom metric | |
query |
object | Optional | additionalProperties: false |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Metric IDs for Custom Metric — klaviyo.get_metric_ids_for_custom_metric
Get all metrics for the given custom metric ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the custom metric | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Metric for Mapped Metric — klaviyo.get_metric_for_mapped_metric
Get the metric for the given mapped metric ID (if applicable). Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The type of mapping. | enum: ["added_to_cart","cancelled_sales","ordered_product","refunded_sales","revenue","started_checkout","viewed_product"] |
query |
object | Optional | additionalProperties: false |
|
query.fields[metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[metric][] |
string | Optional | enum: ["created","id","integration","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "revenue"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Metric ID for Mapped Metric — klaviyo.get_metric_id_for_mapped_metric
Get the ID of the metric for the given mapped metric. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The type of mapping. | enum: ["added_to_cart","cancelled_sales","ordered_product","refunded_sales","revenue","started_checkout","viewed_product"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "revenue"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Custom Metric for Mapped Metric — klaviyo.get_custom_metric_for_mapped_metric
Get the custom metric for the given mapped metric ID (if applicable). Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The type of mapping. | enum: ["added_to_cart","cancelled_sales","ordered_product","refunded_sales","revenue","started_checkout","viewed_product"] |
query |
object | Optional | additionalProperties: false |
|
query.fields[custom-metric] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[custom-metric][] |
string | Optional | enum: ["created","definition","definition.aggregation_method","definition.metric_groups","id","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "revenue"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Custom Metric ID for Mapped Metric — klaviyo.get_custom_metric_id_for_mapped_metric
Get the ID of the custom metric for the given mapped metric. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The type of mapping. | enum: ["added_to_cart","cancelled_sales","ordered_product","refunded_sales","revenue","started_checkout","viewed_product"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "revenue"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profiles — klaviyo.get_profiles
Get all profiles in an account.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[profile] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | |
query.additional-fields[profile][] |
string | Optional | enum: ["subscriptions","predictive_analytics"] |
|
query.fields[conversation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[conversation][] |
string | Optional | enum: ["channel","id"] |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","predictive_analytics","predictive_analytics.average_days_between_orders","predictive_analytics.average_order_value","predictive_analytics.churn_probability","predictive_analytics.expected_date_of_next_order","predictive_analytics.historic_clv","predictive_analytics.historic_number_of_orders","predictive_analytics.predicted_clv","predictive_analytics.predicted_number_of_orders","predictive_analytics.ranked_channel_affinity","predictive_analytics.total_clv","properties","subscriptions","subscriptions.email","subscriptions.email.click_tracking","subscriptions.email.click_tracking.can_receive","subscriptions.email.click_tracking.consent","subscriptions.email.click_tracking.consent_timestamp","subscriptions.email.click_tracking.created_timestamp","subscriptions.email.click_tracking.last_updated","subscriptions.email.click_tracking.metadata","subscriptions.email.click_tracking.valid_until","subscriptions.email.marketing","subscriptions.email.marketing.can_receive_email_marketing","subscriptions.email.marketing.consent","subscriptions.email.marketing.consent_timestamp","subscriptions.email.marketing.custom_method_detail","subscriptions.email.marketing.double_optin","subscriptions.email.marketing.last_updated","subscriptions.email.marketing.list_suppressions","subscriptions.email.marketing.method","subscriptions.email.marketing.method_detail","subscriptions.email.marketing.suppression","subscriptions.email.open_tracking","subscriptions.email.open_tracking.can_receive","subscriptions.email.open_tracking.consent","subscriptions.email.open_tracking.consent_timestamp","subscriptions.email.open_tracking.created_timestamp","subscriptions.email.open_tracking.last_updated","subscriptions.email.open_tracking.metadata","subscriptions.email.open_tracking.valid_until","subscriptions.mobile_push","subscriptions.mobile_push.marketing","subscriptions.mobile_push.marketing.can_receive_push_marketing","subscriptions.mobile_push.marketing.consent","subscriptions.mobile_push.marketing.consent_timestamp","subscriptions.sms","subscriptions.sms.marketing","subscriptions.sms.marketing.can_receive_sms_marketing","subscriptions.sms.marketing.consent","subscriptions.sms.marketing.consent_timestamp","subscriptions.sms.marketing.last_updated","subscriptions.sms.marketing.method","subscriptions.sms.marketing.method_detail","subscriptions.sms.transactional","subscriptions.sms.transactional.can_receive_sms_transactional","subscriptions.sms.transactional.consent","subscriptions.sms.transactional.consent_timestamp","subscriptions.sms.transactional.last_updated","subscriptions.sms.transactional.method","subscriptions.sms.transactional.method_detail","subscriptions.whatsapp","subscriptions.whatsapp.conversational","subscriptions.whatsapp.conversational.can_receive","subscriptions.whatsapp.conversational.consent","subscriptions.whatsapp.conversational.consent_timestamp","subscriptions.whatsapp.conversational.created_timestamp","subscriptions.whatsapp.conversational.last_updated","subscriptions.whatsapp.conversational.metadata","subscriptions.whatsapp.conversational.phone_number","subscriptions.whatsapp.conversational.valid_until","subscriptions.whatsapp.marketing","subscriptions.whatsapp.marketing.can_receive","subscriptions.whatsapp.marketing.consent","subscriptions.whatsapp.marketing.consent_timestamp","subscriptions.whatsapp.marketing.created_timestamp","subscriptions.whatsapp.marketing.last_updated","subscriptions.whatsapp.marketing.metadata","subscriptions.whatsapp.marketing.phone_number","subscriptions.whatsapp.marketing.valid_until","subscriptions.whatsapp.transactional","subscriptions.whatsapp.transactional.can_receive","subscriptions.whatsapp.transactional.consent","subscriptions.whatsapp.transactional.consent_timestamp","subscriptions.whatsapp.transactional.created_timestamp","subscriptions.whatsapp.transactional.last_updated","subscriptions.whatsapp.transactional.metadata","subscriptions.whatsapp.transactional.phone_number","subscriptions.whatsapp.transactional.valid_until","title","updated"] |
|
query.fields[push-token] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[push-token][] |
string | Optional | enum: ["background","created","enablement_status","id","metadata","metadata.app_build","metadata.app_id","metadata.app_name","metadata.app_version","metadata.device_id","metadata.device_model","metadata.environment","metadata.klaviyo_sdk","metadata.manufacturer","metadata.os_name","metadata.os_version","metadata.sdk_version","platform","recorded_date","token","vendor"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any, equals (string) email: any, equals (string) phone_number: any, equals (string) external_id: any, equals (string) _kx: equals (string) created: greater-than, less-than (date-time) updated: greater-than, less-than (date-time) subscriptions.email.marketing.list_suppressions.reason: equals (string) subscriptions.email.marketing.list_suppressions.timestamp: greater-or-equal, greater-than, less-or-equal, less-than (date-time) subscriptions.email.marketing.list_suppressions.list_id: equals (string) subscriptions.email.marketing.suppression.reason: equals (string) subscriptions.email.marketing.suppression.timestamp: greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["conversations","push-tokens"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created","email","-email","id","-id","subscriptions.email.marketing.list_suppressions.timestamp","-subscriptions.email.marketing.list_suppressions.timestamp","subscriptions.email.marketing.suppression.timestamp","-subscriptions.email.marketing.suppression.timestamp","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Profile — klaviyo.create_profile
Create a new profile.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[profile] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | |
query.additional-fields[profile][] |
string | Optional | enum: ["subscriptions","predictive_analytics"] |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","predictive_analytics","predictive_analytics.average_days_between_orders","predictive_analytics.average_order_value","predictive_analytics.churn_probability","predictive_analytics.expected_date_of_next_order","predictive_analytics.historic_clv","predictive_analytics.historic_number_of_orders","predictive_analytics.predicted_clv","predictive_analytics.predicted_number_of_orders","predictive_analytics.ranked_channel_affinity","predictive_analytics.total_clv","properties","subscriptions","subscriptions.email","subscriptions.email.click_tracking","subscriptions.email.click_tracking.can_receive","subscriptions.email.click_tracking.consent","subscriptions.email.click_tracking.consent_timestamp","subscriptions.email.click_tracking.created_timestamp","subscriptions.email.click_tracking.last_updated","subscriptions.email.click_tracking.metadata","subscriptions.email.click_tracking.valid_until","subscriptions.email.marketing","subscriptions.email.marketing.can_receive_email_marketing","subscriptions.email.marketing.consent","subscriptions.email.marketing.consent_timestamp","subscriptions.email.marketing.custom_method_detail","subscriptions.email.marketing.double_optin","subscriptions.email.marketing.last_updated","subscriptions.email.marketing.list_suppressions","subscriptions.email.marketing.method","subscriptions.email.marketing.method_detail","subscriptions.email.marketing.suppression","subscriptions.email.open_tracking","subscriptions.email.open_tracking.can_receive","subscriptions.email.open_tracking.consent","subscriptions.email.open_tracking.consent_timestamp","subscriptions.email.open_tracking.created_timestamp","subscriptions.email.open_tracking.last_updated","subscriptions.email.open_tracking.metadata","subscriptions.email.open_tracking.valid_until","subscriptions.mobile_push","subscriptions.mobile_push.marketing","subscriptions.mobile_push.marketing.can_receive_push_marketing","subscriptions.mobile_push.marketing.consent","subscriptions.mobile_push.marketing.consent_timestamp","subscriptions.sms","subscriptions.sms.marketing","subscriptions.sms.marketing.can_receive_sms_marketing","subscriptions.sms.marketing.consent","subscriptions.sms.marketing.consent_timestamp","subscriptions.sms.marketing.last_updated","subscriptions.sms.marketing.method","subscriptions.sms.marketing.method_detail","subscriptions.sms.transactional","subscriptions.sms.transactional.can_receive_sms_transactional","subscriptions.sms.transactional.consent","subscriptions.sms.transactional.consent_timestamp","subscriptions.sms.transactional.last_updated","subscriptions.sms.transactional.method","subscriptions.sms.transactional.method_detail","subscriptions.whatsapp","subscriptions.whatsapp.conversational","subscriptions.whatsapp.conversational.can_receive","subscriptions.whatsapp.conversational.consent","subscriptions.whatsapp.conversational.consent_timestamp","subscriptions.whatsapp.conversational.created_timestamp","subscriptions.whatsapp.conversational.last_updated","subscriptions.whatsapp.conversational.metadata","subscriptions.whatsapp.conversational.phone_number","subscriptions.whatsapp.conversational.valid_until","subscriptions.whatsapp.marketing","subscriptions.whatsapp.marketing.can_receive","subscriptions.whatsapp.marketing.consent","subscriptions.whatsapp.marketing.consent_timestamp","subscriptions.whatsapp.marketing.created_timestamp","subscriptions.whatsapp.marketing.last_updated","subscriptions.whatsapp.marketing.metadata","subscriptions.whatsapp.marketing.phone_number","subscriptions.whatsapp.marketing.valid_until","subscriptions.whatsapp.transactional","subscriptions.whatsapp.transactional.can_receive","subscriptions.whatsapp.transactional.consent","subscriptions.whatsapp.transactional.consent_timestamp","subscriptions.whatsapp.transactional.created_timestamp","subscriptions.whatsapp.transactional.last_updated","subscriptions.whatsapp.transactional.metadata","subscriptions.whatsapp.transactional.phone_number","subscriptions.whatsapp.transactional.valid_until","title","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ProfileCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "profile",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profile — klaviyo.get_profile
Get the profile with the given profile ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[profile] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | |
query.additional-fields[profile][] |
string | Optional | enum: ["subscriptions","predictive_analytics"] |
|
query.fields[conversation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[conversation][] |
string | Optional | enum: ["channel","id"] |
|
query.fields[list] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[list][] |
string | Optional | enum: ["created","id","name","opt_in_process","updated"] |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","predictive_analytics","predictive_analytics.average_days_between_orders","predictive_analytics.average_order_value","predictive_analytics.churn_probability","predictive_analytics.expected_date_of_next_order","predictive_analytics.historic_clv","predictive_analytics.historic_number_of_orders","predictive_analytics.predicted_clv","predictive_analytics.predicted_number_of_orders","predictive_analytics.ranked_channel_affinity","predictive_analytics.total_clv","properties","subscriptions","subscriptions.email","subscriptions.email.click_tracking","subscriptions.email.click_tracking.can_receive","subscriptions.email.click_tracking.consent","subscriptions.email.click_tracking.consent_timestamp","subscriptions.email.click_tracking.created_timestamp","subscriptions.email.click_tracking.last_updated","subscriptions.email.click_tracking.metadata","subscriptions.email.click_tracking.valid_until","subscriptions.email.marketing","subscriptions.email.marketing.can_receive_email_marketing","subscriptions.email.marketing.consent","subscriptions.email.marketing.consent_timestamp","subscriptions.email.marketing.custom_method_detail","subscriptions.email.marketing.double_optin","subscriptions.email.marketing.last_updated","subscriptions.email.marketing.list_suppressions","subscriptions.email.marketing.method","subscriptions.email.marketing.method_detail","subscriptions.email.marketing.suppression","subscriptions.email.open_tracking","subscriptions.email.open_tracking.can_receive","subscriptions.email.open_tracking.consent","subscriptions.email.open_tracking.consent_timestamp","subscriptions.email.open_tracking.created_timestamp","subscriptions.email.open_tracking.last_updated","subscriptions.email.open_tracking.metadata","subscriptions.email.open_tracking.valid_until","subscriptions.mobile_push","subscriptions.mobile_push.marketing","subscriptions.mobile_push.marketing.can_receive_push_marketing","subscriptions.mobile_push.marketing.consent","subscriptions.mobile_push.marketing.consent_timestamp","subscriptions.sms","subscriptions.sms.marketing","subscriptions.sms.marketing.can_receive_sms_marketing","subscriptions.sms.marketing.consent","subscriptions.sms.marketing.consent_timestamp","subscriptions.sms.marketing.last_updated","subscriptions.sms.marketing.method","subscriptions.sms.marketing.method_detail","subscriptions.sms.transactional","subscriptions.sms.transactional.can_receive_sms_transactional","subscriptions.sms.transactional.consent","subscriptions.sms.transactional.consent_timestamp","subscriptions.sms.transactional.last_updated","subscriptions.sms.transactional.method","subscriptions.sms.transactional.method_detail","subscriptions.whatsapp","subscriptions.whatsapp.conversational","subscriptions.whatsapp.conversational.can_receive","subscriptions.whatsapp.conversational.consent","subscriptions.whatsapp.conversational.consent_timestamp","subscriptions.whatsapp.conversational.created_timestamp","subscriptions.whatsapp.conversational.last_updated","subscriptions.whatsapp.conversational.metadata","subscriptions.whatsapp.conversational.phone_number","subscriptions.whatsapp.conversational.valid_until","subscriptions.whatsapp.marketing","subscriptions.whatsapp.marketing.can_receive","subscriptions.whatsapp.marketing.consent","subscriptions.whatsapp.marketing.consent_timestamp","subscriptions.whatsapp.marketing.created_timestamp","subscriptions.whatsapp.marketing.last_updated","subscriptions.whatsapp.marketing.metadata","subscriptions.whatsapp.marketing.phone_number","subscriptions.whatsapp.marketing.valid_until","subscriptions.whatsapp.transactional","subscriptions.whatsapp.transactional.can_receive","subscriptions.whatsapp.transactional.consent","subscriptions.whatsapp.transactional.consent_timestamp","subscriptions.whatsapp.transactional.created_timestamp","subscriptions.whatsapp.transactional.last_updated","subscriptions.whatsapp.transactional.metadata","subscriptions.whatsapp.transactional.phone_number","subscriptions.whatsapp.transactional.valid_until","title","updated"] |
|
query.fields[push-token] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[push-token][] |
string | Optional | enum: ["background","created","enablement_status","id","metadata","metadata.app_build","metadata.app_id","metadata.app_name","metadata.app_version","metadata.device_id","metadata.device_model","metadata.environment","metadata.klaviyo_sdk","metadata.manufacturer","metadata.os_name","metadata.os_version","metadata.sdk_version","platform","recorded_date","token","vendor"] |
|
query.fields[segment] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[segment][] |
string | Optional | enum: ["created","definition","definition.condition_groups","id","is_active","is_processing","is_starred","name","updated"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["conversations","lists","push-tokens","segments"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Profile — klaviyo.update_profile
Update the profile with the given profile ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this profile. Generated by Klaviyo. | |
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[profile] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | |
query.additional-fields[profile][] |
string | Optional | enum: ["subscriptions","predictive_analytics"] |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","predictive_analytics","predictive_analytics.average_days_between_orders","predictive_analytics.average_order_value","predictive_analytics.churn_probability","predictive_analytics.expected_date_of_next_order","predictive_analytics.historic_clv","predictive_analytics.historic_number_of_orders","predictive_analytics.predicted_clv","predictive_analytics.predicted_number_of_orders","predictive_analytics.ranked_channel_affinity","predictive_analytics.total_clv","properties","subscriptions","subscriptions.email","subscriptions.email.click_tracking","subscriptions.email.click_tracking.can_receive","subscriptions.email.click_tracking.consent","subscriptions.email.click_tracking.consent_timestamp","subscriptions.email.click_tracking.created_timestamp","subscriptions.email.click_tracking.last_updated","subscriptions.email.click_tracking.metadata","subscriptions.email.click_tracking.valid_until","subscriptions.email.marketing","subscriptions.email.marketing.can_receive_email_marketing","subscriptions.email.marketing.consent","subscriptions.email.marketing.consent_timestamp","subscriptions.email.marketing.custom_method_detail","subscriptions.email.marketing.double_optin","subscriptions.email.marketing.last_updated","subscriptions.email.marketing.list_suppressions","subscriptions.email.marketing.method","subscriptions.email.marketing.method_detail","subscriptions.email.marketing.suppression","subscriptions.email.open_tracking","subscriptions.email.open_tracking.can_receive","subscriptions.email.open_tracking.consent","subscriptions.email.open_tracking.consent_timestamp","subscriptions.email.open_tracking.created_timestamp","subscriptions.email.open_tracking.last_updated","subscriptions.email.open_tracking.metadata","subscriptions.email.open_tracking.valid_until","subscriptions.mobile_push","subscriptions.mobile_push.marketing","subscriptions.mobile_push.marketing.can_receive_push_marketing","subscriptions.mobile_push.marketing.consent","subscriptions.mobile_push.marketing.consent_timestamp","subscriptions.sms","subscriptions.sms.marketing","subscriptions.sms.marketing.can_receive_sms_marketing","subscriptions.sms.marketing.consent","subscriptions.sms.marketing.consent_timestamp","subscriptions.sms.marketing.last_updated","subscriptions.sms.marketing.method","subscriptions.sms.marketing.method_detail","subscriptions.sms.transactional","subscriptions.sms.transactional.can_receive_sms_transactional","subscriptions.sms.transactional.consent","subscriptions.sms.transactional.consent_timestamp","subscriptions.sms.transactional.last_updated","subscriptions.sms.transactional.method","subscriptions.sms.transactional.method_detail","subscriptions.whatsapp","subscriptions.whatsapp.conversational","subscriptions.whatsapp.conversational.can_receive","subscriptions.whatsapp.conversational.consent","subscriptions.whatsapp.conversational.consent_timestamp","subscriptions.whatsapp.conversational.created_timestamp","subscriptions.whatsapp.conversational.last_updated","subscriptions.whatsapp.conversational.metadata","subscriptions.whatsapp.conversational.phone_number","subscriptions.whatsapp.conversational.valid_until","subscriptions.whatsapp.marketing","subscriptions.whatsapp.marketing.can_receive","subscriptions.whatsapp.marketing.consent","subscriptions.whatsapp.marketing.consent_timestamp","subscriptions.whatsapp.marketing.created_timestamp","subscriptions.whatsapp.marketing.last_updated","subscriptions.whatsapp.marketing.metadata","subscriptions.whatsapp.marketing.phone_number","subscriptions.whatsapp.marketing.valid_until","subscriptions.whatsapp.transactional","subscriptions.whatsapp.transactional.can_receive","subscriptions.whatsapp.transactional.consent","subscriptions.whatsapp.transactional.consent_timestamp","subscriptions.whatsapp.transactional.created_timestamp","subscriptions.whatsapp.transactional.last_updated","subscriptions.whatsapp.transactional.metadata","subscriptions.whatsapp.transactional.phone_number","subscriptions.whatsapp.transactional.valid_until","title","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ProfilePartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "01GDDKASAP8TKDDA2GRZDSVP4H"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "profile",
"id": "01GDDKASAP8TKDDA2GRZDSVP4H",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Import Profiles Jobs — klaviyo.get_bulk_import_profiles_jobs
Get all bulk profile import jobs.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[profile-bulk-import-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile-bulk-import-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","expires_at","failed_count","id","started_at","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: any, equals (allowed values: 'queued', 'processing', 'complete') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created_at","-created_at"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Import Profiles — klaviyo.bulk_import_profiles
Create a bulk profile import job to create or update a batch of profiles.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[profile-bulk-import-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile-bulk-import-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","expires_at","failed_count","id","started_at","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ProfileImportJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "profile-bulk-import-job",
"attributes": {
"profiles": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Import Profiles Job — klaviyo.get_bulk_import_profiles_job
Get a bulk profile import job with the given job ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[list] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[list][] |
string | Optional | enum: ["created","id","name","opt_in_process","updated"] |
|
query.fields[profile-bulk-import-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile-bulk-import-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","expires_at","failed_count","id","started_at","status","total_count"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["lists"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Suppress Profiles Jobs — klaviyo.get_bulk_suppress_profiles_jobs
Get the status of all bulk profile suppression jobs. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[profile-suppression-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile-suppression-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","id","skipped_count","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: equals (allowed values: 'queued', 'processing', 'complete', 'cancelled') list_id: equals (string) segment_id: equals (string) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Suppress Profiles — klaviyo.bulk_suppress_profiles
Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[profile-suppression-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile-suppression-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","id","skipped_count","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/SuppressionCreateJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "profile-suppression-bulk-create-job",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Suppress Profiles Job — klaviyo.get_bulk_suppress_profiles_job
Get the bulk suppress profiles job with the given job ID. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[profile-suppression-bulk-create-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile-suppression-bulk-create-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","id","skipped_count","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Unsuppress Profiles Jobs — klaviyo.get_bulk_unsuppress_profiles_jobs
Get all bulk unsuppress profiles jobs. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[profile-suppression-bulk-delete-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile-suppression-bulk-delete-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","id","skipped_count","status","total_count"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): status: equals (allowed values: 'queued', 'processing', 'complete', 'cancelled') list_id: equals (string) segment_id: equals (string) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Unsuppress Profiles — klaviyo.bulk_unsuppress_profiles
Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[profile-suppression-bulk-delete-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile-suppression-bulk-delete-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","id","skipped_count","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/SuppressionDeleteJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "profile-suppression-bulk-delete-job",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Bulk Unsuppress Profiles Job — klaviyo.get_bulk_unsuppress_profiles_job
Get the bulk unsuppress profiles job with the given job ID. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.job_id |
string | Required | ID of the job to retrieve. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[profile-suppression-bulk-delete-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile-suppression-bulk-delete-job][] |
string | Optional | enum: ["completed_at","completed_count","created_at","id","skipped_count","status","total_count"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"job_id": "01GSQPBF74KQ5YTDEPP41T1BZH"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Push Tokens — klaviyo.get_push_tokens
Return push tokens associated with company. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","properties","title","updated"] |
|
query.fields[push-token] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[push-token][] |
string | Optional | enum: ["background","created","enablement_status","id","metadata","metadata.app_build","metadata.app_id","metadata.app_name","metadata.app_version","metadata.device_id","metadata.device_model","metadata.environment","metadata.klaviyo_sdk","metadata.manufacturer","metadata.os_name","metadata.os_version","metadata.sdk_version","platform","recorded_date","token","vendor"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: equals (string) profile.id: equals (string) enablement_status: equals (allowed values: 'AUTHORIZED', 'UNAUTHORIZED', 'DENIED', 'PROVISIONAL', 'NOT_DETERMINED') platform: equals (allowed values: 'ios', 'android') |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["profile"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create or Update Push Token — klaviyo.create_push_token
Create or update a push token.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/PushTokenCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "push-token",
"attributes": {
"token": "1234567890",
"platform": "android",
"vendor": "apns",
"profile": {
"data": {
"type": "profile",
"attributes": {}
}
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Push Token — klaviyo.get_push_token
Return a specific push token based on its ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The value of the push token | |
query |
object | Optional | additionalProperties: false |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","properties","title","updated"] |
|
query.fields[push-token] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[push-token][] |
string | Optional | enum: ["background","created","enablement_status","id","metadata","metadata.app_build","metadata.app_id","metadata.app_name","metadata.app_version","metadata.device_id","metadata.device_model","metadata.environment","metadata.klaviyo_sdk","metadata.manufacturer","metadata.os_name","metadata.os_version","metadata.sdk_version","platform","recorded_date","token","vendor"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["profile"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Push Token — klaviyo.delete_push_token
Delete a specific push token based on its ID. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The value of the push token to delete | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb405715f3616c337cc65c"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create or Update Profile — klaviyo.create_or_update_profile
Given a set of profile attributes and optionally an ID, create or update a profile.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[profile] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | |
query.additional-fields[profile][] |
string | Optional | enum: ["subscriptions","predictive_analytics"] |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","predictive_analytics","predictive_analytics.average_days_between_orders","predictive_analytics.average_order_value","predictive_analytics.churn_probability","predictive_analytics.expected_date_of_next_order","predictive_analytics.historic_clv","predictive_analytics.historic_number_of_orders","predictive_analytics.predicted_clv","predictive_analytics.predicted_number_of_orders","predictive_analytics.ranked_channel_affinity","predictive_analytics.total_clv","properties","subscriptions","subscriptions.email","subscriptions.email.click_tracking","subscriptions.email.click_tracking.can_receive","subscriptions.email.click_tracking.consent","subscriptions.email.click_tracking.consent_timestamp","subscriptions.email.click_tracking.created_timestamp","subscriptions.email.click_tracking.last_updated","subscriptions.email.click_tracking.metadata","subscriptions.email.click_tracking.valid_until","subscriptions.email.marketing","subscriptions.email.marketing.can_receive_email_marketing","subscriptions.email.marketing.consent","subscriptions.email.marketing.consent_timestamp","subscriptions.email.marketing.custom_method_detail","subscriptions.email.marketing.double_optin","subscriptions.email.marketing.last_updated","subscriptions.email.marketing.list_suppressions","subscriptions.email.marketing.method","subscriptions.email.marketing.method_detail","subscriptions.email.marketing.suppression","subscriptions.email.open_tracking","subscriptions.email.open_tracking.can_receive","subscriptions.email.open_tracking.consent","subscriptions.email.open_tracking.consent_timestamp","subscriptions.email.open_tracking.created_timestamp","subscriptions.email.open_tracking.last_updated","subscriptions.email.open_tracking.metadata","subscriptions.email.open_tracking.valid_until","subscriptions.mobile_push","subscriptions.mobile_push.marketing","subscriptions.mobile_push.marketing.can_receive_push_marketing","subscriptions.mobile_push.marketing.consent","subscriptions.mobile_push.marketing.consent_timestamp","subscriptions.sms","subscriptions.sms.marketing","subscriptions.sms.marketing.can_receive_sms_marketing","subscriptions.sms.marketing.consent","subscriptions.sms.marketing.consent_timestamp","subscriptions.sms.marketing.last_updated","subscriptions.sms.marketing.method","subscriptions.sms.marketing.method_detail","subscriptions.sms.transactional","subscriptions.sms.transactional.can_receive_sms_transactional","subscriptions.sms.transactional.consent","subscriptions.sms.transactional.consent_timestamp","subscriptions.sms.transactional.last_updated","subscriptions.sms.transactional.method","subscriptions.sms.transactional.method_detail","subscriptions.whatsapp","subscriptions.whatsapp.conversational","subscriptions.whatsapp.conversational.can_receive","subscriptions.whatsapp.conversational.consent","subscriptions.whatsapp.conversational.consent_timestamp","subscriptions.whatsapp.conversational.created_timestamp","subscriptions.whatsapp.conversational.last_updated","subscriptions.whatsapp.conversational.metadata","subscriptions.whatsapp.conversational.phone_number","subscriptions.whatsapp.conversational.valid_until","subscriptions.whatsapp.marketing","subscriptions.whatsapp.marketing.can_receive","subscriptions.whatsapp.marketing.consent","subscriptions.whatsapp.marketing.consent_timestamp","subscriptions.whatsapp.marketing.created_timestamp","subscriptions.whatsapp.marketing.last_updated","subscriptions.whatsapp.marketing.metadata","subscriptions.whatsapp.marketing.phone_number","subscriptions.whatsapp.marketing.valid_until","subscriptions.whatsapp.transactional","subscriptions.whatsapp.transactional.can_receive","subscriptions.whatsapp.transactional.consent","subscriptions.whatsapp.transactional.consent_timestamp","subscriptions.whatsapp.transactional.created_timestamp","subscriptions.whatsapp.transactional.last_updated","subscriptions.whatsapp.transactional.metadata","subscriptions.whatsapp.transactional.phone_number","subscriptions.whatsapp.transactional.valid_until","title","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ProfileUpsertQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "profile",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Merge Profiles — klaviyo.merge_profiles
Merge a given related profile into a profile with the given profile ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["id"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ProfileMergeQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "profile-merge",
"id": "01GDDKASAP8TKDDA2GRZDSVP4H",
"relationships": {
"profiles": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Subscribe Profiles — klaviyo.bulk_subscribe_profiles
Subscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message. Learn more about consent in this guide.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/SubscriptionCreateJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "profile-subscription-bulk-create-job",
"attributes": {
"profiles": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Bulk Unsubscribe Profiles — klaviyo.bulk_unsubscribe_profiles
> 🚧 > > Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/SubscriptionDeleteJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "profile-subscription-bulk-delete-job",
"attributes": {
"profiles": {
"data": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Push Tokens for Profile — klaviyo.get_push_tokens_for_profile
Return all push tokens that belong to the given profile. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[push-token] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[push-token][] |
string | Optional | enum: ["background","created","enablement_status","id","metadata","metadata.app_build","metadata.app_id","metadata.app_name","metadata.app_version","metadata.device_id","metadata.device_model","metadata.environment","metadata.klaviyo_sdk","metadata.manufacturer","metadata.os_name","metadata.os_version","metadata.sdk_version","platform","recorded_date","token","vendor"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Push Token IDs for Profile — klaviyo.get_push_token_ids_for_profile
Return the IDs of all push tokens associated with the given profile. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Lists for Profile — klaviyo.get_lists_for_profile
Get list memberships for a profile with the given profile ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[list] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[list][] |
string | Optional | enum: ["created","id","name","opt_in_process","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get List IDs for Profile — klaviyo.get_list_ids_for_profile
Get list memberships for a profile with the given profile ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Segments for Profile — klaviyo.get_segments_for_profile
Get segment memberships for a profile with the given profile ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[segment] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[segment][] |
string | Optional | enum: ["created","definition","definition.condition_groups","id","is_active","is_processing","is_starred","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Segment IDs for Profile — klaviyo.get_segment_ids_for_profile
Get segment membership relationships for a profile with the given profile ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Conversation for Profile — klaviyo.get_conversation_for_profile
Get the conversation for a profile with the given profile ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[conversation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[conversation][] |
string | Optional | enum: ["channel","id"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Conversation ID for Profile — klaviyo.get_conversation_id_for_profile
Get the conversation relationship for a profile with the given profile ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Conversations for Profile — klaviyo.get_conversations_for_profile
Get all conversations for a profile with the given profile ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[conversation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[conversation][] |
string | Optional | enum: ["channel","id"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Conversation IDs for Profile — klaviyo.get_conversation_ids_for_profile
Get the IDs of all conversations for a profile across all channels. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get List for Bulk Import Profiles Job — klaviyo.get_list_for_bulk_import_profiles_job
Get list for the bulk profile import job with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[list] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[list][] |
string | Optional | enum: ["created","id","name","opt_in_process","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get List IDs for Bulk Import Profiles Job — klaviyo.get_list_ids_for_bulk_import_profiles_job
Get list relationship for the bulk profile import job with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profiles for Bulk Import Profiles Job — klaviyo.get_profiles_for_bulk_import_profiles_job
Get profiles for the bulk profile import job with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[profile] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | |
query.additional-fields[profile][] |
string | Optional | enum: ["subscriptions","predictive_analytics"] |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","predictive_analytics","predictive_analytics.average_days_between_orders","predictive_analytics.average_order_value","predictive_analytics.churn_probability","predictive_analytics.expected_date_of_next_order","predictive_analytics.historic_clv","predictive_analytics.historic_number_of_orders","predictive_analytics.predicted_clv","predictive_analytics.predicted_number_of_orders","predictive_analytics.ranked_channel_affinity","predictive_analytics.total_clv","properties","subscriptions","subscriptions.email","subscriptions.email.click_tracking","subscriptions.email.click_tracking.can_receive","subscriptions.email.click_tracking.consent","subscriptions.email.click_tracking.consent_timestamp","subscriptions.email.click_tracking.created_timestamp","subscriptions.email.click_tracking.last_updated","subscriptions.email.click_tracking.metadata","subscriptions.email.click_tracking.valid_until","subscriptions.email.marketing","subscriptions.email.marketing.can_receive_email_marketing","subscriptions.email.marketing.consent","subscriptions.email.marketing.consent_timestamp","subscriptions.email.marketing.custom_method_detail","subscriptions.email.marketing.double_optin","subscriptions.email.marketing.last_updated","subscriptions.email.marketing.list_suppressions","subscriptions.email.marketing.method","subscriptions.email.marketing.method_detail","subscriptions.email.marketing.suppression","subscriptions.email.open_tracking","subscriptions.email.open_tracking.can_receive","subscriptions.email.open_tracking.consent","subscriptions.email.open_tracking.consent_timestamp","subscriptions.email.open_tracking.created_timestamp","subscriptions.email.open_tracking.last_updated","subscriptions.email.open_tracking.metadata","subscriptions.email.open_tracking.valid_until","subscriptions.mobile_push","subscriptions.mobile_push.marketing","subscriptions.mobile_push.marketing.can_receive_push_marketing","subscriptions.mobile_push.marketing.consent","subscriptions.mobile_push.marketing.consent_timestamp","subscriptions.sms","subscriptions.sms.marketing","subscriptions.sms.marketing.can_receive_sms_marketing","subscriptions.sms.marketing.consent","subscriptions.sms.marketing.consent_timestamp","subscriptions.sms.marketing.last_updated","subscriptions.sms.marketing.method","subscriptions.sms.marketing.method_detail","subscriptions.sms.transactional","subscriptions.sms.transactional.can_receive_sms_transactional","subscriptions.sms.transactional.consent","subscriptions.sms.transactional.consent_timestamp","subscriptions.sms.transactional.last_updated","subscriptions.sms.transactional.method","subscriptions.sms.transactional.method_detail","subscriptions.whatsapp","subscriptions.whatsapp.conversational","subscriptions.whatsapp.conversational.can_receive","subscriptions.whatsapp.conversational.consent","subscriptions.whatsapp.conversational.consent_timestamp","subscriptions.whatsapp.conversational.created_timestamp","subscriptions.whatsapp.conversational.last_updated","subscriptions.whatsapp.conversational.metadata","subscriptions.whatsapp.conversational.phone_number","subscriptions.whatsapp.conversational.valid_until","subscriptions.whatsapp.marketing","subscriptions.whatsapp.marketing.can_receive","subscriptions.whatsapp.marketing.consent","subscriptions.whatsapp.marketing.consent_timestamp","subscriptions.whatsapp.marketing.created_timestamp","subscriptions.whatsapp.marketing.last_updated","subscriptions.whatsapp.marketing.metadata","subscriptions.whatsapp.marketing.phone_number","subscriptions.whatsapp.marketing.valid_until","subscriptions.whatsapp.transactional","subscriptions.whatsapp.transactional.can_receive","subscriptions.whatsapp.transactional.consent","subscriptions.whatsapp.transactional.consent_timestamp","subscriptions.whatsapp.transactional.created_timestamp","subscriptions.whatsapp.transactional.last_updated","subscriptions.whatsapp.transactional.metadata","subscriptions.whatsapp.transactional.phone_number","subscriptions.whatsapp.transactional.valid_until","title","updated"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profile IDs for Bulk Import Profiles Job — klaviyo.get_profile_ids_for_bulk_import_profiles_job
Get profile relationships for the bulk profile import job with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Errors for Bulk Import Profiles Job — klaviyo.get_errors_for_bulk_import_profiles_job
Get import errors for the bulk profile import job with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[import-error] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[import-error][] |
string | Optional | enum: ["code","detail","id","original_payload","source","source.pointer","title"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profile for Push Token — klaviyo.get_profile_for_push_token
Return the profile associated with the given push token. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The value of the push token | |
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[profile] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | |
query.additional-fields[profile][] |
string | Optional | enum: ["subscriptions","predictive_analytics"] |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","predictive_analytics","predictive_analytics.average_days_between_orders","predictive_analytics.average_order_value","predictive_analytics.churn_probability","predictive_analytics.expected_date_of_next_order","predictive_analytics.historic_clv","predictive_analytics.historic_number_of_orders","predictive_analytics.predicted_clv","predictive_analytics.predicted_number_of_orders","predictive_analytics.ranked_channel_affinity","predictive_analytics.total_clv","properties","subscriptions","subscriptions.email","subscriptions.email.click_tracking","subscriptions.email.click_tracking.can_receive","subscriptions.email.click_tracking.consent","subscriptions.email.click_tracking.consent_timestamp","subscriptions.email.click_tracking.created_timestamp","subscriptions.email.click_tracking.last_updated","subscriptions.email.click_tracking.metadata","subscriptions.email.click_tracking.valid_until","subscriptions.email.marketing","subscriptions.email.marketing.can_receive_email_marketing","subscriptions.email.marketing.consent","subscriptions.email.marketing.consent_timestamp","subscriptions.email.marketing.custom_method_detail","subscriptions.email.marketing.double_optin","subscriptions.email.marketing.last_updated","subscriptions.email.marketing.list_suppressions","subscriptions.email.marketing.method","subscriptions.email.marketing.method_detail","subscriptions.email.marketing.suppression","subscriptions.email.open_tracking","subscriptions.email.open_tracking.can_receive","subscriptions.email.open_tracking.consent","subscriptions.email.open_tracking.consent_timestamp","subscriptions.email.open_tracking.created_timestamp","subscriptions.email.open_tracking.last_updated","subscriptions.email.open_tracking.metadata","subscriptions.email.open_tracking.valid_until","subscriptions.mobile_push","subscriptions.mobile_push.marketing","subscriptions.mobile_push.marketing.can_receive_push_marketing","subscriptions.mobile_push.marketing.consent","subscriptions.mobile_push.marketing.consent_timestamp","subscriptions.sms","subscriptions.sms.marketing","subscriptions.sms.marketing.can_receive_sms_marketing","subscriptions.sms.marketing.consent","subscriptions.sms.marketing.consent_timestamp","subscriptions.sms.marketing.last_updated","subscriptions.sms.marketing.method","subscriptions.sms.marketing.method_detail","subscriptions.sms.transactional","subscriptions.sms.transactional.can_receive_sms_transactional","subscriptions.sms.transactional.consent","subscriptions.sms.transactional.consent_timestamp","subscriptions.sms.transactional.last_updated","subscriptions.sms.transactional.method","subscriptions.sms.transactional.method_detail","subscriptions.whatsapp","subscriptions.whatsapp.conversational","subscriptions.whatsapp.conversational.can_receive","subscriptions.whatsapp.conversational.consent","subscriptions.whatsapp.conversational.consent_timestamp","subscriptions.whatsapp.conversational.created_timestamp","subscriptions.whatsapp.conversational.last_updated","subscriptions.whatsapp.conversational.metadata","subscriptions.whatsapp.conversational.phone_number","subscriptions.whatsapp.conversational.valid_until","subscriptions.whatsapp.marketing","subscriptions.whatsapp.marketing.can_receive","subscriptions.whatsapp.marketing.consent","subscriptions.whatsapp.marketing.consent_timestamp","subscriptions.whatsapp.marketing.created_timestamp","subscriptions.whatsapp.marketing.last_updated","subscriptions.whatsapp.marketing.metadata","subscriptions.whatsapp.marketing.phone_number","subscriptions.whatsapp.marketing.valid_until","subscriptions.whatsapp.transactional","subscriptions.whatsapp.transactional.can_receive","subscriptions.whatsapp.transactional.consent","subscriptions.whatsapp.transactional.consent_timestamp","subscriptions.whatsapp.transactional.created_timestamp","subscriptions.whatsapp.transactional.last_updated","subscriptions.whatsapp.transactional.metadata","subscriptions.whatsapp.transactional.phone_number","subscriptions.whatsapp.transactional.valid_until","title","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profile ID for Push Token — klaviyo.get_profile_id_for_push_token
Return the ID of the profile associated with the given push token. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The value of the push token | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Query Campaign Values — klaviyo.query_campaign_values
Returns the requested campaign analytics values data Rate limits: Burst: 1/s Steady: 2/m Daily: 225/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-values-report] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-values-report][] |
string | Optional | enum: ["id","results"] |
|
query.page_cursor |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/CampaignValuesRequestDTO" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "campaign-values-report",
"attributes": {
"statistics": [
"opens",
"open_rate"
],
"timeframe": {
"key": "last_12_months"
},
"conversion_metric_id": "RESQ6t"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Query Flow Values — klaviyo.query_flow_values
Returns the requested flow analytics values data Rate limits: Burst: 1/s Steady: 2/m Daily: 225/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[flow-values-report] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-values-report][] |
string | Optional | enum: ["id","results"] |
|
query.page_cursor |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/FlowValuesRequestDTO" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "flow-values-report",
"attributes": {
"statistics": [
"opens",
"open_rate"
],
"timeframe": {
"key": "last_12_months"
},
"conversion_metric_id": "RESQ6t"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Query Flow Series — klaviyo.query_flow_series
Returns the requested flow analytics series data Rate limits: Burst: 1/s Steady: 2/m Daily: 225/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[flow-series-report] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-series-report][] |
string | Optional | enum: ["date_times","id","results"] |
|
query.page_cursor |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/FlowSeriesRequestDTO" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "flow-series-report",
"attributes": {
"statistics": [
"opens",
"open_rate"
],
"timeframe": {
"key": "last_12_months"
},
"interval": "weekly",
"conversion_metric_id": "RESQ6t"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Query Form Values — klaviyo.query_form_values
Returns the requested form analytics values data. Rate limits: Burst: 1/s Steady: 2/m Daily: 225/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[form-values-report] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[form-values-report][] |
string | Optional | enum: ["id","results"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/FormValuesRequestDTO" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "form-values-report",
"attributes": {
"statistics": [
"viewed_form",
"submit_rate"
],
"timeframe": {
"key": "last_12_months"
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Query Form Series — klaviyo.query_form_series
Returns the requested form analytics series data. Rate limits: Burst: 1/s Steady: 2/m Daily: 225/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[form-series-report] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[form-series-report][] |
string | Optional | enum: ["date_times","id","results"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/FormSeriesRequestDTO" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "form-series-report",
"attributes": {
"statistics": [
"viewed_form",
"submit_rate"
],
"timeframe": {
"key": "last_12_months"
},
"interval": "weekly"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Query Segment Values — klaviyo.query_segment_values
Returns the requested segment analytics values data. Rate limits: Burst: 1/s Steady: 2/m Daily: 225/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[segment-values-report] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[segment-values-report][] |
string | Optional | enum: ["id","results"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/SegmentValuesRequestDTO" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "segment-values-report",
"attributes": {
"statistics": [
"total_members",
"net_members_changed"
],
"timeframe": {
"key": "last_12_months"
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Query Segment Series — klaviyo.query_segment_series
Returns the requested segment analytics series data. Rate limits: Burst: 1/s Steady: 2/m Daily: 225/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[segment-series-report] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[segment-series-report][] |
string | Optional | enum: ["date_times","id","results"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/SegmentSeriesRequestDTO" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "segment-series-report",
"attributes": {
"statistics": [
"total_members",
"net_members_changed"
],
"timeframe": {
"key": "last_12_months"
},
"interval": "weekly"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Reviews — klaviyo.get_reviews
Get all reviews. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[event] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[event][] |
string | Optional | enum: ["datetime","event_properties","id","timestamp","uuid"] |
|
query.fields[review] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[review][] |
string | Optional | enum: ["author","content","created","email","id","images","product","product.external_id","product.image_url","product.name","product.url","public_reply","public_reply.author","public_reply.content","public_reply.updated","rating","review_type","smart_quote","status","status.rejection_reason","status.rejection_reason.reason","status.rejection_reason.status_explanation","status.value","title","updated","verified"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): created: greater-or-equal, less-or-equal (date-time) rating: any, equals, greater-or-equal, less-or-equal (integer) id: any, equals (string) item.id: any, equals (string) content: contains (string) status: equals (allowed values: 'published', 'unpublished', 'rejected', 'featured', 'pending', 'all') review_type: equals (allowed values: 'question', 'review', 'rating', 'store') verified: equals (boolean) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["events"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created","rating","-rating","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Review — klaviyo.get_review
Get the review with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the review | |
query |
object | Optional | additionalProperties: false |
|
query.fields[event] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[event][] |
string | Optional | enum: ["datetime","event_properties","id","timestamp","uuid"] |
|
query.fields[review] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[review][] |
string | Optional | enum: ["author","content","created","email","id","images","product","product.external_id","product.image_url","product.name","product.url","public_reply","public_reply.author","public_reply.content","public_reply.updated","rating","review_type","smart_quote","status","status.rejection_reason","status.rejection_reason.reason","status.rejection_reason.status_explanation","status.value","title","updated","verified"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["events"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "2134228"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Review — klaviyo.update_review
Update a review. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The id of the review (review ID). | |
query |
object | Optional | additionalProperties: false |
|
query.fields[review] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[review][] |
string | Optional | enum: ["author","content","created","email","id","images","product","product.external_id","product.image_url","product.name","product.url","public_reply","public_reply.author","public_reply.content","public_reply.updated","rating","review_type","smart_quote","status","status.rejection_reason","status.rejection_reason.reason","status.rejection_reason.status_explanation","status.value","title","updated","verified"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/ReviewPatchQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "review",
"id": "example",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Segments — klaviyo.get_segments
Get all segments in an account.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
query.fields[segment] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[segment][] |
string | Optional | enum: ["created","definition","definition.condition_groups","id","is_active","is_processing","is_starred","name","updated"] |
|
query.fields[tag] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag][] |
string | Optional | enum: ["id","name"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): name: any, equals (string) id: any, equals (string) created: greater-than (date-time) updated: greater-than (date-time) is_active: any, equals (boolean) is_starred: equals (boolean) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["flow-triggers","tags"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 10. Min: 1. Max: 10. | default: 10; minimum: 1; maximum: 10 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created","id","-id","name","-name","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Segment — klaviyo.create_segment
Create a segment. Rate limits: Burst: 1/s Steady: 15/m Daily: 100/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[segment] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[segment][] |
string | Optional | enum: ["created","definition","definition.condition_groups","id","is_active","is_processing","is_starred","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/SegmentCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "segment",
"attributes": {
"name": "example",
"definition": {
"condition_groups": []
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Segment — klaviyo.get_segment
Get a segment with the given segment ID. Rate limits: Burst: 75/s Steady: 750/m Rate limits when using the additional-fields[segment]=profile_count parameter in your API request: Burst: 1/s Steady: 15/m To learn more about how the additional-fields parameter impacts rate limits, check out our Rate limits, status codes, and errors guide.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[segment] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'profile_count' | |
query.additional-fields[segment][] |
string | Optional | enum: ["profile_count"] |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
query.fields[segment] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[segment][] |
string | Optional | enum: ["created","definition","definition.condition_groups","id","is_active","is_processing","is_starred","name","profile_count","updated"] |
|
query.fields[tag] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag][] |
string | Optional | enum: ["id","name"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["flow-triggers","tags"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Segment — klaviyo.update_segment
Update a segment with the given segment ID. Rate limits: Burst: 1/s Steady: 15/m Daily: 100/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
query |
object | Optional | additionalProperties: false |
|
query.fields[segment] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[segment][] |
string | Optional | enum: ["created","definition","definition.condition_groups","id","is_active","is_processing","is_starred","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/SegmentPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "segment",
"id": "example",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Segment — klaviyo.delete_segment
Delete a segment with the given segment ID. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tag IDs for Segment — klaviyo.get_tag_ids_for_segment
If related_resource is tags, returns the tag IDs of all tags associated with the given segment ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ||
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profiles for Segment — klaviyo.get_profiles_for_segment
Get all profiles within a segment with the given segment ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this segment. Generated by Klaviyo. | |
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[profile] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics' | |
query.additional-fields[profile][] |
string | Optional | enum: ["subscriptions","predictive_analytics"] |
|
query.fields[profile] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[profile][] |
string | Optional | enum: ["created","email","external_id","first_name","id","image","joined_group_at","last_event_date","last_name","locale","location","location.address1","location.address2","location.city","location.country","location.ip","location.latitude","location.longitude","location.region","location.timezone","location.zip","organization","phone_number","predictive_analytics","predictive_analytics.average_days_between_orders","predictive_analytics.average_order_value","predictive_analytics.churn_probability","predictive_analytics.expected_date_of_next_order","predictive_analytics.historic_clv","predictive_analytics.historic_number_of_orders","predictive_analytics.predicted_clv","predictive_analytics.predicted_number_of_orders","predictive_analytics.ranked_channel_affinity","predictive_analytics.total_clv","properties","subscriptions","subscriptions.email","subscriptions.email.click_tracking","subscriptions.email.click_tracking.can_receive","subscriptions.email.click_tracking.consent","subscriptions.email.click_tracking.consent_timestamp","subscriptions.email.click_tracking.created_timestamp","subscriptions.email.click_tracking.last_updated","subscriptions.email.click_tracking.metadata","subscriptions.email.click_tracking.valid_until","subscriptions.email.marketing","subscriptions.email.marketing.can_receive_email_marketing","subscriptions.email.marketing.consent","subscriptions.email.marketing.consent_timestamp","subscriptions.email.marketing.custom_method_detail","subscriptions.email.marketing.double_optin","subscriptions.email.marketing.last_updated","subscriptions.email.marketing.list_suppressions","subscriptions.email.marketing.method","subscriptions.email.marketing.method_detail","subscriptions.email.marketing.suppression","subscriptions.email.open_tracking","subscriptions.email.open_tracking.can_receive","subscriptions.email.open_tracking.consent","subscriptions.email.open_tracking.consent_timestamp","subscriptions.email.open_tracking.created_timestamp","subscriptions.email.open_tracking.last_updated","subscriptions.email.open_tracking.metadata","subscriptions.email.open_tracking.valid_until","subscriptions.mobile_push","subscriptions.mobile_push.marketing","subscriptions.mobile_push.marketing.can_receive_push_marketing","subscriptions.mobile_push.marketing.consent","subscriptions.mobile_push.marketing.consent_timestamp","subscriptions.sms","subscriptions.sms.marketing","subscriptions.sms.marketing.can_receive_sms_marketing","subscriptions.sms.marketing.consent","subscriptions.sms.marketing.consent_timestamp","subscriptions.sms.marketing.last_updated","subscriptions.sms.marketing.method","subscriptions.sms.marketing.method_detail","subscriptions.sms.transactional","subscriptions.sms.transactional.can_receive_sms_transactional","subscriptions.sms.transactional.consent","subscriptions.sms.transactional.consent_timestamp","subscriptions.sms.transactional.last_updated","subscriptions.sms.transactional.method","subscriptions.sms.transactional.method_detail","subscriptions.whatsapp","subscriptions.whatsapp.conversational","subscriptions.whatsapp.conversational.can_receive","subscriptions.whatsapp.conversational.consent","subscriptions.whatsapp.conversational.consent_timestamp","subscriptions.whatsapp.conversational.created_timestamp","subscriptions.whatsapp.conversational.last_updated","subscriptions.whatsapp.conversational.metadata","subscriptions.whatsapp.conversational.phone_number","subscriptions.whatsapp.conversational.valid_until","subscriptions.whatsapp.marketing","subscriptions.whatsapp.marketing.can_receive","subscriptions.whatsapp.marketing.consent","subscriptions.whatsapp.marketing.consent_timestamp","subscriptions.whatsapp.marketing.created_timestamp","subscriptions.whatsapp.marketing.last_updated","subscriptions.whatsapp.marketing.metadata","subscriptions.whatsapp.marketing.phone_number","subscriptions.whatsapp.marketing.valid_until","subscriptions.whatsapp.transactional","subscriptions.whatsapp.transactional.can_receive","subscriptions.whatsapp.transactional.consent","subscriptions.whatsapp.transactional.consent_timestamp","subscriptions.whatsapp.transactional.created_timestamp","subscriptions.whatsapp.transactional.last_updated","subscriptions.whatsapp.transactional.metadata","subscriptions.whatsapp.transactional.phone_number","subscriptions.whatsapp.transactional.valid_until","title","updated"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): profile_id: any, equals (string) email: any, equals (string) phone_number: any, equals (string) push_token: any, equals (string) _kx: equals (string) joined_group_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["joined_group_at","-joined_group_at"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Profile IDs for Segment — klaviyo.get_profile_ids_for_segment
Get all profile membership relationships for the given segment ID. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this segment. Generated by Klaviyo. | |
query |
object | Optional | additionalProperties: false |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): profile_id: any, equals (string) email: any, equals (string) phone_number: any, equals (string) push_token: any, equals (string) _kx: equals (string) joined_group_at: greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["joined_group_at","-joined_group_at"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Flows Triggered by Segment — klaviyo.get_flows_triggered_by_segment
Get all flows where the given segment ID is being used as the trigger. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this segment. Generated by Klaviyo. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[flow] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow][] |
string | Optional | enum: ["archived","created","id","name","status","trigger_type","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get IDs for Flows Triggered by Segment — klaviyo.get_ids_for_flows_triggered_by_segment
Get the IDs of all flows where the given segment is being used as the trigger. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | Primary key that uniquely identifies this segment. Generated by Klaviyo. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "Y6nRLr"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Tag — klaviyo.create_tag
Create a tag. An account cannot have more than 500 unique tags.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[tag] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag][] |
string | Optional | enum: ["id","name"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TagCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "tag",
"attributes": {
"name": "My Tag"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tag — klaviyo.get_tag
Retrieve the tag with the given tag ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
query |
object | Optional | additionalProperties: false |
|
query.fields[tag-group] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag-group][] |
string | Optional | enum: ["default","exclusive","id","name"] |
|
query.fields[tag] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag][] |
string | Optional | enum: ["id","name"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["tag-group"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Tag — klaviyo.update_tag
Update the tag with the given tag ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TagUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "tag",
"id": "abcd1234-ef56-gh78-ij90-abcdef123456",
"attributes": {
"name": "My Tag"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Tag — klaviyo.delete_tag
Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed. Rate limits: Burst: 3/s Steady: 60/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tag Groups — klaviyo.get_tag_groups
List all tag groups in an account. Every account has one default tag group.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[tag-group] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag-group][] |
string | Optional | enum: ["default","exclusive","id","name"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): name: contains, ends-with, equals, starts-with (string) exclusive: equals (boolean) default: equals (boolean) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 25. Min: 1. Max: 25. | default: 25; minimum: 1; maximum: 25 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["id","-id","name","-name"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Tag Group — klaviyo.create_tag_group
Create a tag group. An account cannot have more than 50 unique tag groups.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[tag-group] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag-group][] |
string | Optional | enum: ["default","exclusive","id","name"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TagGroupCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "tag-group",
"attributes": {
"name": "My Tag Group"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tag Group — klaviyo.get_tag_group
Retrieve the tag group with the given tag group ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag Group ID | |
query |
object | Optional | additionalProperties: false |
|
query.fields[tag-group] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag-group][] |
string | Optional | enum: ["default","exclusive","id","name"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "zyxw9876-vu54-ts32-rq10-zyxwvu654321"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Tag Group — klaviyo.update_tag_group
Update the tag group with the given tag group ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag Group ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TagGroupUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "zyxw9876-vu54-ts32-rq10-zyxwvu654321"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "tag-group",
"id": "zyxw9876-vu54-ts32-rq10-zyxwvu654321",
"attributes": {
"name": "My Tag Group"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Tag Group — klaviyo.delete_tag_group
Delete the tag group with the given tag group ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag Group ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "zyxw9876-vu54-ts32-rq10-zyxwvu654321"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Flow IDs for Tag — klaviyo.get_flow_ids_for_tag
Returns the IDs of all flows associated with the given tag. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Tag Flows — klaviyo.tag_flows
Associate a tag with one or more flows. Any flow cannot be associated with more than 100 tags.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TagFlowOp" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Tag from Flows — klaviyo.remove_tag_from_flows
Remove a tag's association with one or more flows.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TagFlowOp" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign IDs for Tag — klaviyo.get_campaign_ids_for_tag
Returns the IDs of all campaigns associated with the given tag. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Tag Campaigns — klaviyo.tag_campaigns
Associate a tag with one or more campaigns. Any campaign cannot be associated with more than 100 tags.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TagCampaignOp" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Tag from Campaigns — klaviyo.remove_tag_from_campaigns
Remove a tag's association with one or more campaigns.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TagCampaignOp" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get List IDs for Tag — klaviyo.get_list_ids_for_tag
Returns the IDs of all lists associated with the given tag. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Tag Lists — klaviyo.tag_lists
Associate a tag with one or more lists. Any list cannot be associated with more than 100 tags.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TagListOp" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Tag from Lists — klaviyo.remove_tag_from_lists
Remove a tag's association with one or more lists.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TagListOp" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Segment IDs for Tag — klaviyo.get_segment_ids_for_tag
Returns the IDs of all segments associated with the given tag. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Tag Segments — klaviyo.tag_segments
Associate a tag with one or more segments. Any segment cannot be associated with more than 100 tags.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TagSegmentOp" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Remove Tag from Segments — klaviyo.remove_tag_from_segments
Remove a tag's association with one or more segments.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TagSegmentOp" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": []
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tag Group for Tag — klaviyo.get_tag_group_for_tag
Returns the tag group resource for a given tag ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
query |
object | Optional | additionalProperties: false |
|
query.fields[tag-group] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tag-group][] |
string | Optional | enum: ["default","exclusive","id","name"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tag Group ID for Tag — klaviyo.get_tag_group_id_for_tag
Returns the id of the tag group related to the given tag. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "abcd1234-ef56-gh78-ij90-abcdef123456"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tag IDs for Tag Group — klaviyo.get_tag_ids_for_tag_group
Returns the tag IDs of all tags inside the given tag group. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The Tag Group ID | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "zyxw9876-vu54-ts32-rq10-zyxwvu654321"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Templates — klaviyo.get_templates
Get all templates in an account.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[template] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'definition' | |
query.additional-fields[template][] |
string | Optional | enum: ["definition"] |
|
query.fields[template] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template][] |
string | Optional | enum: ["amp","created","definition","definition.body","definition.body.id","definition.body.properties","definition.body.properties.css_class","definition.body.properties.id","definition.body.sections","definition.body.styles","definition.body.styles.background_color","definition.body.styles.width","definition.id","definition.styles","definition.template_id","editor_type","html","id","name","screenshot_url","text","updated"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any, equals (string) name: any, contains, equals (string) created: equals, greater-or-equal, greater-than, less-or-equal, less-than (date-time) updated: equals, greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 10. Min: 1. Max: 10. | default: 10; minimum: 1; maximum: 10 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created","id","-id","name","-name","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Template — klaviyo.create_template
Create a new HTML or drag-and-drop template.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[template] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'definition' | |
query.additional-fields[template][] |
string | Optional | enum: ["definition"] |
|
query.fields[template] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template][] |
string | Optional | enum: ["amp","created","definition","definition.body","definition.body.id","definition.body.properties","definition.body.properties.css_class","definition.body.properties.id","definition.body.sections","definition.body.styles","definition.body.styles.background_color","definition.body.styles.width","definition.id","definition.styles","definition.template_id","editor_type","html","id","name","screenshot_url","text","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TemplateCreateHtmlOrDndQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "template",
"attributes": {
"name": "Monthly Newsletter Template",
"editor_type": "example"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Template — klaviyo.get_template
Get a template with the given template ID. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of template | |
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[template] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'definition' | |
query.additional-fields[template][] |
string | Optional | enum: ["definition"] |
|
query.fields[template] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template][] |
string | Optional | enum: ["amp","created","definition","definition.body","definition.body.id","definition.body.properties","definition.body.properties.css_class","definition.body.properties.id","definition.body.sections","definition.body.styles","definition.body.styles.background_color","definition.body.styles.width","definition.id","definition.styles","definition.template_id","editor_type","html","id","name","screenshot_url","text","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Template — klaviyo.update_template
Update a template with the given template ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of template | |
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[template] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'definition' | |
query.additional-fields[template][] |
string | Optional | enum: ["definition"] |
|
query.fields[template] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template][] |
string | Optional | enum: ["amp","created","definition","definition.body","definition.body.id","definition.body.properties","definition.body.properties.css_class","definition.body.properties.id","definition.body.sections","definition.body.styles","definition.body.styles.background_color","definition.body.styles.width","definition.id","definition.styles","definition.template_id","editor_type","html","id","name","screenshot_url","text","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TemplateUpdateHtmlOrDndQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "template",
"id": "example",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Template — klaviyo.delete_template
Delete a template with the given template ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of template | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get All Universal Content — klaviyo.get_all_universal_content
Get all universal content in an account. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[template-universal-content] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template-universal-content][] |
string | Optional | enum: ["created","definition","definition.content_type","definition.data","definition.data.content","definition.data.display_options","definition.data.display_options.content_repeat","definition.data.display_options.content_repeat.item_alias","definition.data.display_options.content_repeat.repeat_for","definition.data.display_options.layout_config","definition.data.display_options.layout_type","definition.data.display_options.show_on","definition.data.display_options.visibility","definition.data.display_options.visibility.check","definition.data.display_options.visibility.definition","definition.data.display_options.visibility.is_code_only","definition.data.properties","definition.data.properties.alt_text","definition.data.properties.asset_id","definition.data.properties.author","definition.data.properties.author_placeholder","definition.data.properties.button_text","definition.data.properties.coupon","definition.data.properties.coupon_id","definition.data.properties.cropping_properties","definition.data.properties.cropping_properties.aspect_ratio","definition.data.properties.cropping_properties.asset_id","definition.data.properties.cropping_properties.height","definition.data.properties.cropping_properties.src","definition.data.properties.cropping_properties.width","definition.data.properties.cropping_properties.x","definition.data.properties.cropping_properties.y","definition.data.properties.dynamic","definition.data.properties.fallback_content_type","definition.data.properties.fallback_options","definition.data.properties.fallback_review_id","definition.data.properties.feed","definition.data.properties.feed_offset","definition.data.properties.header_enabled","definition.data.properties.href","definition.data.properties.is_ai_generated","definition.data.properties.is_nbp","definition.data.properties.is_prebuilt_content","definition.data.properties.item_subtype_id","definition.data.properties.language","definition.data.properties.localize_for_recipient","definition.data.properties.num_columns","definition.data.properties.overlay_toggle","definition.data.properties.product_event_variable","definition.data.properties.product_id","definition.data.properties.product_name","definition.data.properties.product_name_placeholder","definition.data.properties.product_selection_mode","definition.data.properties.product_variant_name","definition.data.properties.product_variant_name_placeholder","definition.data.properties.quote","definition.data.properties.quote_placeholder","definition.data.properties.raw_asset_id","definition.data.properties.raw_src","definition.data.properties.region","definition.data.properties.row_content_repeat","definition.data.properties.row_content_repeat.item_alias","definition.data.properties.row_content_repeat.repeat_for","definition.data.properties.show_button","definition.data.properties.show_description","definition.data.properties.show_fallback_content","definition.data.properties.show_headers","definition.data.properties.show_labels","definition.data.properties.show_original_price","definition.data.properties.show_price","definition.data.properties.show_product_name","definition.data.properties.show_rating","definition.data.properties.show_rating_count","definition.data.properties.show_reviewer_name","definition.data.properties.show_static_row","definition.data.properties.show_title","definition.data.properties.show_title_links","definition.data.properties.show_variant_name","definition.data.properties.show_verified_badge","definition.data.properties.src","definition.data.properties.src_asset_id","definition.data.properties.stars","definition.data.properties.title_placeholder","definition.data.properties.verified","definition.data.properties.verified_badge_language","definition.data.styles","definition.data.styles.align","definition.data.styles.author_align","definition.data.styles.author_color","definition.data.styles.author_font_family","definition.data.styles.author_font_size","definition.data.styles.author_font_style","definition.data.styles.author_font_weight","definition.data.styles.author_letter_spacing","definition.data.styles.author_text_decoration","definition.data.styles.background_asset_id","definition.data.styles.background_color","definition.data.styles.background_format","definition.data.styles.background_image_full_width","definition.data.styles.background_position","definition.data.styles.background_repeat","definition.data.styles.background_url","definition.data.styles.block_background_color","definition.data.styles.block_border_color","definition.data.styles.block_border_style","definition.data.styles.block_border_width","definition.data.styles.block_padding_bottom","definition.data.styles.block_padding_left","definition.data.styles.block_padding_right","definition.data.styles.block_padding_top","definition.data.styles.border_color","definition.data.styles.border_radius","definition.data.styles.border_style","definition.data.styles.border_width","definition.data.styles.button_alignment","definition.data.styles.button_background_color","definition.data.styles.button_border_color","definition.data.styles.button_border_radius","definition.data.styles.button_border_style","definition.data.styles.button_border_width","definition.data.styles.button_drop_shadow_color","definition.data.styles.button_font_color","definition.data.styles.button_font_family","definition.data.styles.button_font_size","definition.data.styles.button_font_style","definition.data.styles.button_font_weight","definition.data.styles.button_letter_spacing","definition.data.styles.button_padding_bottom","definition.data.styles.button_padding_left","definition.data.styles.button_padding_right","definition.data.styles.button_padding_top","definition.data.styles.button_text_decoration","definition.data.styles.cell_horizontal_border_color","definition.data.styles.cell_horizontal_border_style","definition.data.styles.cell_horizontal_border_width","definition.data.styles.cell_padding_bottom","definition.data.styles.cell_padding_left","definition.data.styles.cell_padding_right","definition.data.styles.cell_padding_top","definition.data.styles.cell_vertical_align","definition.data.styles.cell_vertical_border_color","definition.data.styles.cell_vertical_border_style","definition.data.styles.cell_vertical_border_width","definition.data.styles.color","definition.data.styles.column_align","definition.data.styles.column_direction","definition.data.styles.column_widths","definition.data.styles.content_color","definition.data.styles.content_color_type","definition.data.styles.description_font_color","definition.data.styles.description_font_family","definition.data.styles.description_font_size","definition.data.styles.description_font_style","definition.data.styles.description_font_weight","definition.data.styles.description_letter_spacing","definition.data.styles.description_padding_bottom","definition.data.styles.description_padding_top","definition.data.styles.description_text_decoration","definition.data.styles.desktop_layout","definition.data.styles.drop_shadow_color","definition.data.styles.empty_star_color","definition.data.styles.extra_css_class","definition.data.styles.font_family","definition.data.styles.font_size","definition.data.styles.font_style","definition.data.styles.font_weight","definition.data.styles.full_width_mobile","definition.data.styles.header_background_color","definition.data.styles.header_font_color","definition.data.styles.header_font_family","definition.data.styles.header_font_size","definition.data.styles.header_font_style","definition.data.styles.header_font_weight","definition.data.styles.header_letter_spacing","definition.data.styles.header_line_height","definition.data.styles.header_padding_bottom","definition.data.styles.header_padding_left","definition.data.styles.header_padding_right","definition.data.styles.header_padding_top","definition.data.styles.header_text_decoration","definition.data.styles.height","definition.data.styles.icon_align","definition.data.styles.icon_color","definition.data.styles.icon_size","definition.data.styles.icon_spacing","definition.data.styles.inner_padding_bottom","definition.data.styles.inner_padding_left","definition.data.styles.inner_padding_right","definition.data.styles.inner_padding_top","definition.data.styles.item_align","definition.data.styles.item_border_color","definition.data.styles.item_border_style","definition.data.styles.item_border_width","definition.data.styles.item_max_height","definition.data.styles.item_padding_bottom","definition.data.styles.item_padding_left","definition.data.styles.item_padding_right","definition.data.styles.item_padding_top","definition.data.styles.item_spacing","definition.data.styles.item_spacing_type","definition.data.styles.item_text_alignment","definition.data.styles.label_color","definition.data.styles.label_font_family","definition.data.styles.label_font_size","definition.data.styles.label_font_style","definition.data.styles.label_font_weight","definition.data.styles.label_text_decoration","definition.data.styles.layout","definition.data.styles.letter_spacing","definition.data.styles.line_height","definition.data.styles.logo_align","definition.data.styles.logo_link_spacing","definition.data.styles.max_width","definition.data.styles.mobile_layout","definition.data.styles.mobile_spacing","definition.data.styles.mobile_stack_order","definition.data.styles.mobile_stretch_content","definition.data.styles.mobile_wrap","definition.data.styles.num_columns","definition.data.styles.num_rows","definition.data.styles.original_price_font_color","definition.data.styles.original_price_font_family","definition.data.styles.original_price_font_size","definition.data.styles.original_price_font_style","definition.data.styles.original_price_font_weight","definition.data.styles.original_price_text_decoration","definition.data.styles.padding_in_between","definition.data.styles.price_font_color","definition.data.styles.price_font_family","definition.data.styles.price_font_size","definition.data.styles.price_font_style","definition.data.styles.price_font_weight","definition.data.styles.price_letter_spacing","definition.data.styles.price_padding_bottom","definition.data.styles.price_padding_top","definition.data.styles.price_text_decoration","definition.data.styles.product_name_align","definition.data.styles.product_name_color","definition.data.styles.product_name_font_family","definition.data.styles.product_name_font_size","definition.data.styles.product_name_font_style","definition.data.styles.product_name_font_weight","definition.data.styles.product_name_letter_spacing","definition.data.styles.product_name_text_decoration","definition.data.styles.quote_align","definition.data.styles.quote_color","definition.data.styles.quote_font_family","definition.data.styles.quote_font_size","definition.data.styles.quote_font_style","definition.data.styles.quote_font_weight","definition.data.styles.quote_letter_spacing","definition.data.styles.quote_line_height","definition.data.styles.quote_style","definition.data.styles.quote_text_decoration","definition.data.styles.rating_font_color","definition.data.styles.rating_font_family","definition.data.styles.rating_font_size","definition.data.styles.rating_font_style","definition.data.styles.rating_font_weight","definition.data.styles.rating_letter_spacing","definition.data.styles.rating_padding_bottom","definition.data.styles.rating_padding_top","definition.data.styles.rating_text_decoration","definition.data.styles.shadow_color","definition.data.styles.stack_on_mobile","definition.data.styles.star_alignment","definition.data.styles.star_color","definition.data.styles.star_icon_spacing","definition.data.styles.star_rating_shape","definition.data.styles.star_size","definition.data.styles.stretch","definition.data.styles.table_background_color","definition.data.styles.table_font_color","definition.data.styles.table_font_family","definition.data.styles.table_font_size","definition.data.styles.table_text_align","definition.data.styles.text_align","definition.data.styles.text_area_bg_color","definition.data.styles.text_area_border_color","definition.data.styles.text_decoration","definition.data.styles.text_table_layout","definition.data.styles.title_font_color","definition.data.styles.title_font_family","definition.data.styles.title_font_size","definition.data.styles.title_font_style","definition.data.styles.title_font_weight","definition.data.styles.title_letter_spacing","definition.data.styles.title_padding_bottom","definition.data.styles.title_padding_top","definition.data.styles.title_text_decoration","definition.data.styles.use_legacy_mobile_padding","definition.data.styles.verified_badge_color","definition.data.styles.verified_badge_size","definition.data.styles.verified_badge_style","definition.data.styles.verified_color","definition.data.styles.verified_font_family","definition.data.styles.verified_font_size","definition.data.styles.verified_font_style","definition.data.styles.verified_font_weight","definition.data.styles.verified_letter_spacing","definition.data.styles.verified_text_decoration","definition.data.styles.vertical_align","definition.data.styles.width","definition.data_id","definition.id","definition.rows","definition.subblocks","definition.type","definition.universal_id","id","name","screenshot_status","screenshot_url","updated"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any, equals (string) name: any, equals (string) created: greater-or-equal, greater-than, less-or-equal, less-than (date-time) updated: greater-or-equal, greater-than, less-or-equal, less-than (date-time) definition.content_type: equals (allowed values: 'block', 'section') definition.type: equals (allowed values: 'button', 'coupon', 'drop_shadow', 'header', 'horizontal_rule', 'html', 'image', 'product', 'review', 'social', 'spacer', 'split', 'table', 'text', 'unsupported', 'video') |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created","id","-id","name","-name","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Universal Content — klaviyo.create_universal_content
Create universal content. Supports every block type (including Coupon, Review, Video, Header, Product, Social, Split, and Table) as well as Section content. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[template-universal-content] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template-universal-content][] |
string | Optional | enum: ["created","definition","definition.content_type","definition.data","definition.data.content","definition.data.display_options","definition.data.display_options.content_repeat","definition.data.display_options.content_repeat.item_alias","definition.data.display_options.content_repeat.repeat_for","definition.data.display_options.layout_config","definition.data.display_options.layout_type","definition.data.display_options.show_on","definition.data.display_options.visibility","definition.data.display_options.visibility.check","definition.data.display_options.visibility.definition","definition.data.display_options.visibility.is_code_only","definition.data.properties","definition.data.properties.alt_text","definition.data.properties.asset_id","definition.data.properties.author","definition.data.properties.author_placeholder","definition.data.properties.button_text","definition.data.properties.coupon","definition.data.properties.coupon_id","definition.data.properties.cropping_properties","definition.data.properties.cropping_properties.aspect_ratio","definition.data.properties.cropping_properties.asset_id","definition.data.properties.cropping_properties.height","definition.data.properties.cropping_properties.src","definition.data.properties.cropping_properties.width","definition.data.properties.cropping_properties.x","definition.data.properties.cropping_properties.y","definition.data.properties.dynamic","definition.data.properties.fallback_content_type","definition.data.properties.fallback_options","definition.data.properties.fallback_review_id","definition.data.properties.feed","definition.data.properties.feed_offset","definition.data.properties.header_enabled","definition.data.properties.href","definition.data.properties.is_ai_generated","definition.data.properties.is_nbp","definition.data.properties.is_prebuilt_content","definition.data.properties.item_subtype_id","definition.data.properties.language","definition.data.properties.localize_for_recipient","definition.data.properties.num_columns","definition.data.properties.overlay_toggle","definition.data.properties.product_event_variable","definition.data.properties.product_id","definition.data.properties.product_name","definition.data.properties.product_name_placeholder","definition.data.properties.product_selection_mode","definition.data.properties.product_variant_name","definition.data.properties.product_variant_name_placeholder","definition.data.properties.quote","definition.data.properties.quote_placeholder","definition.data.properties.raw_asset_id","definition.data.properties.raw_src","definition.data.properties.region","definition.data.properties.row_content_repeat","definition.data.properties.row_content_repeat.item_alias","definition.data.properties.row_content_repeat.repeat_for","definition.data.properties.show_button","definition.data.properties.show_description","definition.data.properties.show_fallback_content","definition.data.properties.show_headers","definition.data.properties.show_labels","definition.data.properties.show_original_price","definition.data.properties.show_price","definition.data.properties.show_product_name","definition.data.properties.show_rating","definition.data.properties.show_rating_count","definition.data.properties.show_reviewer_name","definition.data.properties.show_static_row","definition.data.properties.show_title","definition.data.properties.show_title_links","definition.data.properties.show_variant_name","definition.data.properties.show_verified_badge","definition.data.properties.src","definition.data.properties.src_asset_id","definition.data.properties.stars","definition.data.properties.title_placeholder","definition.data.properties.verified","definition.data.properties.verified_badge_language","definition.data.styles","definition.data.styles.align","definition.data.styles.author_align","definition.data.styles.author_color","definition.data.styles.author_font_family","definition.data.styles.author_font_size","definition.data.styles.author_font_style","definition.data.styles.author_font_weight","definition.data.styles.author_letter_spacing","definition.data.styles.author_text_decoration","definition.data.styles.background_asset_id","definition.data.styles.background_color","definition.data.styles.background_format","definition.data.styles.background_image_full_width","definition.data.styles.background_position","definition.data.styles.background_repeat","definition.data.styles.background_url","definition.data.styles.block_background_color","definition.data.styles.block_border_color","definition.data.styles.block_border_style","definition.data.styles.block_border_width","definition.data.styles.block_padding_bottom","definition.data.styles.block_padding_left","definition.data.styles.block_padding_right","definition.data.styles.block_padding_top","definition.data.styles.border_color","definition.data.styles.border_radius","definition.data.styles.border_style","definition.data.styles.border_width","definition.data.styles.button_alignment","definition.data.styles.button_background_color","definition.data.styles.button_border_color","definition.data.styles.button_border_radius","definition.data.styles.button_border_style","definition.data.styles.button_border_width","definition.data.styles.button_drop_shadow_color","definition.data.styles.button_font_color","definition.data.styles.button_font_family","definition.data.styles.button_font_size","definition.data.styles.button_font_style","definition.data.styles.button_font_weight","definition.data.styles.button_letter_spacing","definition.data.styles.button_padding_bottom","definition.data.styles.button_padding_left","definition.data.styles.button_padding_right","definition.data.styles.button_padding_top","definition.data.styles.button_text_decoration","definition.data.styles.cell_horizontal_border_color","definition.data.styles.cell_horizontal_border_style","definition.data.styles.cell_horizontal_border_width","definition.data.styles.cell_padding_bottom","definition.data.styles.cell_padding_left","definition.data.styles.cell_padding_right","definition.data.styles.cell_padding_top","definition.data.styles.cell_vertical_align","definition.data.styles.cell_vertical_border_color","definition.data.styles.cell_vertical_border_style","definition.data.styles.cell_vertical_border_width","definition.data.styles.color","definition.data.styles.column_align","definition.data.styles.column_direction","definition.data.styles.column_widths","definition.data.styles.content_color","definition.data.styles.content_color_type","definition.data.styles.description_font_color","definition.data.styles.description_font_family","definition.data.styles.description_font_size","definition.data.styles.description_font_style","definition.data.styles.description_font_weight","definition.data.styles.description_letter_spacing","definition.data.styles.description_padding_bottom","definition.data.styles.description_padding_top","definition.data.styles.description_text_decoration","definition.data.styles.desktop_layout","definition.data.styles.drop_shadow_color","definition.data.styles.empty_star_color","definition.data.styles.extra_css_class","definition.data.styles.font_family","definition.data.styles.font_size","definition.data.styles.font_style","definition.data.styles.font_weight","definition.data.styles.full_width_mobile","definition.data.styles.header_background_color","definition.data.styles.header_font_color","definition.data.styles.header_font_family","definition.data.styles.header_font_size","definition.data.styles.header_font_style","definition.data.styles.header_font_weight","definition.data.styles.header_letter_spacing","definition.data.styles.header_line_height","definition.data.styles.header_padding_bottom","definition.data.styles.header_padding_left","definition.data.styles.header_padding_right","definition.data.styles.header_padding_top","definition.data.styles.header_text_decoration","definition.data.styles.height","definition.data.styles.icon_align","definition.data.styles.icon_color","definition.data.styles.icon_size","definition.data.styles.icon_spacing","definition.data.styles.inner_padding_bottom","definition.data.styles.inner_padding_left","definition.data.styles.inner_padding_right","definition.data.styles.inner_padding_top","definition.data.styles.item_align","definition.data.styles.item_border_color","definition.data.styles.item_border_style","definition.data.styles.item_border_width","definition.data.styles.item_max_height","definition.data.styles.item_padding_bottom","definition.data.styles.item_padding_left","definition.data.styles.item_padding_right","definition.data.styles.item_padding_top","definition.data.styles.item_spacing","definition.data.styles.item_spacing_type","definition.data.styles.item_text_alignment","definition.data.styles.label_color","definition.data.styles.label_font_family","definition.data.styles.label_font_size","definition.data.styles.label_font_style","definition.data.styles.label_font_weight","definition.data.styles.label_text_decoration","definition.data.styles.layout","definition.data.styles.letter_spacing","definition.data.styles.line_height","definition.data.styles.logo_align","definition.data.styles.logo_link_spacing","definition.data.styles.max_width","definition.data.styles.mobile_layout","definition.data.styles.mobile_spacing","definition.data.styles.mobile_stack_order","definition.data.styles.mobile_stretch_content","definition.data.styles.mobile_wrap","definition.data.styles.num_columns","definition.data.styles.num_rows","definition.data.styles.original_price_font_color","definition.data.styles.original_price_font_family","definition.data.styles.original_price_font_size","definition.data.styles.original_price_font_style","definition.data.styles.original_price_font_weight","definition.data.styles.original_price_text_decoration","definition.data.styles.padding_in_between","definition.data.styles.price_font_color","definition.data.styles.price_font_family","definition.data.styles.price_font_size","definition.data.styles.price_font_style","definition.data.styles.price_font_weight","definition.data.styles.price_letter_spacing","definition.data.styles.price_padding_bottom","definition.data.styles.price_padding_top","definition.data.styles.price_text_decoration","definition.data.styles.product_name_align","definition.data.styles.product_name_color","definition.data.styles.product_name_font_family","definition.data.styles.product_name_font_size","definition.data.styles.product_name_font_style","definition.data.styles.product_name_font_weight","definition.data.styles.product_name_letter_spacing","definition.data.styles.product_name_text_decoration","definition.data.styles.quote_align","definition.data.styles.quote_color","definition.data.styles.quote_font_family","definition.data.styles.quote_font_size","definition.data.styles.quote_font_style","definition.data.styles.quote_font_weight","definition.data.styles.quote_letter_spacing","definition.data.styles.quote_line_height","definition.data.styles.quote_style","definition.data.styles.quote_text_decoration","definition.data.styles.rating_font_color","definition.data.styles.rating_font_family","definition.data.styles.rating_font_size","definition.data.styles.rating_font_style","definition.data.styles.rating_font_weight","definition.data.styles.rating_letter_spacing","definition.data.styles.rating_padding_bottom","definition.data.styles.rating_padding_top","definition.data.styles.rating_text_decoration","definition.data.styles.shadow_color","definition.data.styles.stack_on_mobile","definition.data.styles.star_alignment","definition.data.styles.star_color","definition.data.styles.star_icon_spacing","definition.data.styles.star_rating_shape","definition.data.styles.star_size","definition.data.styles.stretch","definition.data.styles.table_background_color","definition.data.styles.table_font_color","definition.data.styles.table_font_family","definition.data.styles.table_font_size","definition.data.styles.table_text_align","definition.data.styles.text_align","definition.data.styles.text_area_bg_color","definition.data.styles.text_area_border_color","definition.data.styles.text_decoration","definition.data.styles.text_table_layout","definition.data.styles.title_font_color","definition.data.styles.title_font_family","definition.data.styles.title_font_size","definition.data.styles.title_font_style","definition.data.styles.title_font_weight","definition.data.styles.title_letter_spacing","definition.data.styles.title_padding_bottom","definition.data.styles.title_padding_top","definition.data.styles.title_text_decoration","definition.data.styles.use_legacy_mobile_padding","definition.data.styles.verified_badge_color","definition.data.styles.verified_badge_size","definition.data.styles.verified_badge_style","definition.data.styles.verified_color","definition.data.styles.verified_font_family","definition.data.styles.verified_font_size","definition.data.styles.verified_font_style","definition.data.styles.verified_font_weight","definition.data.styles.verified_letter_spacing","definition.data.styles.verified_text_decoration","definition.data.styles.vertical_align","definition.data.styles.width","definition.data_id","definition.id","definition.rows","definition.subblocks","definition.type","definition.universal_id","id","name","screenshot_status","screenshot_url","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/UniversalContentCreateQueryV1" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "template-universal-content",
"attributes": {
"name": "example",
"definition": {
"content_type": "block",
"type": "button",
"data": {
"content": "example",
"properties": {},
"display_options": {},
"styles": {}
}
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Universal Content — klaviyo.get_universal_content
Get the universal content with the given ID. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the universal content | |
query |
object | Optional | additionalProperties: false |
|
query.fields[template-universal-content] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template-universal-content][] |
string | Optional | enum: ["created","definition","definition.content_type","definition.data","definition.data.content","definition.data.display_options","definition.data.display_options.content_repeat","definition.data.display_options.content_repeat.item_alias","definition.data.display_options.content_repeat.repeat_for","definition.data.display_options.layout_config","definition.data.display_options.layout_type","definition.data.display_options.show_on","definition.data.display_options.visibility","definition.data.display_options.visibility.check","definition.data.display_options.visibility.definition","definition.data.display_options.visibility.is_code_only","definition.data.properties","definition.data.properties.alt_text","definition.data.properties.asset_id","definition.data.properties.author","definition.data.properties.author_placeholder","definition.data.properties.button_text","definition.data.properties.coupon","definition.data.properties.coupon_id","definition.data.properties.cropping_properties","definition.data.properties.cropping_properties.aspect_ratio","definition.data.properties.cropping_properties.asset_id","definition.data.properties.cropping_properties.height","definition.data.properties.cropping_properties.src","definition.data.properties.cropping_properties.width","definition.data.properties.cropping_properties.x","definition.data.properties.cropping_properties.y","definition.data.properties.dynamic","definition.data.properties.fallback_content_type","definition.data.properties.fallback_options","definition.data.properties.fallback_review_id","definition.data.properties.feed","definition.data.properties.feed_offset","definition.data.properties.header_enabled","definition.data.properties.href","definition.data.properties.is_ai_generated","definition.data.properties.is_nbp","definition.data.properties.is_prebuilt_content","definition.data.properties.item_subtype_id","definition.data.properties.language","definition.data.properties.localize_for_recipient","definition.data.properties.num_columns","definition.data.properties.overlay_toggle","definition.data.properties.product_event_variable","definition.data.properties.product_id","definition.data.properties.product_name","definition.data.properties.product_name_placeholder","definition.data.properties.product_selection_mode","definition.data.properties.product_variant_name","definition.data.properties.product_variant_name_placeholder","definition.data.properties.quote","definition.data.properties.quote_placeholder","definition.data.properties.raw_asset_id","definition.data.properties.raw_src","definition.data.properties.region","definition.data.properties.row_content_repeat","definition.data.properties.row_content_repeat.item_alias","definition.data.properties.row_content_repeat.repeat_for","definition.data.properties.show_button","definition.data.properties.show_description","definition.data.properties.show_fallback_content","definition.data.properties.show_headers","definition.data.properties.show_labels","definition.data.properties.show_original_price","definition.data.properties.show_price","definition.data.properties.show_product_name","definition.data.properties.show_rating","definition.data.properties.show_rating_count","definition.data.properties.show_reviewer_name","definition.data.properties.show_static_row","definition.data.properties.show_title","definition.data.properties.show_title_links","definition.data.properties.show_variant_name","definition.data.properties.show_verified_badge","definition.data.properties.src","definition.data.properties.src_asset_id","definition.data.properties.stars","definition.data.properties.title_placeholder","definition.data.properties.verified","definition.data.properties.verified_badge_language","definition.data.styles","definition.data.styles.align","definition.data.styles.author_align","definition.data.styles.author_color","definition.data.styles.author_font_family","definition.data.styles.author_font_size","definition.data.styles.author_font_style","definition.data.styles.author_font_weight","definition.data.styles.author_letter_spacing","definition.data.styles.author_text_decoration","definition.data.styles.background_asset_id","definition.data.styles.background_color","definition.data.styles.background_format","definition.data.styles.background_image_full_width","definition.data.styles.background_position","definition.data.styles.background_repeat","definition.data.styles.background_url","definition.data.styles.block_background_color","definition.data.styles.block_border_color","definition.data.styles.block_border_style","definition.data.styles.block_border_width","definition.data.styles.block_padding_bottom","definition.data.styles.block_padding_left","definition.data.styles.block_padding_right","definition.data.styles.block_padding_top","definition.data.styles.border_color","definition.data.styles.border_radius","definition.data.styles.border_style","definition.data.styles.border_width","definition.data.styles.button_alignment","definition.data.styles.button_background_color","definition.data.styles.button_border_color","definition.data.styles.button_border_radius","definition.data.styles.button_border_style","definition.data.styles.button_border_width","definition.data.styles.button_drop_shadow_color","definition.data.styles.button_font_color","definition.data.styles.button_font_family","definition.data.styles.button_font_size","definition.data.styles.button_font_style","definition.data.styles.button_font_weight","definition.data.styles.button_letter_spacing","definition.data.styles.button_padding_bottom","definition.data.styles.button_padding_left","definition.data.styles.button_padding_right","definition.data.styles.button_padding_top","definition.data.styles.button_text_decoration","definition.data.styles.cell_horizontal_border_color","definition.data.styles.cell_horizontal_border_style","definition.data.styles.cell_horizontal_border_width","definition.data.styles.cell_padding_bottom","definition.data.styles.cell_padding_left","definition.data.styles.cell_padding_right","definition.data.styles.cell_padding_top","definition.data.styles.cell_vertical_align","definition.data.styles.cell_vertical_border_color","definition.data.styles.cell_vertical_border_style","definition.data.styles.cell_vertical_border_width","definition.data.styles.color","definition.data.styles.column_align","definition.data.styles.column_direction","definition.data.styles.column_widths","definition.data.styles.content_color","definition.data.styles.content_color_type","definition.data.styles.description_font_color","definition.data.styles.description_font_family","definition.data.styles.description_font_size","definition.data.styles.description_font_style","definition.data.styles.description_font_weight","definition.data.styles.description_letter_spacing","definition.data.styles.description_padding_bottom","definition.data.styles.description_padding_top","definition.data.styles.description_text_decoration","definition.data.styles.desktop_layout","definition.data.styles.drop_shadow_color","definition.data.styles.empty_star_color","definition.data.styles.extra_css_class","definition.data.styles.font_family","definition.data.styles.font_size","definition.data.styles.font_style","definition.data.styles.font_weight","definition.data.styles.full_width_mobile","definition.data.styles.header_background_color","definition.data.styles.header_font_color","definition.data.styles.header_font_family","definition.data.styles.header_font_size","definition.data.styles.header_font_style","definition.data.styles.header_font_weight","definition.data.styles.header_letter_spacing","definition.data.styles.header_line_height","definition.data.styles.header_padding_bottom","definition.data.styles.header_padding_left","definition.data.styles.header_padding_right","definition.data.styles.header_padding_top","definition.data.styles.header_text_decoration","definition.data.styles.height","definition.data.styles.icon_align","definition.data.styles.icon_color","definition.data.styles.icon_size","definition.data.styles.icon_spacing","definition.data.styles.inner_padding_bottom","definition.data.styles.inner_padding_left","definition.data.styles.inner_padding_right","definition.data.styles.inner_padding_top","definition.data.styles.item_align","definition.data.styles.item_border_color","definition.data.styles.item_border_style","definition.data.styles.item_border_width","definition.data.styles.item_max_height","definition.data.styles.item_padding_bottom","definition.data.styles.item_padding_left","definition.data.styles.item_padding_right","definition.data.styles.item_padding_top","definition.data.styles.item_spacing","definition.data.styles.item_spacing_type","definition.data.styles.item_text_alignment","definition.data.styles.label_color","definition.data.styles.label_font_family","definition.data.styles.label_font_size","definition.data.styles.label_font_style","definition.data.styles.label_font_weight","definition.data.styles.label_text_decoration","definition.data.styles.layout","definition.data.styles.letter_spacing","definition.data.styles.line_height","definition.data.styles.logo_align","definition.data.styles.logo_link_spacing","definition.data.styles.max_width","definition.data.styles.mobile_layout","definition.data.styles.mobile_spacing","definition.data.styles.mobile_stack_order","definition.data.styles.mobile_stretch_content","definition.data.styles.mobile_wrap","definition.data.styles.num_columns","definition.data.styles.num_rows","definition.data.styles.original_price_font_color","definition.data.styles.original_price_font_family","definition.data.styles.original_price_font_size","definition.data.styles.original_price_font_style","definition.data.styles.original_price_font_weight","definition.data.styles.original_price_text_decoration","definition.data.styles.padding_in_between","definition.data.styles.price_font_color","definition.data.styles.price_font_family","definition.data.styles.price_font_size","definition.data.styles.price_font_style","definition.data.styles.price_font_weight","definition.data.styles.price_letter_spacing","definition.data.styles.price_padding_bottom","definition.data.styles.price_padding_top","definition.data.styles.price_text_decoration","definition.data.styles.product_name_align","definition.data.styles.product_name_color","definition.data.styles.product_name_font_family","definition.data.styles.product_name_font_size","definition.data.styles.product_name_font_style","definition.data.styles.product_name_font_weight","definition.data.styles.product_name_letter_spacing","definition.data.styles.product_name_text_decoration","definition.data.styles.quote_align","definition.data.styles.quote_color","definition.data.styles.quote_font_family","definition.data.styles.quote_font_size","definition.data.styles.quote_font_style","definition.data.styles.quote_font_weight","definition.data.styles.quote_letter_spacing","definition.data.styles.quote_line_height","definition.data.styles.quote_style","definition.data.styles.quote_text_decoration","definition.data.styles.rating_font_color","definition.data.styles.rating_font_family","definition.data.styles.rating_font_size","definition.data.styles.rating_font_style","definition.data.styles.rating_font_weight","definition.data.styles.rating_letter_spacing","definition.data.styles.rating_padding_bottom","definition.data.styles.rating_padding_top","definition.data.styles.rating_text_decoration","definition.data.styles.shadow_color","definition.data.styles.stack_on_mobile","definition.data.styles.star_alignment","definition.data.styles.star_color","definition.data.styles.star_icon_spacing","definition.data.styles.star_rating_shape","definition.data.styles.star_size","definition.data.styles.stretch","definition.data.styles.table_background_color","definition.data.styles.table_font_color","definition.data.styles.table_font_family","definition.data.styles.table_font_size","definition.data.styles.table_text_align","definition.data.styles.text_align","definition.data.styles.text_area_bg_color","definition.data.styles.text_area_border_color","definition.data.styles.text_decoration","definition.data.styles.text_table_layout","definition.data.styles.title_font_color","definition.data.styles.title_font_family","definition.data.styles.title_font_size","definition.data.styles.title_font_style","definition.data.styles.title_font_weight","definition.data.styles.title_letter_spacing","definition.data.styles.title_padding_bottom","definition.data.styles.title_padding_top","definition.data.styles.title_text_decoration","definition.data.styles.use_legacy_mobile_padding","definition.data.styles.verified_badge_color","definition.data.styles.verified_badge_size","definition.data.styles.verified_badge_style","definition.data.styles.verified_color","definition.data.styles.verified_font_family","definition.data.styles.verified_font_size","definition.data.styles.verified_font_style","definition.data.styles.verified_font_weight","definition.data.styles.verified_letter_spacing","definition.data.styles.verified_text_decoration","definition.data.styles.vertical_align","definition.data.styles.width","definition.data_id","definition.id","definition.rows","definition.subblocks","definition.type","definition.universal_id","id","name","screenshot_status","screenshot_url","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01HWWWKAW4RHXQJCMW4R2KRYR4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Universal Content — klaviyo.update_universal_content
Update universal content. The definition field always replaces the entire content definition (no attribute-level merge); omit it for a rename-only update. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the template universal content | |
query |
object | Optional | additionalProperties: false |
|
query.fields[template-universal-content] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template-universal-content][] |
string | Optional | enum: ["created","definition","definition.content_type","definition.data","definition.data.content","definition.data.display_options","definition.data.display_options.content_repeat","definition.data.display_options.content_repeat.item_alias","definition.data.display_options.content_repeat.repeat_for","definition.data.display_options.layout_config","definition.data.display_options.layout_type","definition.data.display_options.show_on","definition.data.display_options.visibility","definition.data.display_options.visibility.check","definition.data.display_options.visibility.definition","definition.data.display_options.visibility.is_code_only","definition.data.properties","definition.data.properties.alt_text","definition.data.properties.asset_id","definition.data.properties.author","definition.data.properties.author_placeholder","definition.data.properties.button_text","definition.data.properties.coupon","definition.data.properties.coupon_id","definition.data.properties.cropping_properties","definition.data.properties.cropping_properties.aspect_ratio","definition.data.properties.cropping_properties.asset_id","definition.data.properties.cropping_properties.height","definition.data.properties.cropping_properties.src","definition.data.properties.cropping_properties.width","definition.data.properties.cropping_properties.x","definition.data.properties.cropping_properties.y","definition.data.properties.dynamic","definition.data.properties.fallback_content_type","definition.data.properties.fallback_options","definition.data.properties.fallback_review_id","definition.data.properties.feed","definition.data.properties.feed_offset","definition.data.properties.header_enabled","definition.data.properties.href","definition.data.properties.is_ai_generated","definition.data.properties.is_nbp","definition.data.properties.is_prebuilt_content","definition.data.properties.item_subtype_id","definition.data.properties.language","definition.data.properties.localize_for_recipient","definition.data.properties.num_columns","definition.data.properties.overlay_toggle","definition.data.properties.product_event_variable","definition.data.properties.product_id","definition.data.properties.product_name","definition.data.properties.product_name_placeholder","definition.data.properties.product_selection_mode","definition.data.properties.product_variant_name","definition.data.properties.product_variant_name_placeholder","definition.data.properties.quote","definition.data.properties.quote_placeholder","definition.data.properties.raw_asset_id","definition.data.properties.raw_src","definition.data.properties.region","definition.data.properties.row_content_repeat","definition.data.properties.row_content_repeat.item_alias","definition.data.properties.row_content_repeat.repeat_for","definition.data.properties.show_button","definition.data.properties.show_description","definition.data.properties.show_fallback_content","definition.data.properties.show_headers","definition.data.properties.show_labels","definition.data.properties.show_original_price","definition.data.properties.show_price","definition.data.properties.show_product_name","definition.data.properties.show_rating","definition.data.properties.show_rating_count","definition.data.properties.show_reviewer_name","definition.data.properties.show_static_row","definition.data.properties.show_title","definition.data.properties.show_title_links","definition.data.properties.show_variant_name","definition.data.properties.show_verified_badge","definition.data.properties.src","definition.data.properties.src_asset_id","definition.data.properties.stars","definition.data.properties.title_placeholder","definition.data.properties.verified","definition.data.properties.verified_badge_language","definition.data.styles","definition.data.styles.align","definition.data.styles.author_align","definition.data.styles.author_color","definition.data.styles.author_font_family","definition.data.styles.author_font_size","definition.data.styles.author_font_style","definition.data.styles.author_font_weight","definition.data.styles.author_letter_spacing","definition.data.styles.author_text_decoration","definition.data.styles.background_asset_id","definition.data.styles.background_color","definition.data.styles.background_format","definition.data.styles.background_image_full_width","definition.data.styles.background_position","definition.data.styles.background_repeat","definition.data.styles.background_url","definition.data.styles.block_background_color","definition.data.styles.block_border_color","definition.data.styles.block_border_style","definition.data.styles.block_border_width","definition.data.styles.block_padding_bottom","definition.data.styles.block_padding_left","definition.data.styles.block_padding_right","definition.data.styles.block_padding_top","definition.data.styles.border_color","definition.data.styles.border_radius","definition.data.styles.border_style","definition.data.styles.border_width","definition.data.styles.button_alignment","definition.data.styles.button_background_color","definition.data.styles.button_border_color","definition.data.styles.button_border_radius","definition.data.styles.button_border_style","definition.data.styles.button_border_width","definition.data.styles.button_drop_shadow_color","definition.data.styles.button_font_color","definition.data.styles.button_font_family","definition.data.styles.button_font_size","definition.data.styles.button_font_style","definition.data.styles.button_font_weight","definition.data.styles.button_letter_spacing","definition.data.styles.button_padding_bottom","definition.data.styles.button_padding_left","definition.data.styles.button_padding_right","definition.data.styles.button_padding_top","definition.data.styles.button_text_decoration","definition.data.styles.cell_horizontal_border_color","definition.data.styles.cell_horizontal_border_style","definition.data.styles.cell_horizontal_border_width","definition.data.styles.cell_padding_bottom","definition.data.styles.cell_padding_left","definition.data.styles.cell_padding_right","definition.data.styles.cell_padding_top","definition.data.styles.cell_vertical_align","definition.data.styles.cell_vertical_border_color","definition.data.styles.cell_vertical_border_style","definition.data.styles.cell_vertical_border_width","definition.data.styles.color","definition.data.styles.column_align","definition.data.styles.column_direction","definition.data.styles.column_widths","definition.data.styles.content_color","definition.data.styles.content_color_type","definition.data.styles.description_font_color","definition.data.styles.description_font_family","definition.data.styles.description_font_size","definition.data.styles.description_font_style","definition.data.styles.description_font_weight","definition.data.styles.description_letter_spacing","definition.data.styles.description_padding_bottom","definition.data.styles.description_padding_top","definition.data.styles.description_text_decoration","definition.data.styles.desktop_layout","definition.data.styles.drop_shadow_color","definition.data.styles.empty_star_color","definition.data.styles.extra_css_class","definition.data.styles.font_family","definition.data.styles.font_size","definition.data.styles.font_style","definition.data.styles.font_weight","definition.data.styles.full_width_mobile","definition.data.styles.header_background_color","definition.data.styles.header_font_color","definition.data.styles.header_font_family","definition.data.styles.header_font_size","definition.data.styles.header_font_style","definition.data.styles.header_font_weight","definition.data.styles.header_letter_spacing","definition.data.styles.header_line_height","definition.data.styles.header_padding_bottom","definition.data.styles.header_padding_left","definition.data.styles.header_padding_right","definition.data.styles.header_padding_top","definition.data.styles.header_text_decoration","definition.data.styles.height","definition.data.styles.icon_align","definition.data.styles.icon_color","definition.data.styles.icon_size","definition.data.styles.icon_spacing","definition.data.styles.inner_padding_bottom","definition.data.styles.inner_padding_left","definition.data.styles.inner_padding_right","definition.data.styles.inner_padding_top","definition.data.styles.item_align","definition.data.styles.item_border_color","definition.data.styles.item_border_style","definition.data.styles.item_border_width","definition.data.styles.item_max_height","definition.data.styles.item_padding_bottom","definition.data.styles.item_padding_left","definition.data.styles.item_padding_right","definition.data.styles.item_padding_top","definition.data.styles.item_spacing","definition.data.styles.item_spacing_type","definition.data.styles.item_text_alignment","definition.data.styles.label_color","definition.data.styles.label_font_family","definition.data.styles.label_font_size","definition.data.styles.label_font_style","definition.data.styles.label_font_weight","definition.data.styles.label_text_decoration","definition.data.styles.layout","definition.data.styles.letter_spacing","definition.data.styles.line_height","definition.data.styles.logo_align","definition.data.styles.logo_link_spacing","definition.data.styles.max_width","definition.data.styles.mobile_layout","definition.data.styles.mobile_spacing","definition.data.styles.mobile_stack_order","definition.data.styles.mobile_stretch_content","definition.data.styles.mobile_wrap","definition.data.styles.num_columns","definition.data.styles.num_rows","definition.data.styles.original_price_font_color","definition.data.styles.original_price_font_family","definition.data.styles.original_price_font_size","definition.data.styles.original_price_font_style","definition.data.styles.original_price_font_weight","definition.data.styles.original_price_text_decoration","definition.data.styles.padding_in_between","definition.data.styles.price_font_color","definition.data.styles.price_font_family","definition.data.styles.price_font_size","definition.data.styles.price_font_style","definition.data.styles.price_font_weight","definition.data.styles.price_letter_spacing","definition.data.styles.price_padding_bottom","definition.data.styles.price_padding_top","definition.data.styles.price_text_decoration","definition.data.styles.product_name_align","definition.data.styles.product_name_color","definition.data.styles.product_name_font_family","definition.data.styles.product_name_font_size","definition.data.styles.product_name_font_style","definition.data.styles.product_name_font_weight","definition.data.styles.product_name_letter_spacing","definition.data.styles.product_name_text_decoration","definition.data.styles.quote_align","definition.data.styles.quote_color","definition.data.styles.quote_font_family","definition.data.styles.quote_font_size","definition.data.styles.quote_font_style","definition.data.styles.quote_font_weight","definition.data.styles.quote_letter_spacing","definition.data.styles.quote_line_height","definition.data.styles.quote_style","definition.data.styles.quote_text_decoration","definition.data.styles.rating_font_color","definition.data.styles.rating_font_family","definition.data.styles.rating_font_size","definition.data.styles.rating_font_style","definition.data.styles.rating_font_weight","definition.data.styles.rating_letter_spacing","definition.data.styles.rating_padding_bottom","definition.data.styles.rating_padding_top","definition.data.styles.rating_text_decoration","definition.data.styles.shadow_color","definition.data.styles.stack_on_mobile","definition.data.styles.star_alignment","definition.data.styles.star_color","definition.data.styles.star_icon_spacing","definition.data.styles.star_rating_shape","definition.data.styles.star_size","definition.data.styles.stretch","definition.data.styles.table_background_color","definition.data.styles.table_font_color","definition.data.styles.table_font_family","definition.data.styles.table_font_size","definition.data.styles.table_text_align","definition.data.styles.text_align","definition.data.styles.text_area_bg_color","definition.data.styles.text_area_border_color","definition.data.styles.text_decoration","definition.data.styles.text_table_layout","definition.data.styles.title_font_color","definition.data.styles.title_font_family","definition.data.styles.title_font_size","definition.data.styles.title_font_style","definition.data.styles.title_font_weight","definition.data.styles.title_letter_spacing","definition.data.styles.title_padding_bottom","definition.data.styles.title_padding_top","definition.data.styles.title_text_decoration","definition.data.styles.use_legacy_mobile_padding","definition.data.styles.verified_badge_color","definition.data.styles.verified_badge_size","definition.data.styles.verified_badge_style","definition.data.styles.verified_color","definition.data.styles.verified_font_family","definition.data.styles.verified_font_size","definition.data.styles.verified_font_style","definition.data.styles.verified_font_weight","definition.data.styles.verified_letter_spacing","definition.data.styles.verified_text_decoration","definition.data.styles.vertical_align","definition.data.styles.width","definition.data_id","definition.id","definition.rows","definition.subblocks","definition.type","definition.universal_id","id","name","screenshot_status","screenshot_url","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/UniversalContentPartialUpdateQueryV1" |
Full JSON Schema
Example input
{
"path": {
"id": "01HWWWKAW4RHXQJCMW4R2KRYR4"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "template-universal-content",
"id": "01HWWWKAW4RHXQJCMW4R2KRYR4",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Universal Content — klaviyo.delete_universal_content
Delete the universal content with the given ID. Rate limits: Burst: 75/s Steady: 750/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the template universal content | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01HWWWKAW4RHXQJCMW4R2KRYR4"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Template Conversion Jobs — klaviyo.get_template_conversion_jobs
Get the template conversion jobs created in the last 7 days, newest first. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[template-conversion-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template-conversion-job][] |
string | Optional | enum: ["completed_at","created_at","error","id","status"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Template Conversion Job — klaviyo.create_template_conversion_job
Convert an HTML template into a new drag-and-drop template.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[template-conversion-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template-conversion-job][] |
string | Optional | enum: ["completed_at","created_at","error","id","status"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TemplateConversionJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "template-conversion-job",
"relationships": {
"source-template": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Template Conversion Job — klaviyo.get_template_conversion_job
Get a template conversion job with the given job ID. Rate limits: Burst: 75/s Steady: 750/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | ID of the conversion job. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[template-conversion-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template-conversion-job][] |
string | Optional | enum: ["completed_at","created_at","error","id","status"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "XyZ123-01JA8ZQ5M0V3T7N6K2H4B9C1DE"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Render Template — klaviyo.render_template
Render a template with the given template ID and context attribute. Returns the AMP, HTML, and plain text versions of the email template.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[template] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template][] |
string | Optional | enum: ["amp","created","editor_type","html","id","name","screenshot_url","text","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TemplateRenderQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "template",
"id": "example",
"attributes": {
"context": {
"first_name": "Jane",
"last_name": "Smith"
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Clone Template — klaviyo.clone_template
Create a clone of a template with the given template ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[template] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template][] |
string | Optional | enum: ["amp","created","editor_type","html","id","name","screenshot_url","text","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TemplateCloneQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "template",
"id": "example",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Template Preview Send Job — klaviyo.create_template_preview_send_job
Send a test email of a template to one or more recipients. Rate limits: Burst: 1/s Steady: 15/m Daily: 100/d
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[template-preview-send-job] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template-preview-send-job][] |
string | Optional | enum: ["created_at","id","status"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TemplatePreviewSendJobCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "template-preview-send-job",
"attributes": {
"recipients": [
"[email protected]"
]
},
"relationships": {
"template": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Clone Universal Content — klaviyo.clone_universal_content
Create a clone of the universal content with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[template-universal-content] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template-universal-content][] |
string | Optional | enum: ["created","definition","definition.content_type","definition.data","definition.data.content","definition.data.display_options","definition.data.display_options.content_repeat","definition.data.display_options.content_repeat.item_alias","definition.data.display_options.content_repeat.repeat_for","definition.data.display_options.layout_config","definition.data.display_options.layout_type","definition.data.display_options.show_on","definition.data.display_options.visibility","definition.data.display_options.visibility.check","definition.data.display_options.visibility.definition","definition.data.display_options.visibility.is_code_only","definition.data.properties","definition.data.properties.alt_text","definition.data.properties.asset_id","definition.data.properties.author","definition.data.properties.author_placeholder","definition.data.properties.button_text","definition.data.properties.coupon","definition.data.properties.coupon_id","definition.data.properties.cropping_properties","definition.data.properties.cropping_properties.aspect_ratio","definition.data.properties.cropping_properties.asset_id","definition.data.properties.cropping_properties.height","definition.data.properties.cropping_properties.src","definition.data.properties.cropping_properties.width","definition.data.properties.cropping_properties.x","definition.data.properties.cropping_properties.y","definition.data.properties.dynamic","definition.data.properties.fallback_content_type","definition.data.properties.fallback_options","definition.data.properties.fallback_review_id","definition.data.properties.feed","definition.data.properties.feed_offset","definition.data.properties.header_enabled","definition.data.properties.href","definition.data.properties.is_ai_generated","definition.data.properties.is_nbp","definition.data.properties.is_prebuilt_content","definition.data.properties.item_subtype_id","definition.data.properties.language","definition.data.properties.localize_for_recipient","definition.data.properties.num_columns","definition.data.properties.overlay_toggle","definition.data.properties.product_event_variable","definition.data.properties.product_id","definition.data.properties.product_name","definition.data.properties.product_name_placeholder","definition.data.properties.product_selection_mode","definition.data.properties.product_variant_name","definition.data.properties.product_variant_name_placeholder","definition.data.properties.quote","definition.data.properties.quote_placeholder","definition.data.properties.raw_asset_id","definition.data.properties.raw_src","definition.data.properties.region","definition.data.properties.row_content_repeat","definition.data.properties.row_content_repeat.item_alias","definition.data.properties.row_content_repeat.repeat_for","definition.data.properties.show_button","definition.data.properties.show_description","definition.data.properties.show_fallback_content","definition.data.properties.show_headers","definition.data.properties.show_labels","definition.data.properties.show_original_price","definition.data.properties.show_price","definition.data.properties.show_product_name","definition.data.properties.show_rating","definition.data.properties.show_rating_count","definition.data.properties.show_reviewer_name","definition.data.properties.show_static_row","definition.data.properties.show_title","definition.data.properties.show_title_links","definition.data.properties.show_variant_name","definition.data.properties.show_verified_badge","definition.data.properties.src","definition.data.properties.src_asset_id","definition.data.properties.stars","definition.data.properties.title_placeholder","definition.data.properties.verified","definition.data.properties.verified_badge_language","definition.data.styles","definition.data.styles.align","definition.data.styles.author_align","definition.data.styles.author_color","definition.data.styles.author_font_family","definition.data.styles.author_font_size","definition.data.styles.author_font_style","definition.data.styles.author_font_weight","definition.data.styles.author_letter_spacing","definition.data.styles.author_text_decoration","definition.data.styles.background_asset_id","definition.data.styles.background_color","definition.data.styles.background_format","definition.data.styles.background_image_full_width","definition.data.styles.background_position","definition.data.styles.background_repeat","definition.data.styles.background_url","definition.data.styles.block_background_color","definition.data.styles.block_border_color","definition.data.styles.block_border_style","definition.data.styles.block_border_width","definition.data.styles.block_padding_bottom","definition.data.styles.block_padding_left","definition.data.styles.block_padding_right","definition.data.styles.block_padding_top","definition.data.styles.border_color","definition.data.styles.border_radius","definition.data.styles.border_style","definition.data.styles.border_width","definition.data.styles.button_alignment","definition.data.styles.button_background_color","definition.data.styles.button_border_color","definition.data.styles.button_border_radius","definition.data.styles.button_border_style","definition.data.styles.button_border_width","definition.data.styles.button_drop_shadow_color","definition.data.styles.button_font_color","definition.data.styles.button_font_family","definition.data.styles.button_font_size","definition.data.styles.button_font_style","definition.data.styles.button_font_weight","definition.data.styles.button_letter_spacing","definition.data.styles.button_padding_bottom","definition.data.styles.button_padding_left","definition.data.styles.button_padding_right","definition.data.styles.button_padding_top","definition.data.styles.button_text_decoration","definition.data.styles.cell_horizontal_border_color","definition.data.styles.cell_horizontal_border_style","definition.data.styles.cell_horizontal_border_width","definition.data.styles.cell_padding_bottom","definition.data.styles.cell_padding_left","definition.data.styles.cell_padding_right","definition.data.styles.cell_padding_top","definition.data.styles.cell_vertical_align","definition.data.styles.cell_vertical_border_color","definition.data.styles.cell_vertical_border_style","definition.data.styles.cell_vertical_border_width","definition.data.styles.color","definition.data.styles.column_align","definition.data.styles.column_direction","definition.data.styles.column_widths","definition.data.styles.content_color","definition.data.styles.content_color_type","definition.data.styles.description_font_color","definition.data.styles.description_font_family","definition.data.styles.description_font_size","definition.data.styles.description_font_style","definition.data.styles.description_font_weight","definition.data.styles.description_letter_spacing","definition.data.styles.description_padding_bottom","definition.data.styles.description_padding_top","definition.data.styles.description_text_decoration","definition.data.styles.desktop_layout","definition.data.styles.drop_shadow_color","definition.data.styles.empty_star_color","definition.data.styles.extra_css_class","definition.data.styles.font_family","definition.data.styles.font_size","definition.data.styles.font_style","definition.data.styles.font_weight","definition.data.styles.full_width_mobile","definition.data.styles.header_background_color","definition.data.styles.header_font_color","definition.data.styles.header_font_family","definition.data.styles.header_font_size","definition.data.styles.header_font_style","definition.data.styles.header_font_weight","definition.data.styles.header_letter_spacing","definition.data.styles.header_line_height","definition.data.styles.header_padding_bottom","definition.data.styles.header_padding_left","definition.data.styles.header_padding_right","definition.data.styles.header_padding_top","definition.data.styles.header_text_decoration","definition.data.styles.height","definition.data.styles.icon_align","definition.data.styles.icon_color","definition.data.styles.icon_size","definition.data.styles.icon_spacing","definition.data.styles.inner_padding_bottom","definition.data.styles.inner_padding_left","definition.data.styles.inner_padding_right","definition.data.styles.inner_padding_top","definition.data.styles.item_align","definition.data.styles.item_border_color","definition.data.styles.item_border_style","definition.data.styles.item_border_width","definition.data.styles.item_max_height","definition.data.styles.item_padding_bottom","definition.data.styles.item_padding_left","definition.data.styles.item_padding_right","definition.data.styles.item_padding_top","definition.data.styles.item_spacing","definition.data.styles.item_spacing_type","definition.data.styles.item_text_alignment","definition.data.styles.label_color","definition.data.styles.label_font_family","definition.data.styles.label_font_size","definition.data.styles.label_font_style","definition.data.styles.label_font_weight","definition.data.styles.label_text_decoration","definition.data.styles.layout","definition.data.styles.letter_spacing","definition.data.styles.line_height","definition.data.styles.logo_align","definition.data.styles.logo_link_spacing","definition.data.styles.max_width","definition.data.styles.mobile_layout","definition.data.styles.mobile_spacing","definition.data.styles.mobile_stack_order","definition.data.styles.mobile_stretch_content","definition.data.styles.mobile_wrap","definition.data.styles.num_columns","definition.data.styles.num_rows","definition.data.styles.original_price_font_color","definition.data.styles.original_price_font_family","definition.data.styles.original_price_font_size","definition.data.styles.original_price_font_style","definition.data.styles.original_price_font_weight","definition.data.styles.original_price_text_decoration","definition.data.styles.padding_in_between","definition.data.styles.price_font_color","definition.data.styles.price_font_family","definition.data.styles.price_font_size","definition.data.styles.price_font_style","definition.data.styles.price_font_weight","definition.data.styles.price_letter_spacing","definition.data.styles.price_padding_bottom","definition.data.styles.price_padding_top","definition.data.styles.price_text_decoration","definition.data.styles.product_name_align","definition.data.styles.product_name_color","definition.data.styles.product_name_font_family","definition.data.styles.product_name_font_size","definition.data.styles.product_name_font_style","definition.data.styles.product_name_font_weight","definition.data.styles.product_name_letter_spacing","definition.data.styles.product_name_text_decoration","definition.data.styles.quote_align","definition.data.styles.quote_color","definition.data.styles.quote_font_family","definition.data.styles.quote_font_size","definition.data.styles.quote_font_style","definition.data.styles.quote_font_weight","definition.data.styles.quote_letter_spacing","definition.data.styles.quote_line_height","definition.data.styles.quote_style","definition.data.styles.quote_text_decoration","definition.data.styles.rating_font_color","definition.data.styles.rating_font_family","definition.data.styles.rating_font_size","definition.data.styles.rating_font_style","definition.data.styles.rating_font_weight","definition.data.styles.rating_letter_spacing","definition.data.styles.rating_padding_bottom","definition.data.styles.rating_padding_top","definition.data.styles.rating_text_decoration","definition.data.styles.shadow_color","definition.data.styles.stack_on_mobile","definition.data.styles.star_alignment","definition.data.styles.star_color","definition.data.styles.star_icon_spacing","definition.data.styles.star_rating_shape","definition.data.styles.star_size","definition.data.styles.stretch","definition.data.styles.table_background_color","definition.data.styles.table_font_color","definition.data.styles.table_font_family","definition.data.styles.table_font_size","definition.data.styles.table_text_align","definition.data.styles.text_align","definition.data.styles.text_area_bg_color","definition.data.styles.text_area_border_color","definition.data.styles.text_decoration","definition.data.styles.text_table_layout","definition.data.styles.title_font_color","definition.data.styles.title_font_family","definition.data.styles.title_font_size","definition.data.styles.title_font_style","definition.data.styles.title_font_weight","definition.data.styles.title_letter_spacing","definition.data.styles.title_padding_bottom","definition.data.styles.title_padding_top","definition.data.styles.title_text_decoration","definition.data.styles.use_legacy_mobile_padding","definition.data.styles.verified_badge_color","definition.data.styles.verified_badge_size","definition.data.styles.verified_badge_style","definition.data.styles.verified_color","definition.data.styles.verified_font_family","definition.data.styles.verified_font_size","definition.data.styles.verified_font_style","definition.data.styles.verified_font_weight","definition.data.styles.verified_letter_spacing","definition.data.styles.verified_text_decoration","definition.data.styles.vertical_align","definition.data.styles.width","definition.data_id","definition.id","definition.rows","definition.subblocks","definition.type","definition.universal_id","id","name","screenshot_status","screenshot_url","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/UniversalContentCloneQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "template-universal-content",
"id": "01HWWWKAW4RHXQJCMW4R2KRYR4",
"attributes": {
"id": "01HWWWKAW4RHXQJCMW4R2KRYR4"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Text Messaging Configuration — klaviyo.get_text_messaging_configuration
Retrieve the SMS account for the calling company. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for this text messaging configuration (must equal the caller's company id). | |
query |
object | Optional | additionalProperties: false |
|
query.fields[text-messaging-configuration] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-configuration][] |
string | Optional | enum: ["created_at","id","opt_out_language","org_prefix","status","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Text Messaging Senders — klaviyo.get_text_messaging_senders
List the calling company's text-messaging senders. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[text-messaging-sender-registration] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-sender-registration][] |
string | Optional | enum: ["created_at","decided_at","failures","id","status","submitted_at","updated_at"] |
|
query.fields[text-messaging-sender] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-sender][] |
string | Optional | enum: ["created_at","forwarding_number","id","sender_details","sender_details.country","sender_identifier","sender_type","status"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["text-messaging-sender-registration"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 10. Min: 1. Max: 20. | default: 10; minimum: 1; maximum: 20 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created_at","-created_at"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Text Messaging Sender — klaviyo.create_text_messaging_sender
Create a sender and submit its initial registration.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[text-messaging-sender-registration] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-sender-registration][] |
string | Optional | enum: ["created_at","decided_at","failures","id","status","submitted_at","updated_at"] |
|
query.fields[text-messaging-sender] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-sender][] |
string | Optional | enum: ["created_at","forwarding_number","id","sender_details","sender_details.country","sender_identifier","sender_type","status"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["text-messaging-sender-registration"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TextMessagingSenderCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "text-messaging-sender",
"attributes": {
"sender_type": "alpha",
"sender_details": {
"country": "US"
},
"text-messaging-sender-registration": {
"data": {
"type": "text-messaging-sender-registration",
"attributes": {
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+15551234567",
"email": "[email protected]",
"address": {
"street_address_1": "125 Summer Street",
"city": "Boston",
"region": "MA",
"postal_code": "02110",
"country": "US"
},
"business_type": "GOVERNMENT",
"business_name": "Acme Corp",
"business_website": "https://acme.example.com"
}
}
}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Text Messaging Sender — klaviyo.get_text_messaging_sender
Retrieve a single text-messaging sender by ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier for the text-messaging sender. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[text-messaging-sender-registration] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-sender-registration][] |
string | Optional | enum: ["created_at","decided_at","failures","id","status","submitted_at","updated_at"] |
|
query.fields[text-messaging-sender] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-sender][] |
string | Optional | enum: ["created_at","forwarding_number","id","sender_details","sender_details.country","sender_identifier","sender_type","status"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["text-messaging-sender-registration"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01HX2Z8RG7Y4PWFQK3V0M5N1B7"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Text Messaging Sender Registration — klaviyo.get_text_messaging_sender_registration
Retrieve a sender registration by ID. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier of the sender registration. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[text-messaging-sender-registration] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-sender-registration][] |
string | Optional | enum: ["created_at","decided_at","failures","id","status","submitted_at","updated_at"] |
|
query.fields[text-messaging-sender] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-sender][] |
string | Optional | enum: ["created_at","forwarding_number","id","sender_details","sender_details.country","sender_identifier","sender_type","status"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["text-messaging-sender"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01HX2Z8RG7Y4PWFQK3V0M5N1C8"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Text Messaging Configuration — klaviyo.create_text_messaging_configuration
Create the SMS account for the calling company. Rate limits: Burst: 1/s Steady: 15/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[text-messaging-configuration] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-configuration][] |
string | Optional | enum: ["created_at","id","opt_out_language","org_prefix","status","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TextMessagingConfigurationCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "text-messaging-configuration",
"attributes": {
"org_prefix": "Acme"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Text Messaging Sender Registration — klaviyo.create_text_messaging_sender_registration
Submit a new registration for an existing sender (resubmission). Rate limits: Burst: 1/s Steady: 15/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[text-messaging-sender-registration] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-sender-registration][] |
string | Optional | enum: ["created_at","decided_at","failures","id","status","submitted_at","updated_at"] |
|
query.fields[text-messaging-sender] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-sender][] |
string | Optional | enum: ["created_at","forwarding_number","id","sender_details","sender_details.country","sender_identifier","sender_type","status"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["text-messaging-sender"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TextMessagingSenderRegistrationCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "text-messaging-sender-registration",
"attributes": {
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+15551234567",
"email": "[email protected]",
"address": {
"street_address_1": "125 Summer Street",
"city": "Boston",
"region": "MA",
"postal_code": "02110",
"country": "US"
},
"business_name": "Acme Corp",
"business_website": "https://acme.example.com",
"business_type": "GOVERNMENT"
},
"relationships": {
"text-messaging-sender": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Messaging Sender Registration for Text Messaging Sender — klaviyo.get_messaging_sender_registration_for_text_messaging_sender
Return the most-recent registration for the given sender. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier of the text-messaging sender. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[text-messaging-sender-registration] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[text-messaging-sender-registration][] |
string | Optional | enum: ["created_at","decided_at","failures","id","status","submitted_at","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01HX2Z8RG7Y4PWFQK3V0M5N1B7"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Messaging Sender Registration ID for Text Messaging Sender — klaviyo.get_messaging_sender_registration_id_for_text_messaging_sender
Return the most-recent registration for the given sender. Rate limits: Burst: 3/s Steady: 60/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The unique identifier of the text-messaging sender. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "01HX2Z8RG7Y4PWFQK3V0M5N1B7"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tracking Settings — klaviyo.get_tracking_settings
Get all UTM tracking settings in an account. Returns an array with a single tracking setting.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[tracking-setting] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tracking-setting][] |
string | Optional | enum: ["auto_add_parameters","custom_parameters","id","utm_campaign","utm_campaign.campaign","utm_campaign.campaign.type","utm_campaign.campaign.value","utm_campaign.flow","utm_campaign.flow.type","utm_campaign.flow.value","utm_id","utm_id.campaign","utm_id.campaign.type","utm_id.campaign.value","utm_id.flow","utm_id.flow.type","utm_id.flow.value","utm_medium","utm_medium.campaign","utm_medium.campaign.type","utm_medium.campaign.value","utm_medium.flow","utm_medium.flow.type","utm_medium.flow.value","utm_source","utm_source.campaign","utm_source.campaign.type","utm_source.campaign.value","utm_source.flow","utm_source.flow.type","utm_source.flow.value","utm_term","utm_term.campaign","utm_term.campaign.type","utm_term.campaign.value","utm_term.flow","utm_term.flow.type","utm_term.flow.value"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 1. Min: 1. Max: 1. | default: 1; minimum: 1; maximum: 1 |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Tracking Setting — klaviyo.get_tracking_setting
Get the UTM tracking setting with the given account ID.
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The id of the tracking setting (account ID). | |
query |
object | Optional | additionalProperties: false |
|
query.fields[tracking-setting] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tracking-setting][] |
string | Optional | enum: ["auto_add_parameters","custom_parameters","id","utm_campaign","utm_campaign.campaign","utm_campaign.campaign.type","utm_campaign.campaign.value","utm_campaign.flow","utm_campaign.flow.type","utm_campaign.flow.value","utm_id","utm_id.campaign","utm_id.campaign.type","utm_id.campaign.value","utm_id.flow","utm_id.flow.type","utm_id.flow.value","utm_medium","utm_medium.campaign","utm_medium.campaign.type","utm_medium.campaign.value","utm_medium.flow","utm_medium.flow.type","utm_medium.flow.value","utm_source","utm_source.campaign","utm_source.campaign.type","utm_source.campaign.value","utm_source.flow","utm_source.flow.type","utm_source.flow.value","utm_term","utm_term.campaign","utm_term.campaign.type","utm_term.campaign.value","utm_term.flow","utm_term.flow.type","utm_term.flow.value"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "abCdEf"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Tracking Setting — klaviyo.update_tracking_setting
Update the UTM tracking setting with the given account ID.
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The id of the tracking setting (account ID). | |
query |
object | Optional | additionalProperties: false |
|
query.fields[tracking-setting] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[tracking-setting][] |
string | Optional | enum: ["auto_add_parameters","custom_parameters","id","utm_campaign","utm_campaign.campaign","utm_campaign.campaign.type","utm_campaign.campaign.value","utm_campaign.flow","utm_campaign.flow.type","utm_campaign.flow.value","utm_id","utm_id.campaign","utm_id.campaign.type","utm_id.campaign.value","utm_id.flow","utm_id.flow.type","utm_id.flow.value","utm_medium","utm_medium.campaign","utm_medium.campaign.type","utm_medium.campaign.value","utm_medium.flow","utm_medium.flow.type","utm_medium.flow.value","utm_source","utm_source.campaign","utm_source.campaign.type","utm_source.campaign.value","utm_source.flow","utm_source.flow.type","utm_source.flow.value","utm_term","utm_term.campaign","utm_term.campaign.type","utm_term.campaign.value","utm_term.flow","utm_term.flow.type","utm_term.flow.value"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TrackingSettingPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "tracking-setting",
"id": "example",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Translations — klaviyo.get_translations
Get all translations in an account. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-variation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-variation][] |
string | Optional | enum: ["created","definition","definition.details","definition.details.action_buttons","definition.details.add_info_link","definition.details.add_opt_out_language","definition.details.add_org_prefix","definition.details.android_deep_link","definition.details.badge","definition.details.badge_config","definition.details.badge_value","definition.details.bcc_email","definition.details.body","definition.details.cc_email","definition.details.channel","definition.details.content_available","definition.details.cost","definition.details.dynamic_media_template","definition.details.from_email","definition.details.from_label","definition.details.include_contact_card","definition.details.ios_deep_link","definition.details.kv_pairs","definition.details.message_hierarchy","definition.details.mms_dynamic_image_template","definition.details.mms_static_image_asset_id","definition.details.mutable_content","definition.details.open_action","definition.details.preview_text","definition.details.push_platform_target","definition.details.push_type","definition.details.reply_to_email","definition.details.send_to_inbox","definition.details.send_to_primary","definition.details.shorten_links","definition.details.sound","definition.details.sound_file_name","definition.details.static_asset_id","definition.details.subject","definition.details.template_id","definition.details.text_message_type","definition.details.title","definition.details.video_asset_id","definition.details.web_url","definition.name","id","updated"] |
|
query.fields[flow-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-message][] |
string | Optional | enum: ["channel","content","content.action_buttons","content.android_link","content.badge","content.bcc_email","content.body","content.cc_email","content.dynamic_image","content.from_email","content.from_label","content.ios_link","content.media_url","content.on_open","content.preview_text","content.push_platform_target","content.reply_to_email","content.send_to_primary","content.sound","content.subject","content.title","content.web_url","created","id","name","updated"] |
|
query.fields[template-universal-content] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template-universal-content][] |
string | Optional | enum: ["created","definition","definition.content_type","definition.data","definition.data.content","definition.data.display_options","definition.data.display_options.content_repeat","definition.data.display_options.content_repeat.item_alias","definition.data.display_options.content_repeat.repeat_for","definition.data.display_options.show_on","definition.data.display_options.visible_check","definition.data.styles","definition.data.styles.background_color","definition.data.styles.block_background_color","definition.data.styles.block_border_color","definition.data.styles.block_border_style","definition.data.styles.block_border_width","definition.data.styles.block_padding_bottom","definition.data.styles.block_padding_left","definition.data.styles.block_padding_right","definition.data.styles.block_padding_top","definition.data.styles.color","definition.data.styles.extra_css_class","definition.data.styles.font_family","definition.data.styles.font_size","definition.data.styles.font_style","definition.data.styles.font_weight","definition.data.styles.inner_padding_bottom","definition.data.styles.inner_padding_left","definition.data.styles.inner_padding_right","definition.data.styles.inner_padding_top","definition.data.styles.letter_spacing","definition.data.styles.line_height","definition.data.styles.mobile_stretch_content","definition.data.styles.text_align","definition.data.styles.text_decoration","definition.data.styles.text_table_layout","definition.type","id","name","screenshot_status","screenshot_url","updated"] |
|
query.fields[template] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template][] |
string | Optional | enum: ["amp","created","editor_type","html","id","name","screenshot_url","text","updated"] |
|
query.fields[translation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[translation][] |
string | Optional | enum: ["channel","created","fallback_locale","id","metadata","source_locale","target_locales","updated"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): id: any, equals (string) resource_type: equals (string) channel: equals (allowed values: 'email', 'sms', 'mobile_push', 'whatsapp', 'web') related_resource_id: equals (string) |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["campaign-variation","flow-message","template","template-universal-content"] |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 20. Min: 1. Max: 100. | default: 20; minimum: 1; maximum: 100 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["id","-id"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Translation — klaviyo.create_translation
Create a translation. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[translation] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'values' | |
query.additional-fields[translation][] |
string | Optional | enum: ["values"] |
|
query.fields[translation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[translation][] |
string | Optional | enum: ["channel","created","fallback_locale","id","metadata","source_locale","target_locales","updated","values"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TranslationCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "translation",
"attributes": {
"source_locale": "en",
"target_locales": [],
"fallback_locale": "en",
"channel": "email"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Translation — klaviyo.get_translation
Get the translation with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the translation | |
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[translation] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'values' | |
query.additional-fields[translation][] |
string | Optional | enum: ["values"] |
|
query.fields[campaign-variation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-variation][] |
string | Optional | enum: ["created","definition","definition.details","definition.details.action_buttons","definition.details.add_info_link","definition.details.add_opt_out_language","definition.details.add_org_prefix","definition.details.android_deep_link","definition.details.badge","definition.details.badge_config","definition.details.badge_value","definition.details.bcc_email","definition.details.body","definition.details.cc_email","definition.details.channel","definition.details.content_available","definition.details.cost","definition.details.dynamic_media_template","definition.details.from_email","definition.details.from_label","definition.details.include_contact_card","definition.details.ios_deep_link","definition.details.kv_pairs","definition.details.message_hierarchy","definition.details.mms_dynamic_image_template","definition.details.mms_static_image_asset_id","definition.details.mutable_content","definition.details.open_action","definition.details.preview_text","definition.details.push_platform_target","definition.details.push_type","definition.details.reply_to_email","definition.details.send_to_inbox","definition.details.send_to_primary","definition.details.shorten_links","definition.details.sound","definition.details.sound_file_name","definition.details.static_asset_id","definition.details.subject","definition.details.template_id","definition.details.text_message_type","definition.details.title","definition.details.video_asset_id","definition.details.web_url","definition.name","id","updated"] |
|
query.fields[flow-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-message][] |
string | Optional | enum: ["channel","content","content.action_buttons","content.android_link","content.badge","content.bcc_email","content.body","content.cc_email","content.dynamic_image","content.from_email","content.from_label","content.ios_link","content.media_url","content.on_open","content.preview_text","content.push_platform_target","content.reply_to_email","content.send_to_primary","content.sound","content.subject","content.title","content.web_url","created","id","name","updated"] |
|
query.fields[template-universal-content] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template-universal-content][] |
string | Optional | enum: ["created","definition","definition.content_type","definition.data","definition.data.content","definition.data.display_options","definition.data.display_options.content_repeat","definition.data.display_options.content_repeat.item_alias","definition.data.display_options.content_repeat.repeat_for","definition.data.display_options.show_on","definition.data.display_options.visible_check","definition.data.styles","definition.data.styles.background_color","definition.data.styles.block_background_color","definition.data.styles.block_border_color","definition.data.styles.block_border_style","definition.data.styles.block_border_width","definition.data.styles.block_padding_bottom","definition.data.styles.block_padding_left","definition.data.styles.block_padding_right","definition.data.styles.block_padding_top","definition.data.styles.color","definition.data.styles.extra_css_class","definition.data.styles.font_family","definition.data.styles.font_size","definition.data.styles.font_style","definition.data.styles.font_weight","definition.data.styles.inner_padding_bottom","definition.data.styles.inner_padding_left","definition.data.styles.inner_padding_right","definition.data.styles.inner_padding_top","definition.data.styles.letter_spacing","definition.data.styles.line_height","definition.data.styles.mobile_stretch_content","definition.data.styles.text_align","definition.data.styles.text_decoration","definition.data.styles.text_table_layout","definition.type","id","name","screenshot_status","screenshot_url","updated"] |
|
query.fields[template] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template][] |
string | Optional | enum: ["amp","created","editor_type","html","id","name","screenshot_url","text","updated"] |
|
query.fields[translation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[translation][] |
string | Optional | enum: ["channel","created","fallback_locale","id","metadata","source_locale","target_locales","updated","values"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["campaign-variation","flow-message","template","template-universal-content"] |
|
query.page_type |
string | null | Optional | Scope returned consent-page values to a single page type. Only applies to consent-page translations. | enum: ["double-opt-in-confirmation-page","double-opt-in-email","preference-page","preference-success-page","subscribe-page","subscribe-success-page","unsubscribe-page","unsubscribe-success-page"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "campaign-variation::email::01KH00000000000000000000AB"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Translation — klaviyo.update_translation
Update the translation with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the translation | |
query |
object | Optional | additionalProperties: false |
|
query.additional-fields[translation] |
array | Optional | Request additional fields not included by default in the response. Supported values: 'values' | |
query.additional-fields[translation][] |
string | Optional | enum: ["values"] |
|
query.fields[translation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[translation][] |
string | Optional | enum: ["channel","created","fallback_locale","id","metadata","source_locale","target_locales","updated","values"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/TranslationPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "campaign-variation::email::01KH00000000000000000000AB"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "translation",
"id": "campaign-variation::email::01KH00000000000000000000AB",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Translation — klaviyo.delete_translation
Delete the translation with the given ID. Rate limits: Burst: 10/s Steady: 150/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the translation | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "campaign-variation::email::01KH00000000000000000000AB"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign Variation for Translation — klaviyo.get_campaign_variation_for_translation
Get the campaign variation for the given translation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the translation | |
query |
object | Optional | additionalProperties: false |
|
query.fields[campaign-variation] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[campaign-variation][] |
string | Optional | enum: ["created","definition","definition.details","definition.details.action_buttons","definition.details.add_info_link","definition.details.add_opt_out_language","definition.details.add_org_prefix","definition.details.android_deep_link","definition.details.badge","definition.details.badge_config","definition.details.badge_value","definition.details.bcc_email","definition.details.body","definition.details.cc_email","definition.details.channel","definition.details.content_available","definition.details.cost","definition.details.dynamic_media_template","definition.details.from_email","definition.details.from_label","definition.details.include_contact_card","definition.details.ios_deep_link","definition.details.kv_pairs","definition.details.message_hierarchy","definition.details.mms_dynamic_image_template","definition.details.mms_static_image_asset_id","definition.details.mutable_content","definition.details.open_action","definition.details.preview_text","definition.details.push_platform_target","definition.details.push_type","definition.details.reply_to_email","definition.details.send_to_inbox","definition.details.send_to_primary","definition.details.shorten_links","definition.details.sound","definition.details.sound_file_name","definition.details.static_asset_id","definition.details.subject","definition.details.template_id","definition.details.text_message_type","definition.details.title","definition.details.video_asset_id","definition.details.web_url","definition.name","id","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "campaign-variation::email::01KH00000000000000000000AB"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Campaign Variation ID for Translation — klaviyo.get_campaign_variation_id_for_translation
Get the campaign variation for the given translation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the translation | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "campaign-variation::email::01KH00000000000000000000AB"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Flow Message for Translation — klaviyo.get_flow_message_for_translation
Get the flow message for the given translation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the translation | |
query |
object | Optional | additionalProperties: false |
|
query.fields[flow-message] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[flow-message][] |
string | Optional | enum: ["channel","content","content.action_buttons","content.android_link","content.badge","content.bcc_email","content.body","content.cc_email","content.dynamic_image","content.from_email","content.from_label","content.ios_link","content.media_url","content.on_open","content.preview_text","content.push_platform_target","content.reply_to_email","content.send_to_primary","content.sound","content.subject","content.title","content.web_url","created","id","name","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "campaign-variation::email::01KH00000000000000000000AB"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Flow Message ID for Translation — klaviyo.get_flow_message_id_for_translation
Get the flow message for the given translation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the translation | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "campaign-variation::email::01KH00000000000000000000AB"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Template for Translation — klaviyo.get_template_for_translation
Get the template for the given translation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the translation | |
query |
object | Optional | additionalProperties: false |
|
query.fields[template] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template][] |
string | Optional | enum: ["amp","created","editor_type","html","id","name","screenshot_url","text","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "campaign-variation::email::01KH00000000000000000000AB"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Template ID for Translation — klaviyo.get_template_id_for_translation
Get the template for the given translation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the translation | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "campaign-variation::email::01KH00000000000000000000AB"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Template Universal Content for Translation — klaviyo.get_template_universal_content_for_translation
Get the template universal content for the given translation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the translation | |
query |
object | Optional | additionalProperties: false |
|
query.fields[template-universal-content] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[template-universal-content][] |
string | Optional | enum: ["created","definition","definition.content_type","definition.data","definition.data.content","definition.data.display_options","definition.data.display_options.content_repeat","definition.data.display_options.content_repeat.item_alias","definition.data.display_options.content_repeat.repeat_for","definition.data.display_options.show_on","definition.data.display_options.visible_check","definition.data.styles","definition.data.styles.background_color","definition.data.styles.block_background_color","definition.data.styles.block_border_color","definition.data.styles.block_border_style","definition.data.styles.block_border_width","definition.data.styles.block_padding_bottom","definition.data.styles.block_padding_left","definition.data.styles.block_padding_right","definition.data.styles.block_padding_top","definition.data.styles.color","definition.data.styles.extra_css_class","definition.data.styles.font_family","definition.data.styles.font_size","definition.data.styles.font_style","definition.data.styles.font_weight","definition.data.styles.inner_padding_bottom","definition.data.styles.inner_padding_left","definition.data.styles.inner_padding_right","definition.data.styles.inner_padding_top","definition.data.styles.letter_spacing","definition.data.styles.line_height","definition.data.styles.mobile_stretch_content","definition.data.styles.text_align","definition.data.styles.text_decoration","definition.data.styles.text_table_layout","definition.type","id","name","screenshot_status","screenshot_url","updated"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "campaign-variation::email::01KH00000000000000000000AB"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Template Universal Content ID for Translation — klaviyo.get_template_universal_content_id_for_translation
Get the template universal content for the given translation ID. Rate limits: Burst: 10/s Steady: 150/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the translation | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "campaign-variation::email::01KH00000000000000000000AB"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Web Feeds — klaviyo.get_web_feeds
Get all web feeds for an account. Rate limits: Burst: 1/s Steady: 15/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[web-feed] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[web-feed][] |
string | Optional | enum: ["content_type","created","id","name","request_method","status","updated","url"] |
|
query.filter |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#filtering Allowed field(s)/operator(s): name: any, contains, equals (string) created: greater-or-equal, greater-than, less-or-equal, less-than (date-time) updated: greater-or-equal, greater-than, less-or-equal, less-than (date-time) |
|
query.page[cursor] |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#pagination | |
query.page[size] |
integer | Optional | Default: 5. Min: 1. Max: 20. | default: 5; minimum: 1; maximum: 20 |
query.sort |
string | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sorting | enum: ["created","-created","name","-name","updated","-updated"] |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Web Feed — klaviyo.create_web_feed
Create a web feed. Rate limits: Burst: 1/s Steady: 15/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[web-feed] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[web-feed][] |
string | Optional | enum: ["content_type","created","id","name","request_method","status","updated","url"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/WebFeedCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "web-feed",
"attributes": {
"name": "Blog_posts",
"url": "https://help.klaviyo.com/api/v2/help_center/en-us/articles.json",
"request_method": "get",
"content_type": "json"
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Web Feed — klaviyo.get_web_feed
Get the web feed with the given ID. Rate limits: Burst: 1/s Steady: 15/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the web feed | |
query |
object | Optional | additionalProperties: false |
|
query.fields[web-feed] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[web-feed][] |
string | Optional | enum: ["content_type","created","id","name","request_method","status","updated","url"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Web Feed — klaviyo.update_web_feed
Update the web feed with the given ID. Rate limits: Burst: 1/s Steady: 15/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the web feed | |
query |
object | Optional | additionalProperties: false |
|
query.fields[web-feed] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[web-feed][] |
string | Optional | enum: ["content_type","created","id","name","request_method","status","updated","url"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/WebFeedPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "web-feed",
"id": "925e385b52fb",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Web Feed — klaviyo.delete_web_feed
Delete the web feed with the given ID. Rate limits: Burst: 1/s Steady: 15/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the web feed | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "925e385b52fb"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Webhooks — klaviyo.get_webhooks
Get all webhooks in an account. Rate limits: Burst: 1/s Steady: 15/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[webhook-topic] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[webhook-topic][] |
string | Optional | enum: ["id"] |
|
query.fields[webhook] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[webhook][] |
string | Optional | enum: ["created_at","description","enabled","endpoint_url","id","name","updated_at"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["webhook-topics"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Create Webhook — klaviyo.create_webhook
Create a new Webhook Rate limits: Burst: 1/s Steady: 15/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[webhook] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[webhook][] |
string | Optional | enum: ["created_at","description","enabled","endpoint_url","id","name","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/WebhookCreateQuery" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "webhook",
"attributes": {
"name": "My Webhook",
"endpoint_url": "https://www.example.com/example/path",
"secret_key": "INSERT_SECRET_KEY"
},
"relationships": {
"webhook-topics": {}
}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Webhook — klaviyo.get_webhook
Get the webhook with the given ID. Rate limits: Burst: 1/s Steady: 15/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the webhook. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[webhook-topic] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[webhook-topic][] |
string | Optional | enum: ["id"] |
|
query.fields[webhook] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[webhook][] |
string | Optional | enum: ["created_at","description","enabled","endpoint_url","id","name","updated_at"] |
|
query.include |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#relationships | |
query.include[] |
string | Optional | enum: ["webhook-topics"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Update Webhook — klaviyo.update_webhook
Update the webhook with the given ID. Rate limits: Burst: 1/s Steady: 15/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the webhook. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[webhook] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[webhook][] |
string | Optional | enum: ["created_at","description","enabled","endpoint_url","id","name","updated_at"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
body |
— | Required | $ref: "#/definitions/WebhookPartialUpdateQuery" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
},
"body": {
"data": {
"type": "webhook",
"id": "example",
"attributes": {}
}
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Delete Webhook — klaviyo.delete_webhook
Delete a webhook with the given ID. Rate limits: Burst: 1/s Steady: 15/m
This operation can change provider data. Review the input before allowing an agent to call it.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the webhook. | |
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "example"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Webhook Topics — klaviyo.get_webhook_topics
Get all webhook topics in a Klaviyo account. Rate limits: Burst: 1/s Steady: 15/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
query |
object | Optional | additionalProperties: false |
|
query.fields[webhook-topic] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[webhook-topic][] |
string | Optional | enum: ["id"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Get Webhook Topic — klaviyo.get_webhook_topic
Get the webhook topic with the given ID. Rate limits: Burst: 1/s Steady: 15/m
This is a read operation. Provider rate limits and data access rules still apply.
Parameters
Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.
| Parameter | Type | Required in parent | Description | Constraints |
|---|---|---|---|---|
path |
object | Required | additionalProperties: false |
|
path.id |
string | Required | The ID of the webhook topic. | |
query |
object | Optional | additionalProperties: false |
|
query.fields[webhook-topic] |
array | Optional | For more information please visit https://developers.klaviyo.com/en/v2026-10-15/reference/api-overview#sparse-fieldsets | |
query.fields[webhook-topic][] |
string | Optional | enum: ["id"] |
|
headers |
object | Required | additionalProperties: false |
|
headers.revision |
string | Required | API endpoint revision (format: YYYY-MM-DD[.suffix]) | enum: ["2026-10-15"]; default: "2026-10-15" |
Full JSON Schema
Example input
{
"path": {
"id": "event:klaviyo.sent_sms"
},
"headers": {
"revision": "2026-10-15"
}
}
At most 1 provider requests per invocation; timeout: 30 seconds.
Errors
Check the key's expiry, revocation, workspace and allowed operations.
Reuse the same idempotency key only for the same request.
The connection or provider limit has been reached. Check the receipt before retrying.
Test the connection
Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.