Klaviyo
Tools
Name & Description | Type |
---|---|
KLAVIYO_ADD_PROFILE_TO_LISTAdd profiles to a Klaviyo list by profile ids or email addresses. | action |
KLAVIYO_CREATE_CAMPAIGN_RECIPIENT_ESTIMATION_JOBStart an asynchronous task to estimate the number of recipients for a campaign. | action |
KLAVIYO_CREATE_EVENTCreate or update a profile event with minimum identifiers and metric name. | action |
KLAVIYO_CREATE_LISTCreate a new list. | action |
KLAVIYO_CREATE_OR_UPDATE_PROFILECreate or update a profile in Klaviyo with the given attributes. | action |
KLAVIYO_CREATE_PROFILECreate a new profile. | action |
KLAVIYO_GET_CAMPAIGNRetrieve a specific campaign by its id from Klaviyo. | action |
KLAVIYO_GET_CAMPAIGNSRetrieve campaigns from your Klaviyo account. | action |
KLAVIYO_GET_EVENTSGet all events in an account requests can be sorted by the following fields: `datetime`, `timestamp` returns a maximum of 200 events per page. | action |
KLAVIYO_GET_LISTSRetrieve marketing lists from your Klaviyo account. | action |
KLAVIYO_GET_PROFILESRetrieve profiles from your Klaviyo account. | action |
KLAVIYO_UPDATE_CAMPAIGNUpdate a campaign with the specified attributes. | action |
KLAVIYO_ASSIGN_CAMPAIGN_MESSAGE_TEMPLATECreates a non-reusable version of the template and assigns it to the message. | action |
KLAVIYO_BULK_CREATE_CLIENT_EVENTSUse the client-side endpoint with a public API key to track profile activity. | action |
KLAVIYO_BULK_CREATE_EVENTSThis API endpoint creates or updates profiles by batching up to 1,000 events, with a 5mb payload limit. | action |
KLAVIYO_CREATE_BACK_IN_STOCK_SUBSCRIPTIONUse the server-side endpoint to subscribe to restock alerts, following the back in stock API guide. | action |
KLAVIYO_CREATE_CAMPAIGNCreates a campaign given a set of parameters, then returns it. | action |
KLAVIYO_CREATE_CAMPAIGN_CLONEClones an existing campaign, returning a new campaign based on the original with a new id and name. | action |
KLAVIYO_CREATE_CAMPAIGN_SEND_JOBTrigger a campaign to send asynchronously<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:write`. | action |
KLAVIYO_CREATE_CATALOG_CATEGORYCreate a new catalog category. | action |
KLAVIYO_CREATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSCreate a new item relationship for the given category id. | action |
KLAVIYO_CREATE_CATALOG_ITEMCreate a new catalog item. | action |
KLAVIYO_CREATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESCreate a new catalog category relationship for the given item id. | action |
KLAVIYO_CREATE_CATALOG_VARIANTCreate a new variant for a related catalog item. | action |
KLAVIYO_CREATE_CLIENT_BACK_IN_STOCK_SUBSCRIPTIONUse the endpoint for client-side back in stock notifications with a public API key. | action |
KLAVIYO_CREATE_CLIENT_EVENTCreate client-side events to track profiles using a public API key, not for updating identifiers (server-side only). | action |
KLAVIYO_CREATE_CLIENT_SUBSCRIPTIONEndpoint manages email/sms opt-ins using consent and requires public API key for client use. | action |
KLAVIYO_CREATE_COUPONCreates a new coupon. | action |
KLAVIYO_CREATE_COUPON_CODESynchronously creates a coupon code for the given coupon. | action |
KLAVIYO_CREATE_OR_UPDATE_CLIENT_PROFILEUpdate user profiles without tracking using a public client-side API; use a private server-side API for identifier changes. | action |
KLAVIYO_CREATE_OR_UPDATE_CLIENT_PUSH_TOKENThis endpoint for mobile sdks (ios & android) creates/updates push tokens using a public API key. | action |
KLAVIYO_CREATE_OR_UPDATE_PUSH_TOKENMigrate or create push tokens with Klaviyo's endpoint, utilizing their mobile sdks for ios & android. | action |
KLAVIYO_CREATE_SEGMENTCreate a segment. | action |
KLAVIYO_CREATE_TAGSummary: instructions on creating a tag within an account's designated tag group with a maximum of 500 tags, with optional tag group specification. | action |
KLAVIYO_CREATE_TAG_GROUPCreate tag groups up to 50 per account, defaulting to non-exclusive unless specified. | action |
KLAVIYO_CREATE_TAG_RELATIONSHIPS_CAMPAIGNSSummary: link a tag to campaigns, ensuring a limit of 100 tags per campaign. | action |
KLAVIYO_CREATE_TAG_RELATIONSHIPS_FLOWSAssign tags to flows using their ids in the request body, ensuring a flow is not linked to over 100 tags. | action |
KLAVIYO_CREATE_TAG_RELATIONSHIPS_LISTSSummary: a tag can be added to one or more lists, with a max of 100 tags per list. | action |
KLAVIYO_CREATE_TAG_RELATIONSHIPS_SEGMENTSSummary: set tag associations with segments using the request body, limited to one tag per segment and up to 100 tags per segment. | action |
KLAVIYO_CREATE_TEMPLATESummary: custom html templates can be created unless an account reaches 1,000 template limit. | action |
KLAVIYO_CREATE_TEMPLATE_CLONEClone a template by its id, but cloning fails if account has 1,000+ templates. | action |
KLAVIYO_CREATE_TEMPLATE_RENDERRender an email template with specific context and sparse fieldsets, then get html/plain text. | action |
KLAVIYO_CREATE_WEBHOOKCreate a new webhook<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `15/m` **scopes:** `webhooks:write`. | action |
KLAVIYO_DELETE_CAMPAIGNDelete a campaign with the given campaign id. | action |
KLAVIYO_DELETE_CATALOG_CATEGORYDelete a catalog category using the given category id. | action |
KLAVIYO_DELETE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSDelete item relationships for the given category id. | action |
KLAVIYO_DELETE_CATALOG_ITEMDelete a catalog item with the given item id. | action |
KLAVIYO_DELETE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESDelete catalog category relationships for the given item id. | action |
KLAVIYO_DELETE_CATALOG_VARIANTDelete a catalog item variant with the given variant id. | action |
KLAVIYO_DELETE_COUPONDelete the coupon with the given coupon id. | action |
KLAVIYO_DELETE_COUPON_CODEDeletes a coupon code specified by the given identifier synchronously. | action |
KLAVIYO_DELETE_FLOWDelete a flow with the given flow id. | action |
KLAVIYO_DELETE_LISTDelete a list with the given list id. | action |
KLAVIYO_DELETE_SEGMENTDelete a segment with the given segment id. | action |
KLAVIYO_DELETE_TAGDelete the tag with the given tag id. | action |
KLAVIYO_DELETE_TAG_GROUPDelete a specified tag group and its contents; associated resource links will be removed. | action |
KLAVIYO_DELETE_TAG_RELATIONSHIPS_CAMPAIGNSDisconnect a tag from campaigns using the campaign id(s) in the request body. | action |
KLAVIYO_DELETE_TAG_RELATIONSHIPS_FLOWSRemove a tag's association with one or more flows. | action |
KLAVIYO_DELETE_TAG_RELATIONSHIPS_LISTSRemove a tag's association with one or more lists. | action |
KLAVIYO_DELETE_TAG_RELATIONSHIPS_SEGMENTSUse the request body to de-associate a tag from specified segment ids. | action |
KLAVIYO_DELETE_TEMPLATEDelete a template with the given template id. | action |
KLAVIYO_DELETE_WEBHOOKDelete a webhook with the given id. | action |
KLAVIYO_GET_ACCOUNTRetrieve a single account object by its account id. | action |
KLAVIYO_GET_ACCOUNTSUse a private API key to fetch an associated account's details like contact info, timezone, and currency, as well as validate the key. | action |
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOBGet a bulk profile import job with the given job id. | action |
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOBSGet all bulk profile import jobs. | action |
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_ERRORSGet import errors for the bulk profile import job with the given id. | action |
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_LISTSGet list for the bulk profile import job with the given id. | action |
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_PROFILESGet profiles for the bulk profile import job with the given id. | action |
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_LISTSGet list relationship for the bulk profile import job with the given id. | action |
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_PROFILESGet profile relationships for the bulk profile import job with the given id. | action |
KLAVIYO_GET_CAMPAIGN_CAMPAIGN_MESSAGESReturn all messages that belong to the given campaign. | action |
KLAVIYO_GET_CAMPAIGN_MESSAGEReturns a specific message based on a required id. | action |
KLAVIYO_GET_CAMPAIGN_MESSAGE_CAMPAIGNReturn the related campaign<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read`. | action |
KLAVIYO_GET_CAMPAIGN_MESSAGE_RELATIONSHIPS_CAMPAIGNReturns the id of the related campaign<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read`. | action |
KLAVIYO_GET_CAMPAIGN_MESSAGE_RELATIONSHIPS_TEMPLATEReturns the id of the related template<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read` `templates:read`. | action |
KLAVIYO_GET_CAMPAIGN_MESSAGE_TEMPLATEReturn the related template<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read` `templates:read`. | action |
KLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATIONGet estimated recipients for a given campaign id using `create campaign recipient estimation job`. | action |
KLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATION_JOBRetrieve the status of a recipient estimation job triggered with the `create campaign recipient estimation job` endpoint. | action |
KLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_CAMPAIGN_MESSAGESReturns the ids of all messages associated with the given campaign. | action |
KLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_TAGSReturns the ids of all tags associated with the given campaign. | action |
KLAVIYO_GET_CAMPAIGN_SEND_JOBGet a campaign send job<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read`. | action |
KLAVIYO_GET_CAMPAIGN_TAGSReturn all tags that belong to the given campaign. | action |
KLAVIYO_GET_CATALOG_CATEGORIESRetrieve up to 100 account catalog categories, sortable by creation date. | action |
KLAVIYO_GET_CATALOG_CATEGORYGet a catalog category with the given category id. | action |
KLAVIYO_GET_CATALOG_CATEGORY_ITEMSRetrieve up to 100 sorted items per request from a category using the category id. | action |
KLAVIYO_GET_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSGet all items in the given category id. | action |
KLAVIYO_GET_CATALOG_ITEMGet a specific catalog item with the given item id. | action |
KLAVIYO_GET_CATALOG_ITEMSRetrieve up to 100 sorted catalog items per account, with `$custom` integration and `$default` type. | action |
KLAVIYO_GET_CATALOG_ITEM_CATEGORIESRetrieve the catalog categories for an item by id, sorted by 'created' date, with a 100-category maximum per request. | action |
KLAVIYO_GET_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESGet all catalog categories that a particular item is in. | action |
KLAVIYO_GET_CATALOG_ITEM_VARIANTSRetrieve up to 100 variants per request for a specific item id, sortable by creation date. | action |
KLAVIYO_GET_CATALOG_VARIANTGet a catalog item variant with the given variant id. | action |
KLAVIYO_GET_CATALOG_VARIANTSRetrieve up to 100 account variants per request, sortable by creation date. | action |
KLAVIYO_GET_COUPONGet a specific coupon with the given coupon id. | action |
KLAVIYO_GET_COUPONSGet all coupons in an account. | action |
KLAVIYO_GET_COUPON_CODEReturns a coupon code specified by the given identifier. | action |
KLAVIYO_GET_COUPON_CODESObtains coupon codes using necessary coupon or profile filters. | action |
KLAVIYO_GET_COUPON_CODES_FOR_COUPONGets a list of coupon codes associated with the given coupon id<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `coupon-codes:read`. | action |
KLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOBGet a coupon code bulk create job with the given job id. | action |
KLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOBSGet all coupon code bulk create jobs. | action |
KLAVIYO_GET_COUPON_CODE_RELATIONSHIPS_COUPONGets a list of coupon code relationships associated with the given coupon id<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `coupon-codes:read`. | action |
KLAVIYO_GET_COUPON_FOR_COUPON_CODEGet the coupon associated with a given coupon code id. | action |
KLAVIYO_GET_COUPON_RELATIONSHIPS_COUPON_CODESGets the coupon relationship associated with the given coupon code id<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `coupons:read`. | action |
KLAVIYO_GET_CREATE_CATEGORIES_JOBGet a catalog category bulk create job with the given job id. | action |
KLAVIYO_GET_CREATE_CATEGORIES_JOBSGet all catalog category bulk create jobs. | action |
KLAVIYO_GET_CREATE_ITEMS_JOBGet a catalog item bulk create job with the given job id. | action |
KLAVIYO_GET_CREATE_ITEMS_JOBSGet all catalog item bulk create jobs. | action |
KLAVIYO_GET_CREATE_VARIANTS_JOBGet a catalog variant bulk create job with the given job id. | action |
KLAVIYO_GET_CREATE_VARIANTS_JOBSGet all catalog variant bulk create jobs. | action |
KLAVIYO_GET_DELETE_CATEGORIES_JOBGet a catalog category bulk delete job with the given job id. | action |
KLAVIYO_GET_DELETE_CATEGORIES_JOBSGet all catalog category bulk delete jobs. | action |
KLAVIYO_GET_DELETE_ITEMS_JOBGet a catalog item bulk delete job with the given job id. | action |
KLAVIYO_GET_DELETE_ITEMS_JOBSGet all catalog item bulk delete jobs. | action |
KLAVIYO_GET_DELETE_VARIANTS_JOBGet a catalog variant bulk delete job with the given job id. | action |
KLAVIYO_GET_DELETE_VARIANTS_JOBSGet all catalog variant bulk delete jobs. | action |
KLAVIYO_GET_EVENTGet an event with the given event id. | action |
KLAVIYO_GET_EVENT_METRICGet the metric for an event with the given event id. | action |
KLAVIYO_GET_EVENT_PROFILEGet the profile associated with an event with the given event id. | action |
KLAVIYO_GET_EVENT_RELATIONSHIPS_METRICGet a list of related metrics for an event<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `events:read` `metrics:read`. | action |
KLAVIYO_GET_EVENT_RELATIONSHIPS_PROFILEGet profile [relationships](https://developers. | action |
KLAVIYO_GET_FLOWGet a flow with the given flow id. | action |
KLAVIYO_GET_FLOWSGet all flows in an account. | action |
KLAVIYO_GET_FLOW_ACTIONGet a flow action from a flow with the given flow action id. | action |
KLAVIYO_GET_FLOW_ACTION_FOR_MESSAGEGet the flow action for a flow message with the given message id. | action |
KLAVIYO_GET_FLOW_ACTION_MESSAGESRetrieve up to 50 flow messages per request by action id, sortable by various fields, with ascending/descending options, and paginated using `page[size]` and `page[number]`. | action |
KLAVIYO_GET_FLOW_ACTION_RELATIONSHIPS_FLOWGet the flow associated with the given action id. | action |
KLAVIYO_GET_FLOW_ACTION_RELATIONSHIPS_MESSAGESRetrieves up to 50 flow message relationships per request for a specified flow action id, with cursor pagination. | action |
KLAVIYO_GET_FLOW_FLOW_ACTIONSGet all flow actions associated with the given flow id. | action |
KLAVIYO_GET_FLOW_FOR_FLOW_ACTIONGet the flow associated with the given action id. | action |
KLAVIYO_GET_FLOW_MESSAGEGet the flow message of a flow with the given message id. | action |
KLAVIYO_GET_FLOW_MESSAGE_RELATIONSHIPS_ACTIONGet the [relationship](https://developers. | action |
KLAVIYO_GET_FLOW_MESSAGE_RELATIONSHIPS_TEMPLATEReturns the id of the related template<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `templates:read`. | action |
KLAVIYO_GET_FLOW_MESSAGE_TEMPLATEReturn the related template<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `templates:read`. | action |
KLAVIYO_GET_FLOW_RELATIONSHIPS_FLOW_ACTIONSRetrieve all flow action relationships for a specific flow id, sortable by `id`, `status`, `created`, `updated`. | action |
KLAVIYO_GET_FLOW_RELATIONSHIPS_TAGSReturn the tag ids of all tags associated with the given flow. | action |
KLAVIYO_GET_FLOW_TAGSReturn all tags associated with the given flow id. | action |
KLAVIYO_GET_FORMGet the form with the given id. | action |
KLAVIYO_GET_FORMSGet all forms in an account. | action |
KLAVIYO_GET_FORM_FOR_FORM_VERSIONGet the form associated with the given form version. | action |
KLAVIYO_GET_FORM_ID_FOR_FORM_VERSIONGet the id of the form associated with the given form version. | action |
KLAVIYO_GET_FORM_VERSIONGet the form version with the given id. | action |
KLAVIYO_GET_IMAGEGet the image with the given image id. | action |
KLAVIYO_GET_IMAGESGet all images in an account. | action |
KLAVIYO_GET_LISTApi allows 75 req/sec and 700 req/min, but with 'profile count' param, it's 1 req/sec and 15 req/min. | action |
KLAVIYO_GET_LIST_PROFILESRetrieve profiles in a list by id, filterable by email/phone/push token/join date, sortable by join date. | action |
KLAVIYO_GET_LIST_RELATIONSHIPS_PROFILESGet profile membership [relationships](https://developers. | action |
KLAVIYO_GET_LIST_RELATIONSHIPS_TAGSReturns the tag ids of all tags associated with the given list. | action |
KLAVIYO_GET_LIST_TAGSReturn all tags associated with the given list id. | action |
KLAVIYO_GET_METRICGet a metric with the given metric id. | action |
KLAVIYO_GET_METRICSGet all metrics in an account. | action |
KLAVIYO_GET_PROFILEGet the profile with the given profile id. | action |
KLAVIYO_GET_PROFILE_LISTSGet list memberships for a profile with the given profile id. | action |
KLAVIYO_GET_PROFILE_RELATIONSHIPS_LISTSGet list memberships for a profile with the given profile id. | action |
KLAVIYO_GET_PROFILE_RELATIONSHIPS_SEGMENTSGet segment membership relationships for a profile with the given profile id. | action |
KLAVIYO_GET_PROFILE_SEGMENTSGet segment memberships for a profile with the given profile id. | action |
KLAVIYO_GET_SEGMENTFetch a segment by id with default rates of 75/s and 700/m, or with `additional-fields` at 1/s and 15/m. | action |
KLAVIYO_GET_SEGMENTSFetch segments from an account with filters like `name`, `created`, and `updated`. | action |
KLAVIYO_GET_SEGMENT_PROFILESRetrieve profiles in a segment by id, filtering by email, phone, token, or join date, and sorting by join date. | action |
KLAVIYO_GET_SEGMENT_RELATIONSHIPS_PROFILESGet all profile membership [relationships](https://developers. | action |
KLAVIYO_GET_SEGMENT_RELATIONSHIPS_TAGSIf `related resource` is `tags`, returns the tag ids of all tags associated with the given segment id. | action |
KLAVIYO_GET_SEGMENT_TAGSReturn all tags associated with the given segment id. | action |
KLAVIYO_GET_TAGRetrieve the tag with the given tag id. | action |
KLAVIYO_GET_TAGSRetrieve up to 50 account tags at once, filterable/sortable by name or id, with cursor pagination. | action |
KLAVIYO_GET_TAG_GROUPRetrieve the tag group with the given tag group id. | action |
KLAVIYO_GET_TAG_GROUPSRetrieve up to 25 tag groups per account, sortable/filterable by specific attributes. | action |
KLAVIYO_GET_TAG_GROUP_RELATIONSHIPS_TAGSReturns the tag ids of all tags inside the given tag group. | action |
KLAVIYO_GET_TAG_GROUP_TAGSReturn the tags for a given tag group id. | action |
KLAVIYO_GET_TAG_RELATIONSHIPS_CAMPAIGNSReturns the ids of all campaigns associated with the given tag. | action |
KLAVIYO_GET_TAG_RELATIONSHIPS_FLOWSReturns the ids of all flows associated with the given tag. | action |
KLAVIYO_GET_TAG_RELATIONSHIPS_LISTSReturns the ids of all lists associated with the given tag. | action |
KLAVIYO_GET_TAG_RELATIONSHIPS_SEGMENTSReturns the ids of all segments associated with the given tag. | action |
KLAVIYO_GET_TAG_RELATIONSHIPS_TAG_GROUPReturns the id of the tag group related to the given tag. | action |
KLAVIYO_GET_TAG_TAG_GROUPReturns the tag group resource for a given tag id. | action |
KLAVIYO_GET_TEMPLATEGet a template with the given template id. | action |
KLAVIYO_GET_TEMPLATESRetrieve account templates with sorting options (`id`, `name`, `created`, `updated`). | action |
KLAVIYO_GET_UPDATE_CATEGORIES_JOBGet a catalog category bulk update job with the given job id. | action |
KLAVIYO_GET_UPDATE_CATEGORIES_JOBSGet all catalog category bulk update jobs. | action |
KLAVIYO_GET_UPDATE_ITEMS_JOBGet a catalog item bulk update job with the given job id. | action |
KLAVIYO_GET_UPDATE_ITEMS_JOBSGet all catalog item bulk update jobs. | action |
KLAVIYO_GET_UPDATE_VARIANTS_JOBGet a catalog variate bulk update job with the given job id. | action |
KLAVIYO_GET_UPDATE_VARIANTS_JOBSGet all catalog variant bulk update jobs. | action |
KLAVIYO_GET_VERSIONS_FOR_FORMGet the form versions for the given form. | action |
KLAVIYO_GET_VERSION_IDS_FOR_FORMGet the ids of the form versions for the given form. | action |
KLAVIYO_GET_WEBHOOKGet the webhook with the given id. | action |
KLAVIYO_GET_WEBHOOKSGet all webhooks in an account. | action |
KLAVIYO_GET_WEBHOOK_TOPICGet the webhook topic with the given id. | action |
KLAVIYO_GET_WEBHOOK_TOPICSGet all webhook topics in a Klaviyo account. | action |
KLAVIYO_MERGE_PROFILESQueue a task to merge one source profile into a destination profile using their ids. | action |
KLAVIYO_QUERY_CAMPAIGN_VALUESReturns the requested campaign analytics values data<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `2/m`<br>daily: `225/d` **scopes:** `campaigns:read`. | action |
KLAVIYO_QUERY_FLOW_SERIESReturns the requested flow analytics series data<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `2/m`<br>daily: `225/d` **scopes:** `flows:read`. | action |
KLAVIYO_QUERY_FLOW_VALUESReturns the requested flow analytics values data<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `2/m`<br>daily: `225/d` **scopes:** `flows:read`. | action |
KLAVIYO_QUERY_METRIC_AGGREGATESThe Klaviyo endpoint fetches metric events, handling json requests for custom data queries, sorting, and filtering; offers grouping and time-based filters; requires adherence to rate limits (3 requests per second, 60 per minute) under 'metrics:read'. | action |
KLAVIYO_REMOVE_PROFILE_FROM_LISTRemove profiles from a Klaviyo list by profile ids or email addresses. | action |
KLAVIYO_REQUEST_PROFILE_DELETIONTo delete a profile, use only one identifier: email, phone number, or id. | action |
KLAVIYO_SPAWN_BULK_PROFILE_IMPORT_JOBInitiate a job to create/update a batch of profiles, up to 10,000 with a max size of 5mb per request. | action |
KLAVIYO_SPAWN_COUPON_CODE_BULK_CREATE_JOBCreate a coupon-code-bulk-create-job to bulk create a list of coupon codes. | action |
KLAVIYO_SPAWN_CREATE_CATEGORIES_JOBCreate bulk job for up to 100 catalog categories with a 5mb size limit and a max of 500 concurrent jobs. | action |
KLAVIYO_SPAWN_CREATE_ITEMS_JOBCreate batches of up to 100 catalog items with a 5mb size limit using the bulk job, which allows 500 concurrent jobs. | action |
KLAVIYO_SPAWN_CREATE_VARIANTS_JOBInitiate a job to bulk create up to 100 catalog variants, with a 5mb payload size limit. | action |
KLAVIYO_SPAWN_DELETE_CATEGORIES_JOBDelete multiple catalog categories in bulk, with a limit of 100 per request and a 5mb payload size. | action |
KLAVIYO_SPAWN_DELETE_ITEMS_JOBDelete batches of catalog items with a bulk job, max 100 items/request, 5mb size limit, and up to 500 concurrent jobs. | action |
KLAVIYO_SPAWN_DELETE_VARIANTS_JOBDelete multiple catalog variants with a bulk job, max 100 per request, 5mb size limit. | action |
KLAVIYO_SPAWN_UPDATE_CATEGORIES_JOBCreate a job to bulk update up to 100 categories, with a 5mb size limit and a maximum of 500 concurrent jobs. | action |
KLAVIYO_SPAWN_UPDATE_ITEMS_JOBYou can bulk update up to 100 catalog items with a 5mb payload limit. | action |
KLAVIYO_SPAWN_UPDATE_VARIANTS_JOBCreate a job to bulk update up to 100 catalog variants with a 5mb payload limit. | action |
KLAVIYO_SUBSCRIBE_PROFILESThe API supports double opt-in for marketing, with 'historical import' bypassing consent. | action |
KLAVIYO_SUPPRESS_PROFILESSuppress profiles by email, segment, or list id to stop email marketing, regardless of consent. | action |
KLAVIYO_UNREGISTER_CLIENT_PUSH_TOKENThis endpoint unsubscribes a push token, for use with Klaviyo's mobile sdks and a public API key. | action |
KLAVIYO_UNSUBSCRIBE_PROFILESOpt-out profiles from email or sms marketing. | action |
KLAVIYO_UNSUPPRESS_PROFILESRemove 'user suppressed' blocks on profiles manually via email, segment, or list id. | action |
KLAVIYO_UPDATE_CAMPAIGN_MESSAGEUpdate a campaign message<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:write`. | action |
KLAVIYO_UPDATE_CAMPAIGN_SEND_JOBPermanently cancel the campaign, setting the status to canceled or revert the campaign, setting the status back to draft<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:write`. | action |
KLAVIYO_UPDATE_CATALOG_CATEGORYUpdate a catalog category with the given category id. | action |
KLAVIYO_UPDATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSUpdate item relationships for the given category id. | action |
KLAVIYO_UPDATE_CATALOG_ITEMUpdate a catalog item with the given item id. | action |
KLAVIYO_UPDATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESUpdate catalog category relationships for the given item id. | action |
KLAVIYO_UPDATE_CATALOG_VARIANTUpdate a catalog item variant with the given variant id. | action |
KLAVIYO_UPDATE_COUPON*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `coupons:write`. | action |
KLAVIYO_UPDATE_COUPON_CODEUpdates a coupon code specified by the given identifier synchronously. | action |
KLAVIYO_UPDATE_FLOW_STATUSUpdate the status of a flow with the given flow id, and all actions in that flow. | action |
KLAVIYO_UPDATE_IMAGEUpdate the image with the given image id. | action |
KLAVIYO_UPDATE_LISTUpdate the name of a list with the given list id. | action |
KLAVIYO_UPDATE_PROFILEUpdate profiles with the provided id. | action |
KLAVIYO_UPDATE_SEGMENTUpdate a segment with the given segment id. | action |
KLAVIYO_UPDATE_TAGUpdate the tag with the given tag id. | action |
KLAVIYO_UPDATE_TAG_GROUPUpdate the tag group with the given tag group id. | action |
KLAVIYO_UPDATE_TEMPLATEUpdate a template with the given template id. | action |
KLAVIYO_UPDATE_WEBHOOKUpdate the webhook with the given id. | action |
KLAVIYO_UPLOAD_IMAGE_FROM_FILEUpload an image from a file. | action |
KLAVIYO_UPLOAD_IMAGE_FROM_URLImport an image from a url or data uri. | action |