Klaviyo is a data-driven email and SMS marketing platform that allows e-commerce brands to deliver targeted messages, track conversions, and scale customer relationships
Klaviyo is a data-driven email and SMS marketing platform that allows e-commerce brands to deliver targeted messages, track conversions, and scale customer relationships On Nagent, Klaviyo is exposed as a fully-configurable marketing automation integration that any agent can call — 225 actions, and API_KEY, OAUTH2 authentication. No code is required to wire Klaviyo into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Klaviyo to automate the kinds of tasks marketing automation teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Klaviyo into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Klaviyo, with input parameters and output schema. Drop these into any step of an agent built in Helix.
KLAVIYO_ADD_PROFILE_TO_LISTAdd profiles to a Klaviyo list by profile IDs or email addresses. This action subscribes profiles to a marketing list, which is ideal for giving marketing consent. You can add up to 1000 profiles per call using either their Klaviyo profile IDs or email addresses. Rate limits: 10/s burst, 150/m steady. Required scopes: `lists:write` and `profiles:write`. Preconditions: - Either profile_ids or emails must be provided (not both) - Maximum 1000 profiles per call - Email addresses must be valid format - The list must exist and be accessible
Input parameters
List of email addresses to add to the list (alternative to profile_ids)
The ID of the list to add profiles to
List of profile IDs to add to the list (max 1000 per call)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_ASSIGN_CAMPAIGN_MESSAGE_TEMPLATECreates a non-reusable version of the template and assigns it to the message.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
Input parameters
The unique identifier of the campaign message to assign the template to. Obtained from campaign creation or get campaign messages endpoints.
Resource type for the campaign message. Must be 'campaign-message'.
The unique identifier of the template to assign to the campaign message. A non-reusable clone of this template will be created and linked to the message.
Resource type for the template. Must be 'template'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_BULK_CREATE_CLIENT_EVENTSUse the client-side endpoint with a public API key to track profile activity. It accepts up to 1000 events/request with rates of 10/s burst and 150/m steady. For server-side, use the bulk create event endpoint.
Input parameters
Your Public API Key / Site ID. See \[this article\](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
Type
Data
Primary key that uniquely identifies this profile. Generated by Klaviyo.
Type
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
Individual"s email address
URL pointing to the location of a profile image
Individual"s job title
First line of street address
Second line of street address
Latitude coordinate. We recommend providing a precision of four decimal places.
Time zone name. We recommend using time zones from the IANA Time Zone Database.
Remove a key or keys (and their values) completely from properties
Longitude coordinate. We recommend providing a precision of four decimal places.
Individual"s last name
Individual"s first name
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
IP Address
Name of the company or organization within the company for whom the individual works
Anonymous Id
Zip code
Individual"s phone number in E.164 format
City name
Region within a country, such as state or province
Country name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_BULK_CREATE_EVENTSBulk create events for multiple profiles in a single request. Accepts up to 1,000 events with a 5MB max payload. Each event requires a profile identifier (email, phone_number, or external_id) and a metric name. Events are processed asynchronously; a 202 response indicates acceptance, not completion. Rate limits: 10/s burst, 150/min steady.
Input parameters
Resource type identifier. Must be 'event-bulk-create-job'.
Array of event-bulk-create objects (max 1000). Each object contains: 1) 'type': must be 'event-bulk-create', 2) 'attributes': contains 'profile' (with data.type='profile' and data.attributes containing at least one identifier like email/phone_number/external_id) and 'events' (with data array of event objects, each having type='event' and attributes with 'metric' containing data.type='metric' and data.attributes.name, plus 'properties' object). Example: \[{"type":"event-bulk-create","attributes":{"profile":{"data":{"type":"profile","attributes":{"email":"user@example.com"}}},"events":{"data":\[{"type":"event","attributes":{"metric":{"data":{"type":"metric","attributes":{"name":"Viewed Product"}}},"properties":{"product_id":"123"}}}\]}}}\]
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CANCEL_CAMPAIGN_SENDCancel or revert a campaign send job. Use 'cancel' to permanently stop a campaign (status becomes CANCELED), or 'revert' to return it to DRAFT for editing. This action modifies a campaign send job that is currently queued or sending. The cancel action is irreversible and sets the status to CANCELED. The revert action returns the campaign to DRAFT status, allowing further modifications. Rate limits: 10/s burst, 150/m steady. Required scope: `campaigns:write`. Preconditions: - Valid API key with campaigns:write scope - Campaign send job ID must exist and be accessible - Campaign must be in a state that allows cancellation (queued or sending)
Input parameters
The action to perform. 'cancel' permanently cancels the campaign (status becomes CANCELED, irreversible). 'revert' returns the campaign to DRAFT status for further editing.
The unique identifier of the campaign send job to cancel or revert. This is the ID returned when creating a campaign send job.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_BACK_IN_STOCK_SUBSCRIPTIONUse the server-side endpoint to subscribe to restock alerts, following the Back in Stock API guide. For client-side, use the POST endpoint provided. Rate limits: 350/s burst and 3500/m steady. Required scopes: catalogs:write, profiles:write.
Input parameters
Type
The channel(s) through which the profile would like to receive the back in stock notification. This can be leveraged within a back in stock flow to notify the subscriber through their preferred channel(s).
Primary key that uniquely identifies this profile. Generated by Klaviyo.
Type
The catalog variant ID for which the profile is subscribing to back in stock notifications. This ID is made up of the integration type, catalog ID, and and the external ID of the variant like so: `integrationType:::catalogId:::externalId`. If the integration you are using is not set up for multi-catalog storage, the "catalogId" will be `$default`. For Shopify `$shopify:::$default:::33001893429341`
Type
Individual"s email address
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
Anonymous Id
Individual"s phone number in E.164 format
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_CAMPAIGNCreates a campaign given a set of parameters, then returns it.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
Input parameters
Type
The campaign name
Options to use when sending a campaign
The tracking options associated with the campaign
An optional list of excluded audiences
A list of included audiences
Describes the shape of the options object. Allowed values: \["static", "throttled", "immediate", "smart_send_time"\]
Data
The day to send on
The time to send at
The time to send at
If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time. Defaults to False.
Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends. Defaults to False.
The percentage of recipients per hour to send to. Allowed values: \[10, 11, 13, 14, 17, 20, 25, 33, 50\]
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_CAMPAIGN_CLONEClones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
Input parameters
The campaign ID to be cloned
Type
The name for the new cloned campaign
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_CAMPAIGN_RECIPIENT_ESTIMATION_JOBStart an asynchronous task to estimate the number of recipients for a campaign. This action creates a background job that calculates how many profiles would receive the campaign based on its current audience settings. Use the job ID returned to track progress with the 'Get Campaign Recipient Estimation Job' action, and get the final count via 'Get Campaign Recipient Estimation' action. Rate limits: 10/s burst, 150/m steady. Required scope: `campaigns:write`. Preconditions: - Valid API key with campaigns:write scope - Campaign ID must exist and be accessible - Campaign must have audience settings configured
Input parameters
The ID of the campaign to perform recipient estimation for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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`
Input parameters
The unique identifier (ID) of the campaign to send. The campaign must have a template assigned to its message and a subject line set before it can be sent.
Resource type identifier. Must be 'campaign-send-job'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_CATALOG_CATEGORYCreate a new catalog category.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
Type
The name of the catalog category.
The ID of the catalog category in an external system.
The type of catalog. Currently only "$default" is supported.
Data
The integration type. Currently only "$custom" is supported.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSCreate a new item relationship for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
The ID of the catalog category. Must be URL-encoded for the API request.
List of catalog item resource identifiers to add to the category. Each item should have 'type': 'catalog-item' and 'id': '<catalog-item-id>'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_CATALOG_ITEMCreate a new catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
Type
URL pointing to the location of the catalog item on your website.
This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the \[Update Catalog Variant Endpoint\](https://developers.klaviyo.com/en/reference/update_catalog_variant).
The title of the catalog item.
List of URLs pointing to the locations of images of the catalog item.
Boolean value indicating whether the catalog item is published.
A description of the catalog item.
The ID of the catalog item in an external system.
The type of catalog. Currently only "$default" is supported.
URL pointing to the location of a full image of the catalog item.
The integration type. Currently only "$custom" is supported.
Data
URL pointing to the location of an image thumbnail of the catalog item
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESCreate a new catalog category relationship for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
The ID of the catalog item (e.g., '$custom:::$default:::my-item-id'). Will be automatically URL-encoded for the API request.
List of catalog category resource identifiers to add to the item. Each entry should have 'type': 'catalog-category' and 'id': '<category-id>' (e.g., '$custom:::$default:::my-category').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_CATALOG_VARIANTCreate a new variant for a related catalog item.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
Type
The SKU of the catalog item variant.
URL pointing to the location of the catalog item variant on your website.
This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the \[Update Catalog Item Endpoint\](https://developers.klaviyo.com/en/reference/update_catalog_item).
The title of the catalog item variant.
List of URLs pointing to the locations of images of the catalog item variant.
Boolean value indicating whether the catalog item variant is published.
A description of the catalog item variant.
The ID of the catalog item variant in an external system.
The type of catalog. Currently only "$default" is supported.
URL pointing to the location of a full image of the catalog item variant.
The integration type. Currently only "$custom" is supported.
This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.
The original catalog item ID for which this is a variant.
The quantity of the catalog item variant currently in stock.
Type
URL pointing to the location of an image thumbnail of the catalog item variant.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_CLIENT_BACK_IN_STOCK_SUBSCRIPTIONUse the endpoint for client-side back in stock notifications with a public API key. For server-side, use POST /api/back-in-stock-subscriptions. Limits are 350 requests per second and 3500 per minute. Requires 'catalogs:write' and 'profiles:write' scopes.
Input parameters
Your Public API Key / Site ID. See \[this article\](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
Type
The channel(s) through which the profile would like to receive the back in stock notification. This can be leveraged within a back in stock flow to notify the subscriber through their preferred channel(s).
Primary key that uniquely identifies this profile. Generated by Klaviyo.
Type
The catalog variant ID for which the profile is subscribing to back in stock notifications. This ID is made up of the integration type, catalog ID, and and the external ID of the variant like so: `integrationType:::catalogId:::externalId`. If the integration you are using is not set up for multi-catalog storage, the "catalogId" will be `$default`. For Shopify `$shopify:::$default:::33001893429341`
Type
Individual"s email address
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
Anonymous Id
Individual"s phone number in E.164 format
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_CLIENT_EVENT2Create a client-side event in Klaviyo to track user interactions. This action uses the company_id in the request body instead of as a query parameter. Use when tracking events from publicly-browseable, client-side environments with a public API key.
Input parameters
IP address
City name
URL to profile image
Profile's job title
Region/state
Country name
First line of street address
Second line of street address
Latitude coordinate
Timezone
Zip code
Profile's last name
Longitude coordinate
Unique identifier for the event to prevent duplicates
Your Public API Key / Site ID for client-side tracking. This appears in both the event attributes and profile attributes.
When the event occurred. Defaults to current time if not provided.
Profile's first name
Custom properties for the event
Monetary value associated with the event (e.g., purchase amount)
Name of the event metric. Must be less than 128 characters.
Profile's organization
Email address of the profile to associate with the event
Currency code for the event value (ISO 4217)
Custom properties to update on the profile
External ID of the profile
Anonymous ID of the profile
Phone number of the profile in E.164 format
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_CLIENT_SUBSCRIPTIONEndpoint manages email/SMS opt-ins using consent and requires public API key for client use. Allows single-channel with details. Rate limit: 100/s burst, 700/m steady, under 'subscriptions:write'.
Input parameters
Your Public API Key / Site ID. See \[this article\](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
Type
A custom method detail or source to store on the consent records for this subscription.
Primary key that uniquely identifies this profile. Generated by Klaviyo.
The list ID to add the newly subscribed profile to.
Type
Type
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
Individual"s email address
URL pointing to the location of a profile image
Individual"s job title
First line of street address
Second line of street address
Latitude coordinate. We recommend providing a precision of four decimal places.
Time zone name. We recommend using time zones from the IANA Time Zone Database.
Remove a key or keys (and their values) completely from properties
Longitude coordinate. We recommend providing a precision of four decimal places.
Individual"s last name
Individual"s first name
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
IP Address
Name of the company or organization within the company for whom the individual works
Id that can be used to identify a profile when other identifiers are not available
Zip code
Individual"s phone number in E.164 format
City name
Region within a country, such as state or province
Country name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_COUPONCreates a new coupon.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `coupons:write`
Input parameters
Type
A description of the coupon.
This is the id that is stored in an integration such as Shopify or Magento.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_COUPON_CODESynchronously creates a coupon code for the given coupon.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:write`
Input parameters
Type
The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.
This is a unique string that will be or is assigned to each customer/profile and is associated with a coupon.
Id
Type
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_EVENTCreate or update a profile event with minimum identifiers and metric name. Success means validation, not completion. Burst limit: 350/s, Steady: 3500/m. Scope required: `events:write`.
Input parameters
Type
When this event occurred. By default, the time the request was received will be used. The time is truncated to the second. The time must be after the year 2000 and can only be up to 1 year in the future.
A numeric, monetary value to associate with this event. For example, the dollar amount of a purchase.
Custom properties of the event. Use this to store additional data about the event. Non-object properties can be used for creating segments. Use the '$extra' key for non-segmentable values like HTML templates. Defaults to an empty object if not provided.
A unique identifier for an event. If the unique_id is repeated for the same profile and metric, only the first processed event will be recorded. If this is not present, this will use the time to the second. Using the default, this limits only one event per profile per second.
The ISO 4217 currency code of the value associated with the event.
Primary key that uniquely identifies this profile. Generated by Klaviyo.
Type
Type
Name of the event. Must be less than 128 characters.
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
Individual"s email address
URL pointing to the location of a profile image
Individual"s job title
This is for advanced usage. For api requests, this should use the default, which is set to api.
First line of street address
Second line of street address
Latitude coordinate. We recommend providing a precision of four decimal places.
Time zone name. We recommend using time zones from the IANA Time Zone Database.
Longitude coordinate. We recommend providing a precision of four decimal places.
Individual"s last name
Individual"s first name
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
IP Address
Name of the company or organization within the company for whom the individual works
Anonymous Id
Zip code
Individual"s phone number in E.164 format
City name
Remove a key or keys (and their values) completely from properties
Region within a country, such as state or province
Country name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_LISTCreate a new list.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m`<br>Daily: `100/d` **Scopes:** `lists:write`
Input parameters
Type
A helpful name to label the list
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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. Burst rate is 350 requests/sec and 3500 requests/min with 'profiles:write' access.
Input parameters
Primary key that uniquely identifies this profile. Generated by Klaviyo.
Your Public API Key / Site ID. See \[this article\](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
Type
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
Individual"s email address
URL pointing to the location of a profile image
Individual"s job title
Individual"s last name
Individual"s first name
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
IP Address
Name of the company or organization within the company for whom the individual works
Anonymous Id
Zip code
Individual"s phone number in E.164 format
City name
Region within a country, such as state or province
Country name
First line of street address
Second line of street address
Latitude coordinate. We recommend providing a precision of four decimal places.
Time zone name. We recommend using time zones from the IANA Time Zone Database.
Remove a key or keys (and their values) completely from properties
Longitude coordinate. We recommend providing a precision of four decimal places.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_OR_UPDATE_CLIENT_PUSH_TOKENThis endpoint for mobile SDKs (iOS & Android) creates/updates push tokens using a public API key. Push notifications must be enabled. For migrating tokens use the server-side POST endpoint. Rate limits are 3/s burst, 150/m steady.
Input parameters
Your Public API Key / Site ID. See \[this article\](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
Type
A push token from APNS or FCM.
The vendor of the push token.
Remove a key or keys (and their values) completely from properties
The platform on which the push token was created.
The background state of the push token.
Primary key that uniquely identifies this profile. Generated by Klaviyo.
This is the enablement status for the individual push token.
Type
The ID of the app that created the push token
The name of the operating system on the device.
The name of the app that created the push token
The build of the app that created the push token
Relatively stable ID for the device. Will update on app uninstall and reinstall
The environment in which the push token was created
The version of the operating system on the device
The version of the app that created the push token
The name of the SDK used to create the push token.
The manufacturer of the device
The version of the SDK used to create the push token
The model of the device
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
Individual"s email address
URL pointing to the location of a profile image
Individual"s job title
First line of street address
Second line of street address
Latitude coordinate. We recommend providing a precision of four decimal places.
Time zone name. We recommend using time zones from the IANA Time Zone Database.
Longitude coordinate. We recommend providing a precision of four decimal places.
Individual"s last name
Individual"s first name
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
IP Address
Name of the company or organization within the company for whom the individual works
Id that can be used to identify a profile when other identifiers are not available
Zip code
Individual"s phone number in E.164 format
City name
Region within a country, such as state or province
Country name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_OR_UPDATE_PROFILECreate or update a profile in Klaviyo with the given attributes. This action allows you to create a new profile or update an existing one if it already exists (based on email or other identifiers). Returns 201 for creation, 200 for update. Empty fields are cleared with `null`; omitted fields remain unchanged. Rate limits: 75/s burst, 700/m steady. Required scope: `profiles:write`. Preconditions: - At least one identifier (email, phone_number, external_id, or anonymous_id) must be provided - Email must be in valid format if provided - Phone number must be in E.164 format if provided
Input parameters
City name
Individual's email address
URL pointing to the location of a profile image
Individual's job title
Region within a country, such as state or province
Country name
First line of street address
Second line of street address
Latitude coordinate. We recommend providing a precision of four decimal places.
Time zone name. We recommend using time zones from the IANA Time Zone Database.
Zip code
Individual's last name
Longitude coordinate. We recommend providing a precision of four decimal places.
Individual's first name
Custom properties to associate with the profile
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system
Id that can be used to identify a profile when other identifiers are not available
Name of the company or organization within the company for whom the individual works
Individual's phone number in E.164 format
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_OR_UPDATE_PUSH_TOKENCreate or update a push token for mobile push notifications. This server-side endpoint is used for migrating push tokens from other platforms to Klaviyo. For creating tokens from mobile devices, use Klaviyo's mobile SDKs instead. Prerequisites: Push notifications must be enabled for the Klaviyo account. Required fields: - data__type: Must be 'push-token' - data__attributes__token: The push token from APNS or FCM - data__attributes__platform: 'ios' or 'android' - data__attributes__vendor: 'apns' (iOS) or 'fcm' (Android) - data__attributes__profile__data__type: Must be 'profile' - At least one profile identifier (email, phone_number, external_id, anonymous_id, or profile id) Rate limits: 75/s burst, 700/m steady. Max payload: 100KB. Requires scopes: profiles:write, push-tokens:write
Input parameters
Resource type. Must be 'push-token'.
A push token from APNS or FCM.
The push notification vendor. Use 'apns' for iOS (Apple Push Notification Service) or 'fcm' for Android (Firebase Cloud Messaging).
Remove a key or keys (and their values) completely from properties
The mobile platform. Use 'ios' for Apple devices or 'android' for Android devices.
The background state of the push token.
Primary key that uniquely identifies this profile. Generated by Klaviyo.
This is the enablement status for the individual push token.
Profile resource type. Must be 'profile'.
The ID of the app that created the push token
The name of the operating system on the device.
The name of the app that created the push token
The build of the app that created the push token
Relatively stable ID for the device. Will update on app uninstall and reinstall
The environment in which the push token was created
The version of the operating system on the device
The version of the app that created the push token
The name of the SDK used to create the push token.
The manufacturer of the device
The version of the SDK used to create the push token
The model of the device
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
Individual"s email address
URL pointing to the location of a profile image
Individual"s job title
First line of street address
Second line of street address
Latitude coordinate. We recommend providing a precision of four decimal places.
Time zone name. We recommend using time zones from the IANA Time Zone Database.
Longitude coordinate. We recommend providing a precision of four decimal places.
Individual"s last name
Individual"s first name
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
IP Address
Name of the company or organization within the company for whom the individual works
Id that can be used to identify a profile when other identifiers are not available
Zip code
Individual"s phone number in E.164 format
City name
Region within a country, such as state or province
Country name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_PROFILECreate a new profile.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:write`
Input parameters
Type
Individual"s email address
URL pointing to the location of a profile image
Individual"s job title
Individual"s last name
Individual"s first name
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
IP Address
Name of the company or organization within the company for whom the individual works
Zip code
Individual"s phone number in E.164 format
City name
Region within a country, such as state or province
Country name
First line of street address
Second line of street address
Latitude coordinate. We recommend providing a precision of four decimal places.
Time zone name. We recommend using time zones from the IANA Time Zone Database.
Longitude coordinate. We recommend providing a precision of four decimal places.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_SEGMENTCreate a segment.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write`
Input parameters
Type
Name
Is Starred
Condition Groups
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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. Rate limits are 3/s burst and 60/min steady. Tag: #TagCreationLimitAndRate
Input parameters
Type
The Tag name
The ID of the Tag Group to associate the Tag with. If this field is not specified, the Tag will be associated with the company"s Default Tag Group.
Type
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_TAG_GROUPCreate tag groups up to 50 per account, defaulting to non-exclusive unless specified. Related resources can have multiple non-exclusive tags but only one if exclusive. Rate limits: 3/s burst, 60/m steady. Scopes needed: tags:read, tags:write.
Input parameters
Type
The Tag Group name
Exclusive
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_TAG_RELATIONSHIPSAssociate a tag with other resources (flows, lists, segments, or campaigns) in Klaviyo. Use when you need to link a tag to one or more resources for organizational purposes. Note: A resource can have up to 100 tags associated with it. Rate limits: 3/s burst, 60/m steady. Required scopes vary by resource type: tags:write plus the appropriate write scope (flows:write, lists:write, segments:write, or campaigns:write).
Input parameters
List of resource identifiers to associate with the tag. Each item must have 'type' and 'id' fields.
The unique identifier (UUID) of the tag to associate with resources
The type of resource to associate the tag with (flows, lists, segments, or campaigns)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_TEMPLATESummary: Custom HTML templates can be created unless an account reaches 1,000 template limit. Use sparse fieldsets to request specific fields. Rate limits are 10 per second and 150 per minute. Requires 'templates:write' scope.
Input parameters
Type
The HTML contents of the template
The name of the template
The plaintext version of the template
Restricted to CODE
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_TEMPLATE_CLONEClone a template by its ID, but cloning fails if account has 1,000+ templates. API limit: 1,000 templates. Rate limits are 10 per second and 150 per minute. Requires `templates:write` scope.
Input parameters
The ID of template to be cloned
Type
The name of the template
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_TEMPLATE_RENDERRender an email template with specific context and sparse fieldsets, then get HTML/plain text. Rate limit: 3/s burst, 60/m steady. Scope: templates:read.
Input parameters
The ID of template
Type
The context (key-value pairs) to render the template with. Keys should match template variable names.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_CREATE_WEBHOOKCreate a new Webhook to receive real-time notifications when specific events occur in Klaviyo (e.g., email clicks, SMS sent). Rate limits: Burst: 1/s, Steady: 15/m Required scopes: webhooks:write, events:read (for event-based topics) Note: Each Klaviyo account can have a maximum of 10 webhooks.
Input parameters
The resource type for the webhook. Must be 'webhook'.
A name for the webhook.
A description for the webhook.
A secret key used for HMAC-SHA256 signing of webhook requests. Use this to verify webhook authenticity on your server.
The HTTPS URL where webhook payloads will be sent. Must use HTTPS protocol (e.g., 'https://example.com/webhook').
List of webhook topics to subscribe to. Each item must have 'type': 'webhook-topic' and 'id' with the topic identifier (e.g., 'event:klaviyo.clicked_email', 'event:klaviyo.sent_sms'). Use KLAVIYO_GET_WEBHOOK_TOPICS to get available topics.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_CAMPAIGNDelete a campaign with the given campaign ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
Input parameters
The campaign ID to be deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_CATALOG_CATEGORYDelete a catalog category using the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
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`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSDelete item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
The ID of the catalog category from which to remove item relationships. Format: '$custom:::$default:::{external_id}' (e.g., '$custom:::$default:::my-category-123'). Must be URL-encoded for the API request.
List of catalog item resource identifiers to remove from the category. Each item must have 'type': 'catalog-item' and 'id': '<catalog-item-id>' (e.g., \[{'type': 'catalog-item', 'id': '$custom:::$default:::item-123'}\]).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_CATALOG_ITEMDelete a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
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`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESDelete catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
Data
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_CATALOG_VARIANTDelete a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
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`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_COUPONDelete the coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `coupons:write`
Input parameters
The internal id of a Coupon is equivalent to its external id stored within an integration.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_COUPON_CODEDeletes a coupon code specified by the given identifier synchronously. If a profile has been assigned to the coupon code, an exception will be raised<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:write`
Input parameters
The unique identifier of the coupon code to delete. Format: '{COUPON_ID}-{UNIQUE_CODE}' where COUPON_ID is the external_id of the parent coupon and UNIQUE_CODE is the specific code string. Example: 'SUMMER_SALE_2026-SAVE20OFF'. Note: Coupon codes assigned to a profile cannot be deleted and will raise an exception.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_FLOWDelete a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:write`
Input parameters
ID of the Flow to delete. Ex: XVTP5Q
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_LISTDelete a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write`
Input parameters
Primary key that uniquely identifies this list. Generated by Klaviyo.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_SEGMENTDelete a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:write`
Input parameters
The unique identifier of the segment to delete. Segment IDs are alphanumeric strings (e.g., 'TJx2Yb').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_TAGDelete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
Input parameters
The Tag ID
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_TAG_GROUPDelete a specified tag group and its contents; associated resource links will be removed. The default group is undeletable. Rate limits: 3/s burst, 60/m steady. Requires tags:read and tags:write permissions.
Input parameters
The Tag Group ID
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_TAG_RELATIONSHIPSRemove a tag's association with other resources like flows, campaigns, lists, or segments. Use when you need to untag resources without deleting the tag itself.
Input parameters
The tag ID from which to remove resource associations
Array of resource objects to disassociate from the tag. Each object must have 'type' (matching related_resource) and 'id' fields
The type of resource to disassociate from the tag. Valid values: flows, campaigns, lists, segments
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_TEMPLATEPermanently delete a template from your Klaviyo account using its unique template ID. This action is destructive and cannot be undone. Rate limits: Burst 10/s, Steady 150/m. Requires 'templates:write' scope.
Input parameters
The unique identifier of the template to delete. Can be obtained from the get_templates or create_template actions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_DELETE_WEBHOOKPermanently delete a webhook subscription from your Klaviyo account. This action removes the webhook configuration, stopping all future event notifications to the webhook's endpoint URL. This operation is irreversible. **Requirements:** - Advanced KDP (Klaviyo Data Platform) must be enabled on your account - API key must have `webhooks:write` scope **Rate limits:** Burst: 1/s, Steady: 15/m **Returns:** HTTP 204 No Content on successful deletion (empty response body).
Input parameters
The unique identifier of the webhook to delete. This is typically a UUID string returned when the webhook was created (e.g., 'abc123-def456-ghi789').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_ACCOUNTRetrieve a single account object by its account ID. You can only request the account by which the private API key was generated.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `accounts:read`
Input parameters
The ID of the account
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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. Rate limit: 1 request/second, 15 requests/minute. Scope required: `accounts:read`.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_BULK_CREATE_COUPON_CODES_JOBTool to get a coupon code bulk create job with the given job ID. Use when you need to check the status of a previously initiated bulk coupon code creation job. Rate limits: 75/s burst, 700/m steady. Required scope: coupon-codes:read.
Input parameters
The unique identifier for the coupon code bulk create job to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_BULK_DELETE_CATALOG_ITEMS_JOBGet a catalog item bulk delete job with the given job ID. Use this to check the status and progress of a bulk delete operation for catalog items. Rate limits: 350/s burst, 3500/m steady. Required scope: `catalogs:read`. Preconditions: - Valid API key with catalogs:read scope - Job ID must exist and be accessible
Input parameters
The unique identifier for the bulk delete job to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOBGet a bulk profile import job with the given job ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
Input parameters
ID of the job to retrieve.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_ERRORSGet import errors for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
Input parameters
The ID of the bulk profile import job to retrieve errors for. Obtain this ID from the spawn_bulk_profile_import_job or get_bulk_profile_import_jobs actions.
Default: 20. Min: 1. Max: 100.
Cursor for pagination. Use the value from the 'next' or 'prev' link in the response to fetch additional pages of errors.
Select specific fields to include in the response (sparse fieldsets). Available fields: 'code', 'title', 'detail', 'source', 'source.pointer', 'original_payload'. If omitted, all fields are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_LISTSGet list for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_PROFILESGet profiles for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
Input parameters
The unique identifier (ID) of the bulk profile import job to retrieve profiles from. This ID is returned when creating a bulk profile import job or can be obtained from the list of import jobs.
Default: 20. Min: 1. Max: 100.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Request additional fields not included by default in the response. Supported values: "subscriptions", "predictive_analytics"
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_LISTSGet list relationship for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read`
Input parameters
The unique identifier of the bulk profile import job. Obtain this from the GET /api/profile-bulk-import-jobs/ endpoint or from the response when creating a bulk import job.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_PROFILESGet profile relationships for the bulk profile import job with the given ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `profiles:read`
Input parameters
Default: 20. Min: 1. Max: 100.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_BULK_PROFILE_IMPORT_JOBSGet all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:read` `profiles:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `any`, `equals`
Default: 20. Min: 1. Max: 100.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_BULK_UPDATE_CATALOG_ITEMS_JOBGet a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.
Input parameters
ID of the job to retrieve.
Related resources to include in the response. Set to \['items'\] to include full catalog item data for items being updated by this job. When specified, the response will contain an 'included' array with catalog item objects.
Sparse fieldset to limit which catalog item attributes are returned when using include=items. Valid values: 'external_id', 'title', 'description', 'price', 'url', 'image_full_url', 'image_thumbnail_url', 'images', 'custom_metadata', 'published', 'created', 'updated'. Only effective when include=items is specified.
Sparse fieldset to limit which job attributes are returned. Valid values: 'status', 'created_at', 'total_count', 'completed_count', 'failed_count', 'completed_at', 'errors', 'expires_at'. If omitted, all job attributes are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_BULK_UPDATE_CATEGORIES_JOBRetrieve a catalog category bulk update job by its ID from Klaviyo. This action fetches the status and details of a bulk update job for catalog categories, including progress metrics (total, completed, failed counts) and optionally the related category resources. Use this to track the progress of bulk category update operations. Rate limits: 350/s burst, 3500/m steady. Required scope: `catalogs:read`. Preconditions: - Valid API key with catalogs:read scope - Job ID must exist and be accessible
Input parameters
The unique identifier for the bulk update categories job
Whether to include related category data in the response
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_BULK_UPDATE_VARIANTS_JOBTool to retrieve a catalog variant bulk update job by its ID. Use when you need to check the status, progress, or results of a bulk update operation on catalog variants.
Input parameters
The unique identifier for the catalog variant bulk update job to retrieve. Obtain this ID from the response of a create bulk update job operation.
Options for including related resources in the response.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CAMPAIGNRetrieve a specific campaign by its ID from Klaviyo. This action fetches detailed information about a single campaign including its name, status, audience settings, send strategy, and optionally related messages and tags. Rate limits: 10/s burst, 150/m steady. Required scope: `campaigns:read`. Preconditions: - Valid API key with campaigns:read scope - Campaign ID must exist and be accessible
Input parameters
The campaign ID to retrieve
Whether to include tags in the response
Whether to include campaign messages in the response
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CAMPAIGN_CAMPAIGN_MESSAGESReturn all messages that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
Input parameters
The unique identifier of the campaign to retrieve messages for. You can obtain campaign IDs using the Get Campaigns action.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CAMPAIGN_MESSAGEReturns a specific message based on a required id.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
Input parameters
The message ID to be retrieved
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Sparse fieldset filter for campaign message attributes. Top-level fields: id, label, channel, content, send_times, render_options, created_at, updated_at. Nested content fields for email: content.subject, content.preview_text, content.from_email, content.from_label, content.reply_to_email, content.cc_email, content.bcc_email. Nested content fields for SMS/push: content.body, content.title. Nested render_options fields (SMS): render_options.shorten_links, render_options.add_org_prefix, render_options.add_info_link, render_options.add_opt_out_language.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CAMPAIGN_MESSAGE_CAMPAIGNReturn the related campaign<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
Input parameters
The unique identifier of the campaign message. Used to retrieve the parent campaign associated with this message.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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`
Input parameters
The unique identifier of the campaign message to retrieve the campaign relationship for. You can obtain campaign message IDs using the Get Campaign Campaign Messages action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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`
Input parameters
The unique identifier of the campaign message to retrieve the template relationship for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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`
Input parameters
The unique identifier of the campaign message. Example: '01KFGQQNRE7Z9FZ0AAQ3TQAKYZ'.
Sparse fieldsets to limit which template fields are returned. Available fields: name, editor_type, html, text, amp, created, updated. If not specified, all fields are returned. Example: \['name', 'html'\] returns only the template name and HTML content.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATIONGet estimated recipients for a given campaign ID using `Create Campaign Recipient Estimation Job`. Rate limits are 10/s burst and 150/m steady. Required scope: `campaigns:read`.
Input parameters
The ID of the campaign for which to get the estimated number of recipients
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATION_JOBRetrieve the status of a recipient estimation job triggered with the `Create Campaign Recipient Estimation Job` endpoint.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
Input parameters
The ID of the campaign to get recipient estimation status
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_CAMPAIGN_MESSAGESReturns the IDs of all messages associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
Input parameters
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_TAGSReturns the IDs of all tags associated with the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
Input parameters
The unique identifier of the campaign to retrieve tag relationships for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CAMPAIGNSRetrieve campaigns from your Klaviyo account. This action allows you to fetch campaigns with optional filtering and sorting. Klaviyo requires specifying a channel (email or sms) to list campaigns. You can add additional filters for status, name, creation date, and other attributes. Results are paginated with a default of 10 campaigns per page. Rate limits: 10/s burst, 150/m steady. Required scope: `campaigns:read`. Preconditions: - Valid API key with campaigns:read scope - Channel must be specified (email or sms) - Additional filter syntax must be valid if provided
Input parameters
Klaviyo API sort options - note the _at suffix is required for time-based fields.
Additional filter for campaigns. Will be combined with the required channel filter. Example: 'equals(status,"draft")' Malformed or overly complex filters trigger 4xx errors; use simple single-condition filters.
Campaign channel to filter by (email or sms). Required by Klaviyo API.
Cursor for pagination to get the next page of results Iterate using `links.next` until it returns null to retrieve all results.
Whether to include archived campaigns in the results
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CAMPAIGN_SEND_JOBGet a campaign send job<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:read`
Input parameters
The ID of the campaign to send
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CAMPAIGN_TAGSReturn all tags that belong to the given campaign.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `campaigns:read` `tags:read`
Input parameters
The unique identifier of the campaign to retrieve tags for (e.g., '01KFT75VHSJJ4X5E1G4ZT0VQCJ').
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CATALOG_CATEGORIESRetrieve up to 100 account catalog categories, sortable by creation date. Only `$custom` integration and `$default` catalog types supported. Rate limits are 350/s and 3500/m. Requires `catalogs:read` scope.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CATALOG_CATEGORYGet a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
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`.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CATALOG_CATEGORY_ITEMSRetrieve up to 100 sorted items per request from a category using the category ID. Sort by 'created' field. Rate limits are 350/s burst and 3500/m steady. Requires 'catalogs:read' scope.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSGet all items in the given category ID. Returns a maximum of 100 items per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CATALOG_ITEMGet a specific catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
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`.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CATALOG_ITEM_CATEGORIESRetrieve the catalog categories for an item by ID, sorted by 'created' date, with a 100-category maximum per request. Rate limits: 350/s burst, 3500/m steady. Requires 'catalogs:read' scope.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`name`: `contains`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESGet all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CATALOG_ITEMSRetrieve up to 100 sorted catalog items per account, with `$custom` integration and `$default` type. Rate limits: 350/s burst, 3500/m steady. Scope required: `catalogs:read`.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`category.id`: `equals`<br>`title`: `contains`<br>`published`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CATALOG_ITEM_VARIANTSRetrieve up to 100 variants per request for a specific item ID, sortable by creation date. Rate limits are 350/s burst and 3500/m steady. Requires 'catalogs:read' scope.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CATALOG_VARIANTGet a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
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`.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CATALOG_VARIANTSRetrieve up to 100 account variants per request, sortable by creation date. Supports only `$custom` integration and `$default` catalog types. Rate limits are 350/s burst and 3500/m steady. Requires `catalogs:read` scope.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`ids`: `any`<br>`item.id`: `equals`<br>`sku`: `equals`<br>`title`: `contains`<br>`published`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_COUPONGet a specific coupon with the given coupon ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
Input parameters
The internal id of a Coupon is equivalent to its external id stored within an integration.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_COUPON_CODEReturns a Coupon Code specified by the given identifier.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:read`
Input parameters
The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOBGet a coupon code bulk create job with the given job ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
Input parameters
ID of the job to retrieve.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOBSGet all coupon code bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupon-codes:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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`
Input parameters
The unique identifier of the coupon to retrieve coupon code relationships for.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_COUPON_CODESObtains coupon codes using necessary coupon or profile filters. Rate limits: 350/s, 3500/m. Requires 'coupon-codes:read' scope.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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`
Input parameters
The unique identifier of the coupon (external_id) for which to retrieve associated coupon codes.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`<br>`coupon.id`: `any`, `equals`<br>`profile.id`: `any`, `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_COUPON_FOR_COUPON_CODEGet the coupon associated with a given coupon code ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
Input parameters
The unique identifier for the coupon code. This is typically in the format '{coupon_id}-{unique_code}' (e.g., 'PROMO_SUMMER_2026-SUMMER2026PROMO').
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_COUPON_ID_FOR_COUPON_CODETool to get the coupon relationship associated with a given coupon code ID. Use when you need to find which coupon is associated with a specific coupon code. Rate limits: Burst: 75/s, Steady: 700/m Required scope: coupons:read
Input parameters
The ID of the coupon code to look up the relationship of.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_COUPON_RELATIONSHIPS_COUPON_CODESRetrieves the coupon code relationships (resource identifiers) for a given coupon. Returns a list of coupon code IDs associated with the specified coupon, along with pagination links for navigating large result sets. Rate limits: Burst: 75/s, Steady: 700/m Required scopes: coupons:read
Input parameters
The unique identifier of the coupon (external_id) to retrieve coupon code relationships for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_COUPONSGet all coupons in an account. To learn more, see our \[Coupons API guide\](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api).<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `coupons:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CREATE_CATEGORIES_JOBGet a catalog category bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
ID of the job to retrieve.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CREATE_CATEGORIES_JOBSGet all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CREATE_ITEMS_JOBGet a catalog item bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
ID of the job to retrieve.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CREATE_ITEMS_JOBSGet all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CREATE_VARIANTS_JOBGet a catalog variant bulk create job with the given job ID. An `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
ID of the job to retrieve.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_CREATE_VARIANTS_JOBSGet all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_DELETE_CATEGORIES_JOBGet a catalog category bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
ID of the job to retrieve.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_DELETE_CATEGORIES_JOBSGet all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_DELETE_ITEMS_JOBSGet all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_DELETE_VARIANTS_JOBGet a catalog variant bulk delete job with the given job ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
ID of the job to retrieve.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_DELETE_VARIANTS_JOBSGet all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_EVENTGet an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `events:read`
Input parameters
ID of the event
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_EVENT_METRICGet the metric for an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `metrics:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_EVENT_PROFILEGet the profile associated with an event with the given event ID.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read` `profiles:read`
Input parameters
The unique identifier of the event to retrieve the associated profile for.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Request additional fields not included by default in the response. Supported values: "subscriptions", "predictive_analytics"
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_EVENT_RELATIONSHIPSGet metrics or profile relationships for a specific event. Use when you need to retrieve the metric or profile associated with an event. Rate limits: 350/s burst, 3500/m steady. Required scopes: Events Read, Metrics Read, Profiles Read.
Input parameters
The unique identifier for the event
The type of relationship to retrieve - either 'metric' or 'profile'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `events:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
Filter events using Klaviyo filter syntax. IMPORTANT: Only the following fields are filterable for events: datetime, metric_id, profile, profile_id, timestamp. Fields like '$attributed_campaign' and other event properties are NOT filterable and will result in a 400 error. Allowed field(s)/operator(s): `metric_id`: `equals` - The metric_id must be a 6-character alphanumeric ID (e.g., 'Vatr8j'), NOT a metric name like 'Opened Email'. Use the Get Metrics endpoint (KLAVIYO_GET_METRICS) to retrieve valid metric IDs for your account. `profile_id`: `equals` - The profile_id must be a valid Klaviyo profile ID. `profile`: `has` - Check if profile exists. `datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - Use ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). `timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` - Unix timestamp. Example: equals(metric_id,"Vatr8j"),greater-than(datetime,2024-01-01T00:00:00Z). For more information: https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
Sparse fieldsets to select specific event fields. Valid values: 'timestamp', 'event_properties', 'datetime', 'uuid', 'id'. Note: 'metric_id' and 'profile_id' are filter parameters (use the 'filter' param), not sparse fieldset values. Use 'event_properties' (not 'properties') for event custom properties. For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOWGet a flow with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
Input parameters
The unique identifier of the flow to retrieve. Flow IDs can be obtained from the Get Flows endpoint.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOW_ACTIONGet a flow action from a flow with the given flow action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOW_ACTION_FOR_MESSAGEGet the flow action for a flow message with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
Input parameters
The unique identifier of the flow message. Flow message IDs can be obtained from the GET flow action messages endpoint.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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\]`. Rate limits: 3/s burst, 60/m steady. Scope required: `flows:read`.
Input parameters
The unique identifier of the flow action to retrieve messages for. Flow action IDs can be obtained from the Get Flow Actions endpoint.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
Default: 50. Min: 1. Max: 100.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOW_ACTION_RELATIONSHIPS_FLOWGet the parent flow associated with a given flow action ID. This endpoint returns the flow relationship data for a specific flow action, allowing you to identify which flow contains the specified action. Use cases: - Determine which flow a specific action belongs to - Navigate from an action to its parent flow Rate limits: Burst: 3/s, Steady: 60/m Required scope: flows:read
Input parameters
The numeric ID of the flow action. Flow action IDs can be obtained from the Get Flow Flow Actions endpoint or from the Get Flows endpoint with flow-actions included.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOW_ACTION_RELATIONSHIPS_MESSAGESRetrieves up to 50 flow message relationships per request for a specified flow action ID, with cursor pagination. Rate limits: 3/s burst, 60/min steady. Requires `flows:read` scope.
Input parameters
The unique identifier of the flow action to retrieve message relationships for.
Sort field and direction for results. Options: 'created', '-created', 'id', '-id', 'name', '-name', 'updated', '-updated'. Prefix with '-' for descending order.
Filter criteria for flow messages. Allowed field(s)/operator(s): `name`: `contains`, `ends-with`, `equals`, `starts-with`; `created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`; `updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`. Example: equals(name,'Welcome Email').
Number of results per page. Default: 50. Min: 1. Max: 50.
Cursor for pagination. Use the value from 'links.next' in a previous response to fetch the next page.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOW_FLOW_ACTIONSGet all flow actions associated with the given flow ID. Returns a maximum of 50 flow actions per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
Input parameters
The unique identifier of the flow to retrieve flow actions for. Flow IDs can be obtained from the Get Flows endpoint.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`<br>`action_type`: `any`, `equals` (valid values: BOOLEAN_BRANCH, SEND_EMAIL, UPDATE_CUSTOMER, <PERSON>, TIME_DELAY, BACK_IN_STOCK_DELAY, COUNTDOWN_DELAY, SEND_SMS, SEND_NOTIFICATION_MESSAGE, WEBHOOK, AB_TEST)<br>`status`: `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
Default: 50. Min: 1. Max: 50.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOW_FOR_FLOW_ACTIONGet the flow associated with the given action ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
Input parameters
The unique identifier of the flow action. Flow action IDs can be obtained from the Get Flow Actions endpoint or from flow-actions relationships on flow objects.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOW_MESSAGEGet the flow message of a flow with the given message ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
Input parameters
The flow message ID. Flow messages are associated with EMAIL or SMS actions within flows. Obtain flow message IDs via the Get Flow Action Messages endpoint using a flow action ID of type SEND_EMAIL or SEND_SMS.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOW_MESSAGE_RELATIONSHIPS_ACTIONGet the flow action relationship for a specific flow message. This returns the parent flow action that contains the specified flow message (e.g., the SEND_EMAIL or SEND_SMS action). Requires a valid flow message ID which can be obtained from GET /api/flow-actions/{id}/flow-messages/. Rate limits: Burst 3/s, Steady 60/m. Required scope: flows:read
Input parameters
The unique identifier of the flow message. Flow message IDs can be obtained from the GET /api/flow-actions/{id}/flow-messages/ endpoint or from the relationships.flow-messages.data array when fetching flow actions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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`
Input parameters
The flow message ID. Flow messages are associated with EMAIL or SMS actions within flows. Get flow message IDs via the Get Flow Action Messages endpoint using a flow action ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOW_MESSAGE_TEMPLATEReturn the related template<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `templates:read`
Input parameters
The flow message ID. Flow messages are associated with EMAIL or SMS actions within flows. Get flow message IDs via the Get Flow Action Messages endpoint using a flow action ID.
Optional list of template fields to include in the response. Available fields: name, editor_type, html, text, amp, created, updated. If not specified, all fields are returned. Use sparse fieldsets to reduce response size.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOW_RELATIONSHIPS_FLOW_ACTIONSRetrieve all flow action relationships for a specific flow ID, sortable by `id`, `status`, `created`, `updated`. Refine with filters, max 50 per page, paginated by `page\[size\]` and `page\[number\]`. Rate limits: Burst 3/s, Steady 60/m. Scope: `flows:read`.
Input parameters
The unique identifier (ID) of the flow to retrieve flow action relationships for. Can be obtained from the Get Flows endpoint.
Sort results by a specified field. Use '-' prefix for descending order. Options: 'created', '-created', 'id', '-id', 'status', '-status', 'updated', '-updated'. See https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting for more details.
Filter string to refine results. Allowed field(s)/operator(s): `action_type`: `equals` - Valid values: BOOLEAN_BRANCH, SEND_EMAIL, UPDATE_CUSTOMER, <PERSON>, TIME_DELAY, BACK_IN_STOCK_DELAY, COUNTDOWN_DELAY, SEND_SMS, SEND_NOTIFICATION_MESSAGE, WEBHOOK, AB_TEST (e.g., 'equals(action_type,"SEND_EMAIL")'); `status`: `equals` (e.g., 'equals(status,"live")'); `created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`; `updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`. See https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering for more details.
Default: 50. Min: 1. Max: 100.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOW_RELATIONSHIPS_TAGSReturn the tag IDs of all tags associated with the given flow.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
Input parameters
The unique identifier of the flow to retrieve tag relationships for. Example: 'RkaANL'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOWSGet all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
Filter syntax uses function format: `operator(field,"value")`. **String values MUST be quoted.** Examples: `equals(status,"live")`, `contains(name,"welcome")`, `any(id,\["ID1","ID2"\])`. Allowed field(s)/operator(s): `id`: `any`; `name`: `contains`, `ends-with`, `equals`, `starts-with`; `status`: `equals`; `archived`: `equals`; `created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`; `updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`; `trigger_type`: `equals`. For more information visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
Number of flows to return per page.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FLOW_TAGSReturn all tags associated with the given flow ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `flows:read` `tags:read`
Input parameters
The unique identifier of the flow to retrieve tags for. Example: 'Yd27AJ'.
Sparse fieldset to limit which tag fields are returned. Currently supports 'name' to only return tag names. If not specified, all available tag fields are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FORMGet the form with the given ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
Input parameters
The unique identifier of the form to retrieve. This is a 6-character alphanumeric ID (e.g., 'RTcXBK'). You can get form IDs from the KLAVIYO_GET_FORMS action.
Related resources to include in the response. Currently supports: 'form-versions' to include detailed form version data.
Sparse fieldset to limit which form attributes are returned. Available fields: 'name', 'status', 'ab_test', 'created_at', 'updated_at'. If not specified, all fields are returned.
Sparse fieldset to limit which form-version attributes are returned. Available fields: 'form_type', 'ab_test', 'ab_test.variation_name', 'status', 'created_at', 'updated_at'. Only used when include contains 'form-versions'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FORM_FOR_FORM_VERSIONGet the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
Input parameters
The unique identifier (ID) of the form version. You can get form version IDs by calling get_version_ids_for_form with a form ID.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FORM_ID_FOR_FORM_VERSIONGet the ID of the form associated with the given form version.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
Input parameters
The unique identifier of the form version to retrieve the associated form ID for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FORMSGet all forms in an account.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `contains`, `equals`<br>`ab_test`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`status`: `equals`
Default: 20. Min: 1. Max: 100.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_FORM_VERSIONRetrieve detailed information about a specific form version by its ID. Form versions represent different variations of a Klaviyo sign-up form. A form may have multiple versions for A/B testing (multiple live variations) or draft/live combinations during editing. Use this endpoint to get the full configuration including form type, status, steps, styling, triggers, and other settings. Rate limits: Burst 3/s, Steady 60/m. Required scope: forms:read
Input parameters
The unique identifier of the form version to retrieve. Obtain this ID from the 'Get Versions for Form' endpoint or from form version relationships.
Sparse fieldset filter to limit which attributes are returned. Available fields: form_type, ab_test, ab_test.variation_name, status, created_at, updated_at. If omitted, all fields are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_IMAGEGet the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read`
Input parameters
The ID of the image
Specify which image attributes to return (sparse fieldsets). Options: name, image_url, format, size, hidden, updated_at. If not specified, all attributes are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_IMAGESGet all images in an account.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`format`: `any`, `equals`<br>`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`<br>`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`hidden`: `any`, `equals`
Default: 20. Min: 1. Max: 100.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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. 'lists:read' scope needed. See developer guide for details.
Input parameters
Primary key that uniquely identifies this list. Generated by Klaviyo.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Request additional fields not included by default in the response. Supported values: "profile_count"
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_LIST_PROFILESRetrieve profiles in a list by ID, filterable by email/phone/push token/join date, sortable by join date. Regular rate limit: 75/s, 700/m; with predictive analytics: 10/s, 150/m. Details at Klaviyo guide. Scopes required: lists:read, profiles:read.
Input parameters
The unique identifier of the Klaviyo list to retrieve profiles from. Example: 'Y6nRLr'
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
Default: 20. Min: 1. Max: 100.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Request additional fields not included by default in the response. Supported values: "subscriptions", "predictive_analytics"
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_LIST_RELATIONSHIPSGet profile membership relationships for a Klaviyo list. Returns references (IDs) to profiles that are members of the specified list. Use when you need to retrieve which profiles belong to a list without fetching full profile data.
Input parameters
The unique identifier of the list
Cursor for pagination to get the next page of results
The type of related resource to retrieve (currently only 'profiles' is supported)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_LIST_RELATIONSHIPS_TAGSReturns the tag IDs of all tags associated with the given list.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
Input parameters
The unique identifier (ID) of the list to retrieve tag relationships for. Example: 'TDFT78'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_LISTSRetrieve marketing lists from your Klaviyo account. This action allows you to fetch lists with optional filtering and sorting. You can filter by name, creation date, and other attributes. Results are paginated with a default of 10 lists per page. Rate limits: 75/s burst, 700/m steady. Required scope: `lists:read`. Preconditions: - Valid API key with lists:read scope - Filter syntax must be valid if provided
Input parameters
Sort lists by field (add '-' prefix for descending order)
Filter lists by name, creation date, etc. Example: 'equals(name,"Newsletter")'
Cursor for pagination to get the next page of results
Whether to include tags associated with the lists
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_LIST_TAGSReturn all tags associated with the given list ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `tags:read`
Input parameters
The unique identifier of the Klaviyo list to retrieve tags for.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_METRICGet a metric with the given metric ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`
Input parameters
Metric ID
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_METRICSGet all metrics in an account. Requests can be filtered by the following fields: integration `name`, integration `category` Returns a maximum of 200 results per page.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `metrics:read`
Input parameters
Filter metrics by integration fields only. IMPORTANT: The metric's own 'name' field is NOT filterable. Only integration fields can be filtered. Allowed fields and operators: `integration.name` with `equals`, `integration.category` with `equals`. Example: equals(integration.name,'Klaviyo') or equals(integration.category,'Internal'). For more information visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_PROFILEGet the profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `profiles:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Request additional fields not included by default in the response. Supported values: "subscriptions", "predictive_analytics"
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_PROFILE_LISTSGet list memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `lists:read` `profiles:read`
Input parameters
The unique identifier of the profile to retrieve list memberships for. This is a Klaviyo profile ID (e.g., '01KFT7HBHVKV3D25581YVCNAJN').
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_PROFILE_RELATIONSHIPSTool to get list membership or segment membership relationships for a profile with the given profile ID. Use when you need to determine which lists or segments a specific profile belongs to.
Input parameters
The unique identifier of the profile (e.g., '01KFT7HBHVKV3D25581YVCNAJN'). Retrieve profile IDs from the Get Profiles endpoint.
The type of relationship to retrieve - either 'lists' for list memberships or 'segments' for segment memberships.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_PROFILESRetrieve profiles from your Klaviyo account. This action allows you to fetch profiles with optional filtering and sorting. You can filter by email, external_id, creation date, and other attributes. Results are paginated with a configurable page size. Rate limits: 75/s burst, 700/m steady (lower with predictive_analytics). Required scope: `profiles:read`. Preconditions: - Valid API key with profiles:read scope - Filter syntax must be valid if provided - Page size must be between 1 and 100
Input parameters
Sort profiles by field (add '-' prefix for descending order)
Filter profiles by email, external_id, created date, etc. Example: 'equals(email,"user@example.com")' Prefer specific filters (email, external_id) over broad queries to reduce response size. Multi-condition filters are more error-prone than single-condition filters.
Number of profiles to return per page (1-100)
Cursor for pagination to get the next page of results
Whether to include subscription information in the response
Whether to include predictive analytics data (note: this may reduce rate limits)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_PROFILE_SEGMENTSGet segment memberships for a profile with the given profile ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `profiles:read` `segments:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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. For details, visit the provided guide. Required scope: `segments:read`.
Input parameters
The unique identifier of the segment to retrieve. This ID is returned when creating segments or listing segments via the API.
Include related resources in the response. Set to \['tags'\] to include tag objects associated with this segment. When included, the full tag objects will appear in an 'included' array in the response.
Specify which tag fields to include in the response when using include=\['tags'\]. Available fields: 'name'. If not specified, all tag fields are returned.
Specify which segment fields to include in the response using sparse fieldsets. Available fields: 'name', 'definition', 'definition.condition_groups', 'created', 'updated', 'is_active', 'is_processing', 'is_starred', 'profile_count'. If not specified, all fields are returned.
Request additional fields not included by default in the response. Supported values: "profile_count"
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_SEGMENT_PROFILESRetrieve profiles in a segment by ID, filtering by email, phone, token, or join date, and sorting by join date. Rate limit: 75/s burst, 700/m steady. Requires profiles:read and segments:read scopes.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`, `equals`<br>`phone_number`: `any`, `equals`<br>`push_token`: `any`, `equals`<br>`_kx`: `equals`<br>`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
Default: 20. Min: 1. Max: 100.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Request additional fields not included by default in the response. Supported values: "subscriptions", "predictive_analytics"
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_SEGMENT_RELATIONSHIPSGet all profile membership or tag relationships for a segment. Use 'profiles' to retrieve profile membership relationships or 'tags' to retrieve tag associations. Rate limits: Burst 75/s, Steady 700/m. Required scopes: profiles:read, segments:read.
Input parameters
The segment identifier (e.g., 'TJx2Yb')
Number of results per page. Must be between 1 and 100
The related resource type. Use 'profiles' for profile membership relationships or 'tags' for tag relationships
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_SEGMENTSFetch segments from an account with filters like `name`, `created`, and `updated`. Max 10 results/page. Rate limits are 75/s burst, 700/m steady. Requires `segments:read` scope.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `any`, `equals`<br>`id`: `any`, `equals`<br>`created`: `greater-than`<br>`updated`: `greater-than`<br>`is_active`: `any`, `equals`<br>`is_starred`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_SEGMENT_TAGSReturn all tags associated with the given segment ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `segments:read` `tags:read`
Input parameters
The unique identifier of the segment to retrieve tags for (e.g., 'TJx2Yb'). Use KLAVIYO_GET_SEGMENTS to list available segment IDs.
Optional sparse fieldsets to limit which tag fields are returned. Use \['name'\] to return only the tag name attribute. If not specified, all tag fields are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_TAGRetrieve the tag with the given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
Input parameters
The unique identifier (UUID) of the tag to retrieve.
Related resources to include in the response. Use 'tag-group' to include the full tag-group object that this tag belongs to in the 'included' array of the response.
Sparse fieldset for the tag resource. Limits which fields are returned in the tag's attributes. Allowed values: 'name'.
Sparse fieldset for the tag-group resource. Limits which fields are returned in the included tag-group object. Allowed values: 'name', 'exclusive', 'default'. Only applicable when include contains 'tag-group'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_TAG_GROUPRetrieve the tag group with the given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
Input parameters
The Tag Group ID
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_TAG_GROUP_RELATIONSHIPS_TAGSReturns the tag IDs of all tags inside the given tag group.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
Input parameters
The unique identifier (UUID) of the tag group to retrieve tag relationships for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_TAG_GROUPSRetrieve up to 25 tag groups per account, sortable/filterable by specific attributes. Default group included. Supports cursor pagination and adheres to rate limits of 3 requests per second and 60 per minute. Requires `tags:read` scope.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`<br>`exclusive`: `equals`<br>`default`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_TAG_GROUP_TAGSReturn the tags for a given tag group ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
Input parameters
The unique identifier (UUID) of the tag group to retrieve tags from.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_TAG_RELATIONSHIPSTool to retrieve relationship IDs for a tag. Returns the IDs of related resources (campaigns, flows, lists, segments, or tag-group) associated with a specific tag. The response format varies based on the related_resource type: - For collections (campaigns, flows, lists, segments): returns an array of resource identifiers - For tag-group: returns a single resource identifier object Rate limits: 3/s burst, 60/m steady. Required scopes: tags:read and scope for the related resource type.
Input parameters
The unique identifier (UUID) of the tag to retrieve relationships for.
The type of related resource to retrieve: campaigns, flows, lists, segments, or tag-group.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_TAGSRetrieve up to 50 account tags at once, filterable/sortable by name or id, with cursor pagination. Rate limits: 3/s burst, 60/m steady. Requires `tags:read` scope.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`name`: `contains`, `ends-with`, `equals`, `starts-with`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_TAG_TAG_GROUPReturns the tag group resource for a given tag ID.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read`
Input parameters
The unique identifier (UUID) of the tag whose tag group should be retrieved.
Optional list of tag group fields to include in the response. Use for sparse fieldsets to limit response size. Available fields: 'name', 'exclusive', 'default'. If not specified, all fields are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_TEMPLATEGet a template with the given template ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `templates:read`
Input parameters
The unique identifier of the template to retrieve (e.g., 'Rz66gr').
Sparse fieldsets to request only specific template attributes. Available fields: name, editor_type, html, text, created, updated. If not provided, all fields are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_TEMPLATESRetrieve account templates with sorting options (`id`, `name`, `created`, `updated`). Limit of 10 results per page, rate limits at 10/s burst and 150/m steady. Requires `templates:read` scope.
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`id`: `any`, `equals`<br>`name`: `any`, `equals`<br>`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_UPDATE_CATEGORIES_JOBSGet all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
Filter jobs by status using equals operator. Format: equals(status,'<value>'). Valid status values: 'cancelled', 'complete', 'processing', 'queued'. Example: equals(status,'complete')
Cursor-based pagination token from a previous response's 'links.next' field to fetch the next page of results.
Sparse fieldsets to select specific fields to return. Available fields: status, created_at, total_count, completed_count, failed_count, completed_at, errors, expires_at. Example: \['status', 'created_at', 'total_count'\]
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_UPDATE_ITEMS_JOBGet a catalog item bulk update job with the given job ID. An `include` parameter can be provided to get the following related resource data: `items`.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
ID of the job to retrieve.
Related resources to include in the response. Set to \['items'\] to include full catalog item data for items being updated by this job. When specified, the response will contain an 'included' array with catalog item objects.
Sparse fieldset to limit which catalog item attributes are returned when using include=items. Valid values: 'external_id', 'title', 'description', 'price', 'url', 'image_full_url', 'image_thumbnail_url', 'images', 'custom_metadata', 'published', 'created', 'updated'. Only effective when include=items is specified.
Sparse fieldset to limit which job attributes are returned. Valid values: 'status', 'created_at', 'total_count', 'completed_count', 'failed_count', 'completed_at', 'errors', 'expires_at'. If omitted, all job attributes are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_UPDATE_ITEMS_JOBSGet all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`status`: `equals`
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_UPDATE_VARIANTS_JOBSGet all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `catalogs:read`
Input parameters
Filter jobs by status using Klaviyo's filter syntax. Supported: equals(status,"<value>") where value can be 'queued', 'processing', 'complete', or 'cancelled'. Example: equals(status,"complete") to get only completed jobs.
Cursor for pagination. Use the cursor value from the 'next' or 'prev' link in the response to fetch additional pages of results. Returns up to 100 jobs per request.
Select specific fields to include in the response. Available fields: 'status', 'created_at', 'total_count', 'completed_count', 'failed_count', 'completed_at', 'errors', 'expires_at'. If not specified, all fields are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_VARIANT_IDS_FOR_CATALOG_ITEMTool to get all variant IDs related to a given catalog item ID. Returns a maximum of 100 variants per request. Use when you need to retrieve variant IDs without fetching full variant data. Supports filtering and sorting by creation date.
Input parameters
The catalog item ID in the format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.
Sort options for variant IDs.
Filter to apply to the results. Allowed fields/operators: ids (any), item.id (equals), sku (equals), title (contains), published (equals). Example: any(ids,\['$custom:::$default:::VARIANT-1'\])
Cursor for pagination to retrieve the next page of results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_VERSION_IDS_FOR_FORMGet the IDs of the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
Input parameters
The unique identifier of the form to retrieve version IDs for. Use the Get Forms endpoint to retrieve available form IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_VERSIONS_FOR_FORMGet the form versions for the given form.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `forms:read`
Input parameters
The unique identifier of the form to retrieve versions for. Form IDs can be obtained from the Get Forms endpoint or from the Klaviyo UI URL (https://www.klaviyo.com/forms/<FORM_ID>).
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
Default: 20. Min: 1. Max: 100.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_WEBHOOKGet the webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read`
Input parameters
The unique identifier of the webhook to retrieve. Obtain this from the list webhooks endpoint or webhook creation response.
Include related resources in the response. Use 'webhook-topics' to include the topics that trigger this webhook.
Select which webhook fields to include in the response. Available fields: 'name', 'description', 'endpoint_url', 'enabled', 'created_at', 'updated_at'. If not specified, all fields are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_WEBHOOKSGet all webhooks in an account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read`
Input parameters
Optional list of related resources to include in the response. Use 'webhook-topics' to include the event topics that trigger each webhook.
Optional list of webhook fields to include in the response. If not specified, all fields are returned. Available fields: 'name', 'description', 'endpoint_url', 'enabled', 'created_at', 'updated_at'. Use this to reduce response size by requesting only needed fields.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_WEBHOOK_TOPICRetrieve details of a specific webhook topic by its ID. Webhook topics define the events that can trigger webhooks (e.g., email_delivered, sent_sms). Use this to get the human-readable name and metadata for a specific topic. Rate limits: Burst 1/s, Steady 15/m. Required scope: webhooks:read
Input parameters
The unique identifier of the webhook topic to retrieve. Format: 'event:klaviyo.{event_name}' (e.g., 'event:klaviyo.email_delivered', 'event:klaviyo.sent_sms', 'event:klaviyo.clicked_email'). Use the Get Webhook Topics endpoint to list all available topic IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_GET_WEBHOOK_TOPICSGet all webhook topics in a Klaviyo account.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:read`
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_MERGE_PROFILESMerge one or more source profiles into a destination profile. The source profile(s) data (events, attributes, list memberships) will be transferred to the destination, and the source profile(s) will be deleted. This operation is queued asynchronously and returns HTTP 202 Accepted. Rate limits: 10/s burst, 150/m steady. Requires `profiles:write` scope.
Input parameters
The ID of the destination profile that will receive the merged data. This profile will be kept after the merge.
The resource type for merge operation. Must be 'profile-merge'.
List of source profile objects to merge into the destination. Each object must have 'type' (always 'profile') and 'id' (the source profile ID). Source profiles will be deleted after the merge. Example: \[{'type': 'profile', 'id': 'PROFILE_ID'}\]
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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`
Input parameters
Resource type for the campaign values report request. Must be 'campaign-values-report'.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
API filter string (not an array) used to filter the query. Example: equals(campaign_id,"01GMRWDSA0ARTAKE1SFX8JGXAY"). Allowed filters: campaign_id. Allowed operators: equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 campaign IDs per contains-any filter.
The timeframe to query for data within (max 1 year). Supports two formats: 1) Predefined key: {'key': 'last_12_months'} - valid keys include 'last_12_months', 'last_30_days', 'last_7_days', 'this_month', 'last_month', etc. 2) Custom date range: {'start': '2024-01-01T00:00:00+00:00', 'end': '2024-12-31T23:59:59+00:00'} using ISO 8601 timestamps.
List of statistics to query for. All rate statistics will be returned in fractional form \[0.0, 1.0\]. Common aliases are supported: 'average_open_rate' maps to 'open_rate', 'count_opened' maps to 'opens', 'count_sent' maps to 'recipients'.
Required. ID of the metric for calculating conversion-based statistics (e.g., 'Placed Order' metric). Use Get Metrics API to find valid metric IDs. Note: Use purchase/order event metrics (not engagement metrics like 'Opened Email') to avoid 'does not support querying for values data' errors.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_QUERY_FLOW_SERIESReturns time-series analytics data for flows, enabling performance tracking over time intervals. Use this to analyze flow metrics like open rates, click rates, conversions, and delivery statistics. Rate limits: Burst 1/s, Steady 2/m, Daily 225/d. Scopes: flows:read
Input parameters
The resource type. Must be 'flow-series-report'.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
API filter string to filter the query. Allowed filters: flow_id, send_channel, flow_message_id. Operators: equals, contains-any. Use AND to combine filters. Max 100 messages per ANY filter. send_channel values: 'email', 'push-notification', 'sms'. Examples: 'equals(flow_id,"abc123")' or 'equals(send_channel,"email") AND equals(flow_id,"abc123")'
The interval used to aggregate data within the series request. If hourly is used, the timeframe cannot be longer than 7 days. If daily is used, the timeframe cannot be longer than 60 days. If monthly is used, the timeframe cannot be longer than 52 weeks.
The timeframe to query for data within (max 1 year). Use either a preset key format: {'key': 'last_30_days'} or {'key': 'last_7_days'} or {'key': 'last_12_months'}, or a custom date range: {'start': '2024-01-01T00:00:00+00:00', 'end': '2024-01-31T00:00:00+00:00'}. Dates must be ISO 8601 format with timezone.
List of statistics to query for. All rate statistics will be returned in fractional form \[0.0, 1.0\]
ID of the metric to be used for conversion statistics. Get metric IDs from the KLAVIYO_GET_METRICS action. Common metrics: 'Placed Order', 'Opened Email', 'Clicked Email'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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`
Input parameters
Resource type for the flow values report request. Must be 'flow-values-report'.
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
Filter string to narrow results. Accepts either a plain filter string like 'equals(send_channel,"email")' or a JSON-encoded array like '\["equals(flow_id,"ABC123")"\]' (which will be automatically converted). Supported filters: flow_id, send_channel, flow_message_id. Supported operators: equals (for SINGLE value, e.g., 'equals(flow_id,"ABC123")'), contains-any (for MULTIPLE values, e.g., 'contains-any(flow_id,\["ABC123","DEF456"\])'). Only one filter per attribute, only AND for combining. Max 100 messages per ANY filter. For send_channel: email, push-notification, or sms.
The timeframe to query for data within. Max length is 1 year. IMPORTANT: 'key' and 'start'/'end' are mutually exclusive - use EITHER a predefined key like {'key': 'last_30_days'} OR custom date ranges like {'start': '2024-01-01T00:00:00Z', 'end': '2024-12-31T23:59:59Z'}, but never combine them. Available predefined keys: last_7_days, last_30_days, last_90_days, last_365_days, this_week, this_month, this_quarter, this_year, last_week, last_month, last_quarter, last_year.
List of statistics to query for. All rate statistics will be returned in fractional form \[0.0, 1.0\]. Common aliases are supported: 'average_open_rate' maps to 'open_rate', 'count_opened' maps to 'opens', 'count_sent' maps to 'recipients'.
ID of the conversion metric (e.g., 'Placed Order' metric ID) required for ALL flow values report queries. This metric is used for calculating conversion-based statistics, but the endpoint will return all requested statistics regardless of conversion status. For example, 'opens' will include all opens whether or not they resulted in conversions. Get metric IDs from the Get Metrics endpoint.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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'.
Input parameters
Type
Optional attribute(s) used for partitioning by the aggregation function
Provide a sort key (e.g. -$message)
List of filter strings for querying metric aggregates. Each filter uses function syntax: operator(field,value). TIME RANGE (REQUIRED): Must use 'datetime' (not $attributed_time) for time filtering with ISO 8601 format (YYYY-MM-DDTHH:MM:SS). Typically requires both: 'greater-or-equal(datetime,START_TIME)' and 'less-than(datetime,END_TIME)'. Maximum time range: 1 year (365 days). ADDITIONAL FILTERS (OPTIONAL): Can filter by metric attributes using $ prefix (e.g., $message, $flow, $attributed_flow). Supported operators: equals, not, any. Examples: \['greater-or-equal(datetime,2024-01-15T00:00:00)', 'less-than(datetime,2024-02-15T00:00:00)'\] or with attribute filter: \['greater-or-equal(datetime,2024-01-01T00:00:00)', 'less-than(datetime,2024-12-31T00:00:00)', 'equals($message,"MSG_ID")'\]
Aggregation interval, e.g. "hour", "day", "week", "month"
The timezone used for processing the query, e.g. `"America/New_York"`. This field is validated against a list of common timezones from the \[IANA Time Zone Database\](https://www.iana.org/time-zones). While most are supported, a few notable exceptions are `Factory`, `Europe/Kyiv` and `Pacific/Kanton`. This field is case-sensitive.
Convenient timeframe parameter with 'start' and 'end' datetime values in ISO 8601 format (YYYY-MM-DDTHH:MM:SS). If provided, this will automatically be converted to the required filter format. The maximum allowed time range is 1 year (365 days). Example: {'start': '2024-01-15T00:00:00', 'end': '2025-01-15T00:00:00'}
The metric ID used in the aggregation.
Alter the maximum number of returned rows in a single page of aggregation results
Measurement key, e.g. `unique`, `sum_value`, `count`
Optional pagination cursor to iterate over large result sets
Provide fields to limit the returned data
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_REMOVE_PROFILE_FROM_LISTRemove profiles from a Klaviyo list by profile IDs or email addresses. This action removes profiles from a marketing list without affecting their overall consent status. Use the Unsubscribe Profiles action for complete unsubscribing. You can remove up to 1000 profiles per call. Rate limits: 10/s burst, 150/m steady. Required scopes: `lists:write` and `profiles:write`. Preconditions: - Either profile_ids or emails must be provided (not both) - Maximum 1000 profiles per call - Email addresses must be valid format - The list must exist and be accessible
Input parameters
List of email addresses to remove from the list (alternative to profile_ids)
The ID of the list to remove profiles from
List of profile IDs to remove from the list (max 1000 per call)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_REQUEST_PROFILE_DELETIONTo delete a profile, use only one identifier: email, phone number, or ID. Requests are asynchronous and can be tracked. Ensure legal compliance; refer to docs. Rate limits: 3 per second, 60 per minute.
Input parameters
Resource type for the deletion job request. Must be 'data-privacy-deletion-job'.
Klaviyo profile ID to delete. Use this OR email OR phone_number (only one identifier required).
Resource type for the profile to delete. Must be 'profile'.
Email address of the profile to delete. Use this OR profile ID OR phone_number (only one identifier required).
Phone number of the profile to delete in E.164 format (e.g., +15551234567). Use this OR profile ID OR email (only one identifier required).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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. Rate limits: 10/s burst, 150/m steady. Requires `lists:write` and `profiles:write` scopes. More info in the Bulk Profile Import API guide.
Input parameters
Type
Data
Data
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_SPAWN_COUPON_CODE_BULK_CREATE_JOBCreate a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max 1000 coupon codes per job. Max 100 jobs queued at once. Rate limits: Burst 75/s, Steady 700/m. Scopes: coupon-codes:write. Returns a job ID that can be used to query the job status via the get_coupon_code_bulk_create_job endpoint.
Input parameters
Resource type for the bulk create job. Must be 'coupon-code-bulk-create-job'.
Array of coupon code objects to create in bulk (max 1000 per job). Each object must have: 'type' (always 'coupon-code'), 'attributes' (with required 'unique_code' string and optional 'expires_at' ISO 8601 datetime), and 'relationships' (with 'coupon.data.type' as 'coupon' and 'coupon.data.id' as the coupon ID to associate the codes with). Example: \[{"type": "coupon-code", "attributes": {"unique_code": "CODE123"}, "relationships": {"coupon": {"data": {"type": "coupon", "id": "COUPON_ID"}}}}\]
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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. Rate limits: 75/s burst, 700/m steady. Requires 'catalogs:write' scope.
Input parameters
The type of resource. Must be 'catalog-category-bulk-create-job'.
Array of catalog category objects to create in bulk (max 100). Each object must have 'type': 'catalog-category' and 'attributes' containing 'external_id' (unique identifier in your system) and 'name' (category display name). Optional: 'integration_type' (default: '$custom') and 'catalog_type' (default: '$default').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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. Rate limits are 75/s burst and 700/m steady. Requires `catalogs:write` scope.
Input parameters
Resource type for the bulk create job. Must be 'catalog-item-bulk-create-job'.
Array of catalog items to create in bulk (max 100 items, 5MB total). Each item must include 'type' ('catalog-item') and 'attributes' object with required fields: 'external_id' (unique ID), 'title', 'description', 'url'. Optional fields: 'price' (float), 'published' (boolean), 'image_full_url', 'image_thumbnail_url', 'images' (array of URLs).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_SPAWN_CREATE_VARIANTS_JOBInitiate a job to bulk create up to 100 catalog variants, with a 5MB payload size limit. A max of 500 jobs can run concurrently. Rate limits are 75/s burst and 700/m steady. Requires 'catalogs:write' scope.
Input parameters
Resource type identifier. Must be 'catalog-variant-bulk-create-job'.
Array of catalog variant objects to create (max 100). Each variant object must have: type='catalog-variant', attributes (with external_id, title, description, sku, inventory_quantity, price, url as required fields; optional: image_full_url, image_thumbnail_url, images, inventory_policy, published), and relationships.item.data (with type='catalog-item' and id=parent_item_id in format '$custom:::$default:::external_id').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_SPAWN_DELETE_CATEGORIES_JOBDelete multiple catalog categories in bulk, with a limit of 100 per request and a 5MB payload size. A maximum of 500 concurrent jobs permitted. Rate limits are 75/s burst and 700/min steady. Requires `catalogs:write` scope.
Input parameters
Resource type for the bulk delete job. Must be 'catalog-category-bulk-delete-job'.
Array of catalog category objects to delete. Each object must have 'type' set to 'catalog-category' and 'id' set to the category ID (format: '$custom:::$default:::{external_id}'). Maximum 100 categories per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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. Rate limits are 75/s burst and 700/m steady. Requires `catalogs:write` scope.
Input parameters
The resource type for this bulk delete job. Must be 'catalog-item-bulk-delete-job'.
Array of catalog items to delete. Each item must be an object with 'type' (always 'catalog-item') and 'id' (the catalog item ID in format '$custom:::$default:::{external_id}'). Maximum 100 items per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_SPAWN_DELETE_VARIANTS_JOBDelete multiple catalog variants with a bulk job, max 100 per request, 5MB size limit. Only 500 jobs can run concurrently. Rate limits: 75/s burst, 700/m steady. Requires `catalogs:write` scope.
Input parameters
Resource type for the bulk delete job. Must be 'catalog-variant-bulk-delete-job'.
List of catalog variant objects to delete. Each object must include 'type' (always 'catalog-variant') and 'id' (variant ID in format '$custom:::$default:::{external_id}'). Maximum 100 variants per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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. Burst rate limit is 75/s, steady is 700/m. Requires `catalogs:write` scope.
Input parameters
Type
Data
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_SPAWN_UPDATE_ITEMS_JOBYou can bulk update up to 100 catalog items with a 5MB payload limit. A max of 500 jobs can run concurrently. Rate limits are 75 requests/second and 700 requests/minute. Required scope: `catalogs:write`.
Input parameters
The resource type for the bulk update job. Must be 'catalog-item-bulk-update-job'.
Array of catalog item objects to update in bulk (max 100 items). Each object must have: 'type' (always 'catalog-item'), 'id' (compound ID in format '$custom:::$default:::{external_id}'), and 'attributes' object containing fields to update (title, description, price, url, image_full_url, image_thumbnail_url, images array, custom_metadata object, published boolean).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_SPAWN_UPDATE_VARIANTS_JOBCreate a job to bulk update up to 100 catalog variants with a 5MB payload limit. A max of 500 jobs may run concurrently. Rate limits are 75/s burst and 700/m steady. Requires `catalogs:write` scope.
Input parameters
Resource type for the bulk update job. Must be 'catalog-variant-bulk-update-job'.
Array of catalog variant objects to update. Each object must have 'type' (value: 'catalog-variant'), 'id' (the variant's unique identifier in format '$custom:::$default:::external_id'), and 'attributes' (object containing fields to update like title, description, sku, price, inventory_quantity, url, published, etc.). Maximum 100 variants per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_SUBSCRIBE_PROFILESThe API supports double opt-in for marketing, with 'historical_import' bypassing consent. It resets opt-outs for returning users. Caps at 1000 profiles, 75/s, and 700/min. Needs 'lists:write', 'profiles:write', 'subscriptions:write' permissions.
Input parameters
Resource type. Must be 'profile-subscription-bulk-create-job'.
A custom method detail or source to store on the consent records.
List of profile objects to subscribe. Each profile must have 'type': 'profile' and 'attributes' containing 'email' (required) and optionally 'phone_number', 'subscriptions' (for channel-specific opt-in like EMAIL or SMS). Max 1000 profiles per request.
The list to add the newly subscribed profiles to
Whether this subscription is part of a historical import. If true, the consented_at field must be provided for each profile.
Resource type for the list relationship. Must be 'list'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_SUPPRESS_PROFILESSuppress profiles by email, segment, or list ID to stop email marketing, regardless of consent. View guides for details. Max 100 emails per request, with rate limits of 75/s and 700/m. Scopes: profiles:write, subscriptions:write.
Input parameters
Resource type identifier. Must be 'profile-suppression-bulk-create-job'.
List of profile objects to suppress. Each object must have 'type': 'profile' and 'attributes': {'email': '<email_address>'}. Maximum 100 profiles per request. Can be empty if suppressing by list or segment.
The ID of the list whose profiles should be suppressed. All current members of this list will be suppressed from email marketing.
Resource type for list relationship. Must be 'list' when suppressing by list.
The ID of the segment whose profiles should be suppressed. All current members of this segment will be suppressed from email marketing.
Resource type for segment relationship. Must be 'segment' when suppressing by segment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UNREGISTER_CLIENT_PUSH_TOKENThis endpoint unsubscribes a push token, for use with Klaviyo's mobile SDKs and a public API key. Push notifications must be on. Rate limits are 3/s and 60/m.
Input parameters
Your Public API Key / Site ID. See \[this article\](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
Type
A push token from APNS or FCM.
The vendor of the push token.
The platform on which the push token was created.
Primary key that uniquely identifies this profile. Generated by Klaviyo.
Type
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
Individual"s email address
URL pointing to the location of a profile image
Individual"s job title
First line of street address
Second line of street address
Latitude coordinate. We recommend providing a precision of four decimal places.
Time zone name. We recommend using time zones from the IANA Time Zone Database.
Remove a key or keys (and their values) completely from properties
Longitude coordinate. We recommend providing a precision of four decimal places.
Individual"s last name
Individual"s first name
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
IP Address
Name of the company or organization within the company for whom the individual works
Id that can be used to identify a profile when other identifiers are not available
Zip code
Individual"s phone number in E.164 format
City name
Region within a country, such as state or province
Country name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UNSUBSCRIBE_PROFILESOpt-out profiles from email or SMS marketing. Unsubscribe up to 100 profiles at a time with burst (75/s) and steady (700/m) rate limits. Use different method to remove without affecting subscriptions. More on consent and removal in the provided links.
Input parameters
Resource type. Must be 'profile-subscription-bulk-delete-job'.
List of profile objects to unsubscribe (max 100). Each profile should have 'type': 'profile' and 'attributes' containing 'email' for email unsubscribe. Example: \[{'type': 'profile', 'attributes': {'email': 'user@example.com'}}\]
The ID of the Klaviyo list to unsubscribe the profiles from.
Resource type for the list relationship. Must be 'list'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UNSUBSCRIBE_PROFILES_BULKTool to unsubscribe one or more profiles from a Klaviyo list. Use when you need to bulk unsubscribe up to 100 profiles from email or SMS marketing for a specific list.
Input parameters
Array of email addresses to unsubscribe. Maximum 100 profiles per request.
The ID of the Klaviyo list from which profiles should be unsubscribed
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UNSUPPRESS_PROFILESRemove 'USER_SUPPRESSED' blocks on profiles manually via email, segment, or list ID. Does not affect unsubscribes or other suppressions. Limits: 100 emails per request, 75/s burst, 700/m steady. Scope: 'subscriptions:write'.
Input parameters
Resource type, must be 'profile-suppression-bulk-delete-job'.
List of profile objects to unsuppress. Each object should have 'type': 'profile' and 'attributes': {'email': 'user@example.com'}. Max 100 emails per request. Use empty list \[\] when unsuppressing via list or segment relationship.
The ID of the list whose members should be unsuppressed. When specified, all profiles in this list will have their USER_SUPPRESSED status removed.
Resource type for list relationship, must be 'list'. Required when specifying a list ID.
The ID of the segment whose members should be unsuppressed. When specified, all profiles in this segment will have their USER_SUPPRESSED status removed.
Resource type for segment relationship, must be 'segment'. Required when specifying a segment ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UNSUPPRESS_PROFILES_BULKTool to unsuppress one or more profiles from email marketing by email address. Use when you need to remove USER_SUPPRESSED status from profiles. This only removes suppressions with reason USER_SUPPRESSED; profiles with HARD_BOUNCE or INVALID_EMAIL suppressions remain unchanged. Returns a job object that can be monitored for completion status.
Input parameters
List of suppression objects containing email addresses to unsuppress. Maximum 100 profiles per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_CAMPAIGNUpdate a campaign with the specified attributes. This action allows you to modify campaign settings including name, audiences, and send strategy. Only the fields you provide will be updated; others remain unchanged. Rate limits: 10/s burst, 150/m steady. Required scope: `campaigns:write`. Preconditions: - Valid API key with campaigns:write scope - Campaign ID must exist and be accessible - Campaign must be in a state that allows updates (usually draft status) - Send strategy options must match the selected method
Input parameters
The campaign name
The unique identifier of the campaign to update. Use GET /api/campaigns to list available campaigns.
Additional send options (advanced use)
Date to send on for Smart Send Time (YYYY-MM-DD format)
Tracking options for the campaign
List of list/segment IDs to exclude from audiences
List of list/segment IDs to include as audiences
Percentage of recipients to send to per hour. Valid values: 10, 11, 13, 14, 17, 20, 25, 33, 50. Required when send_strategy_method is 'throttled'.
Method for sending the campaign. Options: 'static' (scheduled time), 'throttled' (gradual sending), 'immediate' (send now), 'smart_send_time' (AI-optimized timing)
When to send the campaign (for static strategy)
When to start sending the campaign (for throttled strategy)
Whether to send in recipients' local timezones
Whether to send immediately to recipients in past timezones. Only valid when static_is_local_timezone is True.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_CAMPAIGN_MESSAGEUpdate a campaign message<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `campaigns:write`
Input parameters
The message ID to be retrieved
The message ID to be retrieved
Type
The label or name on the message
Channel-specific message content fields. Valid fields depend on the channel type: - EMAIL: subject, preview_text, from_email, from_label, reply_to_email, cc_email, bcc_email. DO NOT include 'body' for email campaigns - email HTML is managed through templates. - SMS: body (message text), media_url (for MMS). - MOBILE_PUSH: body (up to 512 chars), title, notification_type, dynamic_image, play_sound, badge, on_open.
Shorten Links
Add Info Link
Add Org Prefix
Add Opt Out Language
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_CATALOG_CATEGORYUpdate a catalog category with the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
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`.
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`.
The resource type for the catalog category. Must be 'catalog-category'.
The name of the catalog category.
Array of catalog item relationships to associate with this category. Each item should have 'type' (always 'catalog-item') and 'id' (the catalog item ID).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_CATALOG_CATEGORY_RELATIONSHIPSTool to update item relationships for a catalog category. Replaces all existing item relationships with the provided list. Use when you need to associate catalog items with a category or remove existing associations. Pass an empty data array to remove all item relationships from the category. Rate limits: 75/s burst, 700/m steady. Required scope: catalogs:write.
Input parameters
The unique identifier of the catalog category to update relationships for. Format: '$custom:::$default:::{external_id}' (e.g., '$custom:::$default:::test-category-001').
Array of catalog item identifiers to associate with the category. This replaces all existing relationships. Pass an empty array to remove all item relationships. Each item must have 'type' set to 'catalog-item' and 'id' in format '$custom:::$default:::{external_id}'.
The type of related resource to update. Currently only 'items' is supported.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSUpdate item relationships for the given category ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
The unique identifier of the catalog category whose item relationships to update. Format: {integration_type}:::{catalog_type}:::{external_id} (e.g., '$custom:::$default:::my-category-id').
Array of catalog item resource identifiers to replace the existing relationships. Each object must have 'type' (always 'catalog-item') and 'id' (the item's unique identifier in format '$custom:::$default:::{external_id}'). Pass an empty array to remove all item relationships.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_CATALOG_ITEMUpdate a catalog item with the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
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`.
The catalog item ID in the request body. Must match the 'id' path parameter. Format: `{integration}:::{catalog}:::{external_id}` (e.g., '$custom:::$default:::ITEM-123'). Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
The resource type. Must be 'catalog-item'.
URL pointing to the location of the catalog item on your website.
This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the \[Update Catalog Variant Endpoint\](https://developers.klaviyo.com/en/reference/update_catalog_variant).
The title of the catalog item.
List of URLs pointing to the locations of images of the catalog item.
Boolean value indicating whether the catalog item is published.
A description of the catalog item.
URL pointing to the location of a full image of the catalog item.
Array of category relationships to associate with this catalog item. Each object should have 'type' (always 'catalog-category') and 'id' (the category ID in format '$custom:::$default:::CATEGORY_ID').
URL pointing to the location of an image thumbnail of the catalog item
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESUpdate catalog category relationships for the given item ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
The unique identifier of the catalog item in the format '$custom:::$default:::{external_id}' (e.g., '$custom:::$default:::my-product-123').
Array of catalog category relationship objects. Each object must have 'type' set to 'catalog-category' and 'id' set to the category ID in format '$custom:::$default:::{external_id}'. Pass an empty array \[\] to remove all category associations from the item.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_CATALOG_VARIANTUpdate a catalog item variant with the given variant ID.<br><br>*Rate limits*:<br>Burst: `75/s`<br>Steady: `700/m` **Scopes:** `catalogs:write`
Input parameters
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`.
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`.
Type
The SKU of the catalog item variant.
URL pointing to the location of the catalog item variant on your website.
This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the \[Update Catalog Item Endpoint\](https://developers.klaviyo.com/en/reference/update_catalog_item).
The title of the catalog item variant.
List of URLs pointing to the locations of images of the catalog item variant.
Boolean value indicating whether the catalog item variant is published.
A description of the catalog item variant.
URL pointing to the location of a full image of the catalog item variant.
This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.
The quantity of the catalog item variant currently in stock.
URL pointing to the location of an image thumbnail of the catalog item variant.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_COUPONUpdate an existing coupon's properties. Currently, only the coupon description can be updated. The coupon ID (external_id) cannot be changed after creation. *Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `coupons:write`
Input parameters
The unique identifier of the coupon to update. This is the external_id that was assigned when the coupon was created (e.g., 'SUMMER_SALE_2026').
The coupon ID in the request body. Must match the 'id' path parameter.
The resource type. Must be 'coupon' for coupon objects.
The new description for the coupon. Can be used to add or update the coupon's description text.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_COUPON_CODEUpdates a coupon code specified by the given identifier synchronously. We allow updating the 'status' and 'expires_at' of coupon codes.<br><br>*Rate limits*:<br>Burst: `350/s`<br>Steady: `3500/m` **Scopes:** `coupon-codes:write`
Input parameters
The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
The resource type. Must be 'coupon-code' for coupon code resources.
The API status of our coupon codes.
The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_FLOW_STATUSUpdate the status of a flow with the given flow ID, and all actions in that flow. Flow statuses: - 'draft': Flow is disabled; no messages will be sent - 'manual': Messages require manual approval before sending - 'live': Messages are sent automatically when triggered Rate limits: Burst: 3/s, Steady: 60/m Required scope: flows:write
Input parameters
The unique identifier of the flow to update (e.g., 'XVTP5Q'). This ID is used in the URL path.
The flow ID in the request body. If not provided, defaults to the 'id' path parameter value. Must match the path parameter 'id'.
Resource type for the request body. Must always be 'flow'.
The new status to set for the flow. 'draft' = flow is disabled and no messages will be sent; 'manual' = messages require manual approval before sending; 'live' = messages are sent automatically when triggered.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_IMAGEUpdate the image with the given image ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `images:write`
Input parameters
The ID of the image
The ID of the image in the request body. Must match the 'id' path parameter.
Resource type for the request body. Must always be 'image'.
A name for the image. Can contain Unicode characters and special characters.
If true, the image is hidden and not shown in the asset library. Defaults to false if not specified.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_LISTUpdate the name of a list with the given list ID.<br><br>*Rate limits*:<br>Burst: `10/s`<br>Steady: `150/m` **Scopes:** `lists:write`
Input parameters
Primary key that uniquely identifies this list. Generated by Klaviyo.
Primary key that uniquely identifies this list. Generated by Klaviyo.
Type
A helpful name to label the list
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_PROFILEUpdate profiles with the provided ID. Setting fields to `null` clears them; omitting fields retains existing data. Rate limits: 75/s burst, 700/m steady. Required scope: `profiles:write`.
Input parameters
Primary key that uniquely identifies this profile. Generated by Klaviyo.
Primary key that uniquely identifies this profile. Generated by Klaviyo.
Resource type. Must be 'profile'.
Individual's email address
URL pointing to the location of a profile image
Individual's job title
Individual's last name
Individual's first name
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
IP Address
Name of the company or organization within the company for whom the individual works
Anonymous identifier for tracking profiles before they are identified with an email or external ID
Zip code
Individual's phone number in E.164 format (e.g., +15005550006)
City name
Region within a country, such as state or province
Country name
First line of street address
Second line of street address
Latitude coordinate. We recommend providing a precision of four decimal places.
Time zone name. We recommend using time zones from the IANA Time Zone Database.
Remove a key or keys (and their values) completely from properties
Longitude coordinate. We recommend providing a precision of four decimal places.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_SEGMENTUpdate a segment with the given segment ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m`<br>Daily: `100/d` **Scopes:** `segments:write`
Input parameters
The unique identifier of the segment to update (e.g., 'XTTNN5'). This is a required path parameter.
The ID of the segment being updated. Should match the path parameter 'id'.
The resource type. Must be 'segment' for segment updates.
The display name of the segment. Use this to rename the segment.
Whether the segment should be starred/favorited for quick access. Set to true to star or false to unstar.
Array of condition groups that define segment membership. Each group contains conditions combined with logical OR, and groups are combined with logical AND. Example: \[{'conditions': \[{'type': 'profile-property', 'property': 'email', 'filter': {'type': 'string', 'operator': 'contains', 'value': '@gmail.com'}}\]}\]
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_TAGUpdate the tag with the given tag ID. Only a tag's `name` can be changed. A tag cannot be moved from one tag group to another. **Important**: The `data__id` in the request body must match the `id` path parameter. Returns HTTP 204 No Content on success. *Rate limits*: Burst: `3/s` | Steady: `60/m` **Scopes:** `tags:read` `tags:write`
Input parameters
The Tag ID
The Tag ID in the request body. Must match the 'id' path parameter.
The resource type for the request body. Must be 'tag'.
The new name for the tag. This is the only attribute that can be updated.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_TAG_GROUPUpdate the tag group with the given tag group ID. Only a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `60/m` **Scopes:** `tags:read` `tags:write`
Input parameters
The Tag Group ID
The Tag Group ID in the request body. Must match the 'id' path parameter.
Resource type identifier. Must be 'tag-group'. Defaults to 'tag-group' if not provided.
The new name for the tag group. This is the only attribute that can be modified after creation.
Optional list of fields to return in the response. If not specified, default fields are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_TEMPLATEUpdate an existing email template by ID. Supports updating name, HTML content, and plaintext content. Note: This action only works with CODE editor type templates; drag & drop templates cannot be updated via API. Rate limits: Burst 10/s, Steady 150/m. Requires 'templates:write' scope.
Input parameters
The unique identifier of the template to update. Used in the URL path.
The template ID in the request body. Must match the 'id' path parameter.
Resource type identifier. Must be 'template'.
The new HTML content for the template. Only works with CODE editor type templates, not drag & drop templates.
The new name for the template. Optional - only include if updating the name.
The new plaintext version of the template. This is the fallback content for email clients that don't support HTML.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPDATE_WEBHOOKUpdate the webhook with the given ID.<br><br>*Rate limits*:<br>Burst: `1/s`<br>Steady: `15/m` **Scopes:** `webhooks:write`
Input parameters
The ID of the webhook.
The ID of the webhook.
Resource type identifier. Must be set to 'webhook' for webhook resources.
A name for the webhook.
Boolean flag to enable or disable the webhook. Set to true to enable the webhook to receive events, or false to disable it.
A description for the webhook.
A secret key, that will be used for webhook request signing.
A url to send webhook calls to. Must be https.
Array of webhook topic references. Each item should have 'type' set to 'webhook-topic' and 'id' set to a webhook topic identifier (e.g., 'event:klaviyo.sent_sms', 'event:klaviyo.received_sms').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPLOAD_IMAGE_FROM_FILEUpload an image from a file. If you want to import an image from an existing url or a data uri, use the Upload Image From URL endpoint instead.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `100/m`<br>Daily: `100/d` **Scopes:** `images:write`
Input parameters
The image file to upload. Supported formats: jpeg, png, gif. Maximum file size: 5 MB.
A name for the image. If not provided, defaults to the filename.
If True, the image will not be shown in the asset library. Defaults to False.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
KLAVIYO_UPLOAD_IMAGE_FROM_URLImport an image from a url or data uri. If you want to upload an image from a file, use the Upload Image From File endpoint instead.<br><br>*Rate limits*:<br>Burst: `3/s`<br>Steady: `100/m`<br>Daily: `100/d` **Scopes:** `images:write`
Input parameters
Resource type for the request. Must be 'image'.
A name for the image. Defaults to the filename if not provided. If the name matches an existing image, a suffix will be added.
If true, this image is not shown in the asset library.
An existing image url to import the image from. Alternatively, you may specify a base-64 encoded data-uri (`data:image/...`). Supported image formats: jpeg,png,gif. Maximum image size: 5MB.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 61 agents privately built on Nagent that already use Klaviyo.
Build on Nagent
Connect Klaviyo to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Klaviyo, and click "Connect Now." You'll authenticate with API_KEY, OAUTH2 — Nagent handles credential storage and refresh automatically. Once connected, Klaviyo is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Klaviyo is connected, you configure its 225 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Klaviyo steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Klaviyo event fires, the agent kicks off automatically.
Every Klaviyo action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Klaviyo ships with 225 pre-built marketing automation actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Klaviyo together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Klaviyo-based workflows tailored to your business.