Connectors
Marketing & Customer Engagement
Klaviyo
Ecommerce marketing: profiles, lists, segments, campaigns, and event tracking
Klaviyo API referenceAPI checked August 18, 2026
- Signs in with
- API key
- Runs on
- Cloud or On-Prem Worker
- Operations
- 345
- Ready-made triggers
- 0
Connect Klaviyo
- In Neblex open Connect › Connections and click New Connection.
- Search for Klaviyo and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| Private API keyRequiredSecret |
Use it in a flow
- Open a flow, open the node library and search for Klaviyo.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from Klaviyo without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Klaviyo can send webhooks, a Webhook trigger receives them at its own URL.
Operations
345 operations in 23 groups. Each one is a step you can add to a flow.
Account2
Get Accountget_account | GET | Retrieve a single account object by its account ID. |
Get Accountsget_accounts | GET | Retrieve the account(s) associated with a given private API key. |
Campaign26
Assign Template to Campaign Messageassign_template_to_campaign_message | POST | Creates a non-reusable version of the template and assigns it to the message. |
Cancel Campaign Sendcancel_campaign_send | PATCH | 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 |
Create Campaigncreate_campaign | POST | Creates a campaign given a set of parameters, then returns it. |
Create Campaign Clonecreate_campaign_clone | POST | Clones an existing campaign, returning a new campaign based on the original with a new ID and name. |
Delete Campaigndelete_campaign | DELETE | Delete a campaign with the given campaign ID. |
Get Campaignget_campaign | GET | Returns a specific campaign based on a required id. |
Get Campaign for Campaign Messageget_campaign_for_campaign_message | GET | Return the related campaign Rate limits : Burst: 10/s Steady: 150/m |
Get Campaign ID for Campaign Messageget_campaign_id_for_campaign_message | GET | Returns the ID of the related campaign Rate limits : Burst: 10/s Steady: 150/m |
Get Campaign Messageget_campaign_message | GET | Returns a specific message based on a required id. |
Get Campaign Recipient Estimationget_campaign_recipient_estimation | GET | Get the estimated recipient count for a campaign with the provided campaign ID. |
Get Campaign Recipient Estimation Jobget_campaign_recipient_estimation_job | GET | Retrieve the status of a recipient estimation job triggered with the Create Campaign Recipient Estimation Job endpoint. |
Get Campaign Send Jobget_campaign_send_job | GET | Get a campaign send job Rate limits : Burst: 10/s Steady: 150/m |
Get Campaignsget_campaigns | GET | Returns some or all campaigns based on filters. |
Get Image for Campaign Messageget_image_for_campaign_message | GET | Return the related image for a given campaign message Rate limits : Burst: 10/s Steady: 150/m |
Get Image ID for Campaign Messageget_image_id_for_campaign_message | GET | Returns the ID of the related image Rate limits : Burst: 10/s Steady: 150/m |
Get Message IDs for Campaignget_message_ids_for_campaign | GET | Returns the IDs of all messages associated with the given campaign. |
Get Messages for Campaignget_messages_for_campaign | GET | Return all messages that belong to the given campaign. |
Get Tag IDs for Campaignget_tag_ids_for_campaign | GET | Returns the IDs of all tags associated with the given campaign. |
Get Tags for Campaignget_tags_for_campaign | GET | Return all tags that belong to the given campaign. |
Get Template for Campaign Messageget_template_for_campaign_message | GET | Return the related template Rate limits : Burst: 10/s Steady: 150/m |
Get Template ID for Campaign Messageget_template_id_for_campaign_message | GET | Returns the ID of the related template Rate limits : Burst: 10/s Steady: 150/m |
Refresh Campaign Recipient Estimationrefresh_campaign_recipient_estimation | POST | Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. |
Send Campaignsend_campaign | POST | Trigger a campaign to send asynchronously Rate limits : Burst: 10/s Steady: 150/m |
Update Campaignupdate_campaign | PATCH | Update a campaign with the given campaign ID. |
Update Campaign Messageupdate_campaign_message | PATCH | Update a campaign message Rate limits : Burst: 10/s Steady: 150/m |
Update Image for Campaign Messageupdate_image_for_campaign_message | PATCH | Update a campaign message image Rate limits : Burst: 10/s Steady: 150/m |
Catalog55
Add Categories to Catalog Itemadd_categories_to_catalog_item | POST | Create a new catalog category relationship for the given item ID. |
Add Items to Catalog Categoryadd_items_to_catalog_category | POST | Create a new item relationship for the given category ID. |
Bulk Create Catalog Categoriesbulk_create_catalog_categories | POST | Create a catalog category bulk create job to create a batch of catalog categories. |
Bulk Create Catalog Itemsbulk_create_catalog_items | POST | Create a catalog item bulk create job to create a batch of catalog items. |
Bulk Create Catalog Variantsbulk_create_catalog_variants | POST | Create a catalog variant bulk create job to create a batch of catalog variants. |
Bulk Delete Catalog Categoriesbulk_delete_catalog_categories | POST | Create a catalog category bulk delete job to delete a batch of catalog categories. |
Bulk Delete Catalog Itemsbulk_delete_catalog_items | POST | Create a catalog item bulk delete job to delete a batch of catalog items. |
Bulk Delete Catalog Variantsbulk_delete_catalog_variants | POST | Create a catalog variant bulk delete job to delete a batch of catalog variants. |
Bulk Update Catalog Categoriesbulk_update_catalog_categories | POST | Create a catalog category bulk update job to update a batch of catalog categories. |
Bulk Update Catalog Itemsbulk_update_catalog_items | POST | Create a catalog item bulk update job to update a batch of catalog items. |
Bulk Update Catalog Variantsbulk_update_catalog_variants | POST | Create a catalog variant bulk update job to update a batch of catalog variants. |
Create Back In Stock Subscriptioncreate_back_in_stock_subscription | POST | Subscribe a profile to receive back in stock notifications. |
Create Catalog Categorycreate_catalog_category | POST | Create a new catalog category. |
Create Catalog Itemcreate_catalog_item | POST | Create a new catalog item. |
Create Catalog Variantcreate_catalog_variant | POST | Create a new variant for a related catalog item. |
Delete Catalog Categorydelete_catalog_category | DELETE | Delete a catalog category using the given category ID. |
Delete Catalog Itemdelete_catalog_item | DELETE | Delete a catalog item with the given item ID. |
Delete Catalog Variantdelete_catalog_variant | DELETE | Delete a catalog item variant with the given variant ID. |
Get Bulk Create Catalog Items Jobget_bulk_create_catalog_items_job | GET | Get a catalog item bulk create job with the given job ID. |
Get Bulk Create Catalog Items Jobsget_bulk_create_catalog_items_jobs | GET | Get all catalog item bulk create jobs. |
Get Bulk Create Categories Jobget_bulk_create_categories_job | GET | Get a catalog category bulk create job with the given job ID. |
Get Bulk Create Categories Jobsget_bulk_create_categories_jobs | GET | Get all catalog category bulk create jobs. |
Get Bulk Create Variants Jobget_bulk_create_variants_job | GET | Get a catalog variant bulk create job with the given job ID. |
Get Bulk Create Variants Jobsget_bulk_create_variants_jobs | GET | Get all catalog variant bulk create jobs. |
Get Bulk Delete Catalog Items Jobget_bulk_delete_catalog_items_job | GET | Get a catalog item bulk delete job with the given job ID. |
Get Bulk Delete Catalog Items Jobsget_bulk_delete_catalog_items_jobs | GET | Get all catalog item bulk delete jobs. |
Get Bulk Delete Categories Jobget_bulk_delete_categories_job | GET | Get a catalog category bulk delete job with the given job ID. |
Get Bulk Delete Categories Jobsget_bulk_delete_categories_jobs | GET | Get all catalog category bulk delete jobs. |
Get Bulk Delete Variants Jobget_bulk_delete_variants_job | GET | Get a catalog variant bulk delete job with the given job ID. |
Get Bulk Delete Variants Jobsget_bulk_delete_variants_jobs | GET | Get all catalog variant bulk delete jobs. |
Get Bulk Update Catalog Items Jobget_bulk_update_catalog_items_job | GET | Get a catalog item bulk update job with the given job ID. |
Get Bulk Update Catalog Items Jobsget_bulk_update_catalog_items_jobs | GET | Get all catalog item bulk update jobs. |
Get Bulk Update Categories Jobget_bulk_update_categories_job | GET | Get a catalog category bulk update job with the given job ID. |
Get Bulk Update Categories Jobsget_bulk_update_categories_jobs | GET | Get all catalog category bulk update jobs. |
Get Bulk Update Variants Jobget_bulk_update_variants_job | GET | Get a catalog variate bulk update job with the given job ID. |
Get Bulk Update Variants Jobsget_bulk_update_variants_jobs | GET | Get all catalog variant bulk update jobs. |
Get Catalog Categoriesget_catalog_categories | GET | Get all catalog categories in an account. |
Get Catalog Categoryget_catalog_category | GET | Get a catalog category with the given category ID. |
Get Catalog Itemget_catalog_item | GET | Get a specific catalog item with the given item ID. |
Get Catalog Itemsget_catalog_items | GET | Get all catalog items in an account. |
Get Catalog Variantget_catalog_variant | GET | Get a catalog item variant with the given variant ID. |
Get Catalog Variantsget_catalog_variants | GET | Get all variants in an account. |
Get Categories for Catalog Itemget_categories_for_catalog_item | GET | Get all catalog categories that an item with the given item ID is in. |
Get Category IDs for Catalog Itemget_category_ids_for_catalog_item | GET | Get all catalog categories that a particular item is in. |
Get Item IDs for Catalog Categoryget_item_ids_for_catalog_category | GET | Get all items in the given category ID. |
Get Items for Catalog Categoryget_items_for_catalog_category | GET | Get all items in a category with the given category ID. |
Get Variant IDs for Catalog Itemget_variant_ids_for_catalog_item | GET | Get all variants related to the given item ID. |
Get Variants for Catalog Itemget_variants_for_catalog_item | GET | Get all variants related to the given item ID. |
Remove Categories from Catalog Itemremove_categories_from_catalog_item | DELETE | Delete catalog category relationships for the given item ID. |
Remove Items from Catalog Categoryremove_items_from_catalog_category | DELETE | Delete item relationships for the given category ID. |
Update Catalog Categoryupdate_catalog_category | PATCH | Update a catalog category with the given category ID. |
Update Catalog Itemupdate_catalog_item | PATCH | Update a catalog item with the given item ID. |
Update Catalog Variantupdate_catalog_variant | PATCH | Update a catalog item variant with the given variant ID. |
Update Categories for Catalog Itemupdate_categories_for_catalog_item | PATCH | Update catalog category relationships for the given item ID. |
Update Items for Catalog Categoryupdate_items_for_catalog_category | PATCH | Update item relationships for the given category ID. |
Client12
Bulk Create Client Eventsbulk_create_client_events | POST | Create new events to track a profile's activity. |
Create Client Back In Stock Subscriptioncreate_client_back_in_stock_subscription | POST | Subscribe a profile to receive back in stock notifications. |
Create Client Eventcreate_client_event | POST | Create a new event to track a profile's activity. |
Create Client Reviewcreate_client_review | POST | Create a review with the given ID. |
Create Client Subscriptioncreate_client_subscription | POST | Creates a subscription and consent record for email and/or SMS channels based on the provided email and phone number attributes, respectively. |
Create or Update Client Profilecreate_client_profile | POST | Create or update properties about a profile without tracking an associated event. |
Create or Update Client Push Tokencreate_client_push_token | POST | Create or update a push token. |
Get Client Geofencesget_client_geofences | GET | Get all geofences in an account. |
Get Client IP Allowlistget_client_ip_allowlist | GET | Return the current integration-egress IP allow list. |
Get Client Review Values Reportsget_client_review_values_reports | GET | Get all reviews values reports in an account. |
Get Client Reviewsget_client_reviews | GET | Get all reviews. |
Unregister Client Push Tokenunregister_client_push_token | POST | Unregister a push token. |
Conversation1
Create Conversation Messagecreate_conversation_message | POST | Send an outbound message to a conversation. |
Coupon17
Bulk Create Coupon Codesbulk_create_coupon_codes | POST | Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. |
Create Couponcreate_coupon | POST | Creates a new coupon. |
Create Coupon Codecreate_coupon_code | POST | Synchronously creates a coupon code for the given coupon. |
Delete Coupondelete_coupon | DELETE | Delete the coupon with the given coupon ID. |
Delete Coupon Codedelete_coupon_code | DELETE | Deletes a coupon code specified by the given identifier synchronously. |
Get Bulk Create Coupon Code Jobsget_bulk_create_coupon_code_jobs | GET | Get all coupon code bulk create jobs. |
Get Bulk Create Coupon Codes Jobget_bulk_create_coupon_codes_job | GET | Get a coupon code bulk create job with the given job ID. |
Get Couponget_coupon | GET | Get a specific coupon with the given coupon ID. |
Get Coupon Codeget_coupon_code | GET | Returns a Coupon Code specified by the given identifier. |
Get Coupon Code IDs for Couponget_coupon_code_ids_for_coupon | GET | Gets a list of coupon code relationships associated with the given coupon id Rate limits : Burst: 75/s Steady: 750/m |
Get Coupon Codesget_coupon_codes | GET | Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles. |
Get Coupon Codes for Couponget_coupon_codes_for_coupon | GET | Gets a list of coupon codes associated with the given coupon id Rate limits : Burst: 75/s Steady: 750/m |
Get Coupon For Coupon Codeget_coupon_for_coupon_code | GET | Get the coupon associated with a given coupon code ID. |
Get Coupon ID for Coupon Codeget_coupon_id_for_coupon_code | GET | Gets the coupon relationship associated with the given coupon code id Rate limits : Burst: 75/s Steady: 750/m |
Get Couponsget_coupons | GET | Get all coupons in an account. |
Update Couponupdate_coupon | PATCH | Rate limits : Burst: 3/s Steady: 60/m |
Update Coupon Codeupdate_coupon_code | PATCH | Updates a coupon code specified by the given identifier synchronously. |
Custom Object39
Bulk Create Data Source Recordsbulk_create_data_source_records | POST | Create a bulk data source record import job to create a batch of records. |
Bulk Delete Object Recordsbulk_delete_object_records | POST | Delete a batch of object records. |
Create Data Sourcecreate_data_source | POST | Create a new data source in an account Rate limits : Burst: 3/s Steady: 60/m |
Create Data Source Recordcreate_data_source_record | POST | Create a data source record import job to create a single record. |
Create Object Schemacreate_object_schema | POST | Create an object schema. |
Create Object Schema Relationshipcreate_object_schema_relationship | POST | Create a relationship between object schemas. |
Create Object Typecreate_object_type | POST | Create an object type. |
Create Profile Schema Relationshipcreate_profile_schema_relationship | POST | Create a relationship between an object schema and a profile Rate limits : Burst: 3/s Steady: 60/m |
Delete Data Sourcedelete_data_source | DELETE | Delete a data source in an account. |
Delete Object Schema Relationshipdelete_object_schema_relationship | DELETE | Delete a relationship between object schemas Rate limits : Burst: 3/s Steady: 60/m |
Delete Object Typedelete_object_type | DELETE | Delete the object type with the given ID. |
Delete Profile Schema Relationshipdelete_profile_schema_relationship | DELETE | Delete a relationship between an object schema and a profile Rate limits : Burst: 3/s Steady: 60/m |
Get Current Schema for Object Typeget_current_schema_for_object_type | GET | Get current schema for an object type Rate limits : Burst: 3/s Steady: 60/m |
Get Current Schema ID for Object Typeget_current_schema_id_for_object_type | GET | Get current schema for an object type Rate limits : Burst: 3/s Steady: 60/m |
Get Data Sourceget_data_source | GET | Retrieve a data source in an account. |
Get Data Sourcesget_data_sources | GET | Get all data sources in an account. |
Get Draft Schema for Object Typeget_draft_schema_for_object_type | GET | Get draft schema for an object type Rate limits : Burst: 3/s Steady: 60/m |
Get Draft Schema ID for Object Typeget_draft_schema_id_for_object_type | GET | Get draft schema for an object type Rate limits : Burst: 3/s Steady: 60/m |
Get Ingestion Log IDs for Object Typeget_ingestion_log_ids_for_object_type | GET | Get the ingestion logs for a given object type. |
Get Ingestion Logs for Object Typeget_ingestion_logs_for_object_type | GET | Get the ingestion logs for a given object type. |
Get Object Recordget_object_record | GET | Get the object record with the given compound ID. |
Get Object Schemaget_object_schema | GET | Get the object schema with the given ID. |
Get Object Schema Relationshipsget_object_schema_relationships | GET | Get related object schemas for an object schema Rate limits : Burst: 3/s Steady: 60/m |
Get Object Typeget_object_type | GET | Get the object type with the given ID. |
Get Object Type Relationshipsget_object_type_relationships | GET | Get related object types for an object type Rate limits : Burst: 3/s Steady: 60/m |
Get Object Typesget_object_types | GET | Get all object types in an account. |
Get Profile Schema Relationshipsget_profile_schema_relationships | GET | Get related profile object schemas for an object schema Rate limits : Burst: 3/s Steady: 60/m |
Get Profile Type Relationshipsget_profile_type_relationships | GET | Get related profile object types for an object type Rate limits : Burst: 3/s Steady: 60/m |
Get Record IDs for Object Typeget_record_ids_for_object_type | GET | Get all object records for a given object type. |
Get Records for Object Typeget_records_for_object_type | GET | Get all object records for a given object type. |
Get Schema Version IDs for Object Typeget_schema_version_ids_for_object_type | GET | Get all schema versions for an object type Rate limits : Burst: 3/s Steady: 60/m |
Get Schema Versions for Object Typeget_schema_versions_for_object_type | GET | Get all schema versions for an object type Rate limits : Burst: 3/s Steady: 60/m |
Get Source Mappingget_source_mapping | GET | Get the source mapping with the given ID. |
Get Source Mapping for Object Schemaget_source_mapping_for_object_schema | GET | Get source mapping for an object schema Rate limits : Burst: 3/s Steady: 60/m |
Get Source Mapping ID for Object Schemaget_source_mapping_id_for_object_schema | GET | Get source mapping for an object schema Rate limits : Burst: 3/s Steady: 60/m |
Update Object Schemaupdate_object_schema | PATCH | Update the object schema with the given ID. |
Update Object Schema Relationshipupdate_object_schema_relationship | PATCH | Update a relationship between object schemas Rate limits : Burst: 3/s Steady: 60/m |
Update Profile Schema Relationshipupdate_profile_schema_relationship | PATCH | Update a relationship between an object schema and a profile Rate limits : Burst: 3/s Steady: 60/m |
Update Source Mappingupdate_source_mapping | PATCH | Update the source mapping with the given ID. |
Data Privacy1
Request Profile Deletionrequest_profile_deletion | POST | Request a deletion for the profiles corresponding to one of the following identifiers: email, phone number, or id. |
Event8
Bulk Create Eventsbulk_create_events | POST | Create a batch of events for one or more profiles. |
Create Eventcreate_event | POST | Create a new event to track a profile's activity. |
Get Eventget_event | GET | Get an event with the given event ID. |
Get Eventsget_events | GET | Get all events in an account |
Get Metric for Eventget_metric_for_event | GET | Get the metric for an event with the given event ID. |
Get Metric ID for Eventget_metric_id_for_event | GET | Get a list of related Metrics for an Event Rate limits : Burst: 350/s Steady: 3500/m |
Get Profile for Eventget_profile_for_event | GET | Get the profile associated with an event with the given event ID. |
Get Profile ID for Eventget_profile_id_for_event | GET | Get profile relationships for an event with the given event ID. |
Flow21
Create Flowcreate_flow | POST | Create a new flow using an encoded flow definition. |
Delete Flowdelete_flow | DELETE | Delete a flow with the given flow ID. |
Delete Flow Actiondelete_flow_action | DELETE | Delete a flow action. |
Get Action for Flow Messageget_action_for_flow_message | GET | Get the flow action for a flow message with the given message ID. |
Get Action ID for Flow Messageget_action_id_for_flow_message | GET | Get the relationship for a flow message's flow action, given the flow ID. |
Get Action IDs for Flowget_action_ids_for_flow | GET | Get all relationships for flow actions associated with the given flow ID. |
Get Actions for Flowget_actions_for_flow | GET | Get all flow actions associated with the given flow ID. |
Get Flowget_flow | GET | Get a flow with the given flow ID. |
Get Flow Actionget_flow_action | GET | Get a flow action from a flow with the given flow action ID. |
Get Flow for Flow Actionget_flow_for_flow_action | GET | Get the flow associated with the given action ID. |
Get Flow ID for Flow Actionget_flow_id_for_flow_action | GET | Get the flow associated with the given action ID. |
Get Flow Messageget_flow_message | GET | Get a flow message from a flow with the given flow message ID. |
Get Flowsget_flows | GET | Get all flows in an account. |
Get Message IDs for Flow Actionget_message_ids_for_flow_action | GET | Get all relationships for flow messages associated with the given flow action ID. |
Get Messages For Flow Actionget_flow_action_messages | GET | Get all flow messages associated with the given flow action ID. |
Get Tag IDs for Flowget_tag_ids_for_flow | GET | Return the tag IDs of all tags associated with the given flow. |
Get Tags for Flowget_tags_for_flow | GET | Return all tags associated with the given flow ID. |
Get Template for Flow Messageget_template_for_flow_message | GET | Return the related template Rate limits : Burst: 3/s Steady: 60/m |
Get Template ID for Flow Messageget_template_id_for_flow_message | GET | Returns the ID of the related template Rate limits : Burst: 3/s Steady: 60/m |
Update Flow Actionupdate_flow_action | PATCH | Update a flow action. |
Update Flow Statusupdate_flow | PATCH | Update the status of a flow with the given flow ID, and all actions in that flow. |
Form9
Create Formcreate_form | POST | Create a new form. |
Delete Formdelete_form | DELETE | Delete a given form. |
Get Formget_form | GET | Get the form with the given ID. |
Get Form for Form Versionget_form_for_form_version | GET | Get the form associated with the given form version. |
Get Form ID for Form Versionget_form_id_for_form_version | GET | Get the ID of the form associated with the given form version. |
Get Form Versionget_form_version | GET | Get the form version with the given ID. |
Get Formsget_forms | GET | Get all forms in an account. |
Get Version IDs for Formget_version_ids_for_form | GET | Get the IDs of the form versions for the given form. |
Get Versions for Formget_versions_for_form | GET | Get the form versions for the given form. |
Image5
Get Imageget_image | GET | Get the image with the given image ID. |
Get Imagesget_images | GET | Get all images in an account. |
Update Imageupdate_image | PATCH | Update the image with the given image ID. |
Upload Image From Fileupload_image_from_file | POST | Upload an image from a file. |
Upload Image From URLupload_image_from_url | POST | Import an image from a url or data uri. |
List13
Add Profiles to Listadd_profiles_to_list | POST | Add a profile to a list with the given list ID. |
Create Listcreate_list | POST | Create a new list. |
Delete Listdelete_list | DELETE | Delete a list with the given list ID. |
Get Flows Triggered by Listget_flows_triggered_by_list | GET | Get all flows where the given list ID is being used as the trigger. |
Get IDs for Flows Triggered by Listget_ids_for_flows_triggered_by_list | GET | Get the IDs of all flows where the given list is being used as the trigger. |
Get Listget_list | GET | Get a list with the given list ID. |
Get Listsget_lists | GET | Get all lists in an account. |
Get Profile IDs for Listget_profile_ids_for_list | GET | Get profile membership relationships for a list with the given list ID. |
Get Profiles for Listget_profiles_for_list | GET | Get all profiles within a list with the given list ID. |
Get Tag IDs for Listget_tag_ids_for_list | GET | Return all tags associated with the given list ID. |
Get Tags for Listget_tags_for_list | GET | Return all tags associated with the given list ID. |
Remove Profiles from Listremove_profiles_from_list | DELETE | Remove a profile from a list with the given list ID. |
Update Listupdate_list | PATCH | Update the name of a list with the given list ID. |
Metric24
Create Custom Metriccreate_custom_metric | POST | Create a new custom metric. |
Delete Custom Metricdelete_custom_metric | DELETE | Delete a custom metric with the given custom metric ID. |
Get Custom Metricget_custom_metric | GET | Get a custom metric with the given custom metric ID. |
Get Custom Metric for Mapped Metricget_custom_metric_for_mapped_metric | GET | Get the custom metric for the given mapped metric ID (if applicable). |
Get Custom Metric ID for Mapped Metricget_custom_metric_id_for_mapped_metric | GET | Get the ID of the custom metric for the given mapped metric. |
Get Custom Metricsget_custom_metrics | GET | Get all custom metrics in an account. |
Get Flows Triggered by Metricget_flows_triggered_by_metric | GET | Get all flows where the given metric is being used as the trigger. |
Get IDs for Flows Triggered by Metricget_ids_for_flows_triggered_by_metric | GET | Get the IDs of all flows where the given metric is being used as the trigger. |
Get Mapped Metricget_mapped_metric | GET | Get the mapped metric with the given ID. |
Get Mapped Metricsget_mapped_metrics | GET | Get all mapped metrics in an account. |
Get Metricget_metric | GET | Get a metric with the given metric ID. |
Get Metric for Mapped Metricget_metric_for_mapped_metric | GET | Get the metric for the given mapped metric ID (if applicable). |
Get Metric for Metric Propertyget_metric_for_metric_property | GET | Get the metric for the given metric property ID. |
Get Metric ID for Mapped Metricget_metric_id_for_mapped_metric | GET | Get the ID of the metric for the given mapped metric. |
Get Metric ID for Metric Propertyget_metric_id_for_metric_property | GET | Get the ID of the metric for the given metric property. |
Get Metric IDs for Custom Metricget_metric_ids_for_custom_metric | GET | Get all metrics for the given custom metric ID. |
Get Metric Propertyget_metric_property | GET | Get a metric property with the given metric property ID. |
Get Metricsget_metrics | GET | Get all metrics in an account. |
Get Metrics for Custom Metricget_metrics_for_custom_metric | GET | Get all metrics for the given custom metric ID. |
Get Properties for Metricget_properties_for_metric | GET | Get the metric properties for the given metric ID. |
Get Property IDs for Metricget_property_ids_for_metric | GET | Get the IDs of metric properties for the given metric. |
Query Metric Aggregatesquery_metric_aggregates | POST | 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... |
Update Custom Metricupdate_custom_metric | PATCH | Update a custom metric with the given custom metric ID. |
Update Mapped Metricupdate_mapped_metric | PATCH | Update the mapped metric with the given ID. |
Profile38
Bulk Import Profilesbulk_import_profiles | POST | Create a bulk profile import job to create or update a batch of profiles. |
Bulk Subscribe Profilesbulk_subscribe_profiles | POST | Subscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. |
Bulk Suppress Profilesbulk_suppress_profiles | POST | Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list. |
Bulk Unsubscribe Profilesbulk_unsubscribe_profiles | POST | 🚧 Profiles not in the specified list will be globally unsubscribed. |
Bulk Unsuppress Profilesbulk_unsuppress_profiles | POST | Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list. |
Create or Update Profilecreate_or_update_profile | POST | Given a set of profile attributes and optionally an ID, create or update a profile. |
Create or Update Push Tokencreate_push_token | POST | Create or update a push token. |
Create Profilecreate_profile | POST | Create a new profile. |
Delete Push Tokendelete_push_token | DELETE | Delete a specific push token based on its ID. |
Get Bulk Import Profiles Jobget_bulk_import_profiles_job | GET | Get a bulk profile import job with the given job ID. |
Get Bulk Import Profiles Jobsget_bulk_import_profiles_jobs | GET | Get all bulk profile import jobs. |
Get Bulk Suppress Profiles Jobget_bulk_suppress_profiles_job | GET | Get the bulk suppress profiles job with the given job ID. |
Get Bulk Suppress Profiles Jobsget_bulk_suppress_profiles_jobs | GET | Get the status of all bulk profile suppression jobs. |
Get Bulk Unsuppress Profiles Jobget_bulk_unsuppress_profiles_job | GET | Get the bulk unsuppress profiles job with the given job ID. |
Get Bulk Unsuppress Profiles Jobsget_bulk_unsuppress_profiles_jobs | GET | Get all bulk unsuppress profiles jobs. |
Get Conversation for Profileget_conversation_for_profile | GET | Get the conversation for a profile with the given profile ID. |
Get Conversation ID for Profileget_conversation_id_for_profile | GET | Get the conversation relationship for a profile with the given profile ID. |
Get Conversation IDs for Profileget_conversation_ids_for_profile | GET | Get the IDs of all conversations for a profile across all channels. |
Get Conversations for Profileget_conversations_for_profile | GET | Get all conversations for a profile with the given profile ID. |
Get Errors for Bulk Import Profiles Jobget_errors_for_bulk_import_profiles_job | GET | Get import errors for the bulk profile import job with the given ID. |
Get List for Bulk Import Profiles Jobget_list_for_bulk_import_profiles_job | GET | Get list for the bulk profile import job with the given ID. |
Get List IDs for Bulk Import Profiles Jobget_list_ids_for_bulk_import_profiles_job | GET | Get list relationship for the bulk profile import job with the given ID. |
Get List IDs for Profileget_list_ids_for_profile | GET | Get list memberships for a profile with the given profile ID. |
Get Lists for Profileget_lists_for_profile | GET | Get list memberships for a profile with the given profile ID. |
Get Profileget_profile | GET | Get the profile with the given profile ID. |
Get Profile for Push Tokenget_profile_for_push_token | GET | Return the profile associated with the given push token. |
Get Profile ID for Push Tokenget_profile_id_for_push_token | GET | Return the ID of the profile associated with the given push token. |
Get Profile IDs for Bulk Import Profiles Jobget_profile_ids_for_bulk_import_profiles_job | GET | Get profile relationships for the bulk profile import job with the given ID. |
Get Profilesget_profiles | GET | Get all profiles in an account. |
Get Profiles for Bulk Import Profiles Jobget_profiles_for_bulk_import_profiles_job | GET | Get profiles for the bulk profile import job with the given ID. |
Get Push Tokenget_push_token | GET | Return a specific push token based on its ID. |
Get Push Token IDs for Profileget_push_token_ids_for_profile | GET | Return the IDs of all push tokens associated with the given profile. |
Get Push Tokensget_push_tokens | GET | Return push tokens associated with company. |
Get Push Tokens for Profileget_push_tokens_for_profile | GET | Return all push tokens that belong to the given profile. |
Get Segment IDs for Profileget_segment_ids_for_profile | GET | Get segment membership relationships for a profile with the given profile ID. |
Get Segments for Profileget_segments_for_profile | GET | Get segment memberships for a profile with the given profile ID. |
Merge Profilesmerge_profiles | POST | Merge a given related profile into a profile with the given profile ID. |
Update Profileupdate_profile | PATCH | Update the profile with the given profile ID. |
Reporting7
Query Campaign Valuesquery_campaign_values | POST | Returns the requested campaign analytics values data Rate limits : Burst: 1/s Steady: 2/m Daily: 225/d |
Query Flow Seriesquery_flow_series | POST | Returns the requested flow analytics series data Rate limits : Burst: 1/s Steady: 2/m Daily: 225/d |
Query Flow Valuesquery_flow_values | POST | Returns the requested flow analytics values data Rate limits : Burst: 1/s Steady: 2/m Daily: 225/d |
Query Form Seriesquery_form_series | POST | Returns the requested form analytics series data. |
Query Form Valuesquery_form_values | POST | Returns the requested form analytics values data. |
Query Segment Seriesquery_segment_series | POST | Returns the requested segment analytics series data. |
Query Segment Valuesquery_segment_values | POST | Returns the requested segment analytics values data. |
Review3
Get Reviewget_review | GET | Get the review with the given ID. |
Get Reviewsget_reviews | GET | Get all reviews. |
Update Reviewupdate_review | PATCH | Update a review. |
Segment11
Create Segmentcreate_segment | POST | Create a segment. |
Delete Segmentdelete_segment | DELETE | Delete a segment with the given segment ID. |
Get Flows Triggered by Segmentget_flows_triggered_by_segment | GET | Get all flows where the given segment ID is being used as the trigger. |
Get IDs for Flows Triggered by Segmentget_ids_for_flows_triggered_by_segment | GET | Get the IDs of all flows where the given segment is being used as the trigger. |
Get Profile IDs for Segmentget_profile_ids_for_segment | GET | Get all profile membership relationships for the given segment ID. |
Get Profiles for Segmentget_profiles_for_segment | GET | Get all profiles within a segment with the given segment ID. |
Get Segmentget_segment | GET | Get a segment with the given segment ID. |
Get Segmentsget_segments | GET | Get all segments in an account. |
Get Tag IDs for Segmentget_tag_ids_for_segment | GET | If related resource is tags, returns the tag IDs of all tags associated with the given segment ID. |
Get Tags for Segmentget_tags_for_segment | GET | Return all tags associated with the given segment ID. |
Update Segmentupdate_segment | PATCH | Update a segment with the given segment ID. |
Tag26
Create Tagcreate_tag | POST | Create a tag. |
Create Tag Groupcreate_tag_group | POST | Create a tag group. |
Delete Tagdelete_tag | DELETE | Delete the tag with the given tag ID. |
Delete Tag Groupdelete_tag_group | DELETE | Delete the tag group with the given tag group ID. |
Get Campaign IDs for Tagget_campaign_ids_for_tag | GET | Returns the IDs of all campaigns associated with the given tag. |
Get Flow IDs for Tagget_flow_ids_for_tag | GET | Returns the IDs of all flows associated with the given tag. |
Get List IDs for Tagget_list_ids_for_tag | GET | Returns the IDs of all lists associated with the given tag. |
Get Segment IDs for Tagget_segment_ids_for_tag | GET | Returns the IDs of all segments associated with the given tag. |
Get Tagget_tag | GET | Retrieve the tag with the given tag ID. |
Get Tag Groupget_tag_group | GET | Retrieve the tag group with the given tag group ID. |
Get Tag Group for Tagget_tag_group_for_tag | GET | Returns the tag group resource for a given tag ID. |
Get Tag Group ID for Tagget_tag_group_id_for_tag | GET | Returns the id of the tag group related to the given tag. |
Get Tag Groupsget_tag_groups | GET | List all tag groups in an account. |
Get Tag IDs for Tag Groupget_tag_ids_for_tag_group | GET | Returns the tag IDs of all tags inside the given tag group. |
Get Tagsget_tags | GET | List all tags in an account. |
Get Tags for Tag Groupget_tags_for_tag_group | GET | Return the tags for a given tag group ID. |
Remove Tag from Campaignsremove_tag_from_campaigns | DELETE | Remove a tag's association with one or more campaigns. |
Remove Tag from Flowsremove_tag_from_flows | DELETE | Remove a tag's association with one or more flows. |
Remove Tag from Listsremove_tag_from_lists | DELETE | Remove a tag's association with one or more lists. |
Remove Tag from Segmentsremove_tag_from_segments | DELETE | Remove a tag's association with one or more segments. |
Tag Campaignstag_campaigns | POST | Associate a tag with one or more campaigns. |
Tag Flowstag_flows | POST | Associate a tag with one or more flows. |
Tag Liststag_lists | POST | Associate a tag with one or more lists. |
Tag Segmentstag_segments | POST | Associate a tag with one or more segments. |
Update Tagupdate_tag | PATCH | Update the tag with the given tag ID. |
Update Tag Groupupdate_tag_group | PATCH | Update the tag group with the given tag group ID. |
Template12
Clone Templateclone_template | POST | Create a clone of a template with the given template ID. |
Create Templatecreate_template | POST | Create a new HTML or drag-and-drop template. |
Create Universal Contentcreate_universal_content | POST | Create universal content. |
Delete Templatedelete_template | DELETE | Delete a template with the given template ID. |
Delete Universal Contentdelete_universal_content | DELETE | Delete the universal content with the given ID. |
Get All Universal Contentget_all_universal_content | GET | Get all universal content in an account. |
Get Templateget_template | GET | Get a template with the given template ID. |
Get Templatesget_templates | GET | Get all templates in an account. |
Get Universal Contentget_universal_content | GET | Get the universal content with the given ID. |
Render Templaterender_template | POST | Render a template with the given template ID and context attribute. |
Update Templateupdate_template | PATCH | Update a template with the given template ID. |
Update Universal Contentupdate_universal_content | PATCH | Update universal content. |
Tracking Setting3
Get Tracking Settingget_tracking_setting | GET | Get the UTM tracking setting with the given account ID. |
Get Tracking Settingsget_tracking_settings | GET | Get all UTM tracking settings in an account. |
Update Tracking Settingupdate_tracking_setting | PATCH | Update the UTM tracking setting with the given account ID. |
Web Feed5
Create Web Feedcreate_web_feed | POST | Create a web feed. |
Delete Web Feeddelete_web_feed | DELETE | Delete the web feed with the given ID. |
Get Web Feedget_web_feed | GET | Get the web feed with the given ID. |
Get Web Feedsget_web_feeds | GET | Get all web feeds for an account. |
Update Web Feedupdate_web_feed | PATCH | Update the web feed with the given ID. |
Webhook7
Create Webhookcreate_webhook | POST | Create a new Webhook Rate limits : Burst: 1/s Steady: 15/m |
Delete Webhookdelete_webhook | DELETE | Delete a webhook with the given ID. |
Get Webhookget_webhook | GET | Get the webhook with the given ID. |
Get Webhook Topicget_webhook_topic | GET | Get the webhook topic with the given ID. |
Get Webhook Topicsget_webhook_topics | GET | Get all webhook topics in a Klaviyo account. |
Get Webhooksget_webhooks | GET | Get all webhooks in an account. |
Update Webhookupdate_webhook | PATCH | Update the webhook with the given ID. |