Skip to main content
Klaviyo logo
  • Category: marketing automation
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 233
  • Triggers: 0
  • Slug: KLAVIYO
  • Version: 20261101_00

Tools

Slug: KLAVIYO_ADD_PROFILE_TO_LISTAdd up to 1000 existing profiles to a Klaviyo list by profile IDs or email addresses. Email addresses are resolved to existing profiles; an unmatched email causes the action to fail before adding profiles.

Input Parameters

array
List of email addresses to add to the list (alternative to profile_ids)
string
required
The ID of the list to add profiles to
array
List of profile IDs to add to the list (max 1000 per call)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_ASSIGN_CAMPAIGN_MESSAGE_TEMPLATECreates a non-reusable version of the template and assigns it to the message.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:write

Input Parameters

string
required
The unique identifier of the campaign message to assign the template to. Obtained from campaign creation or get campaign messages endpoints.
string ("campaign-message")
Resource type for the campaign message. Must be ‘campaign-message’.
string
required
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.
string ("template")
Resource type for the template. Must be ‘template’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_BULK_CREATE_CLIENT_EVENTSSubmit client-side events to track profile activity using a public API key; the request can also update profile details and remove profile properties. Accepts up to 1,000 events per request, with rate limits of 10/s burst and 150/m steady.

Input Parameters

string
required
Your Public API Key / Site ID. See this article for more details.
string ("event-bulk-create")
Type
array
Data
string
Primary key that uniquely identifies this profile. Generated by Klaviyo.
string ("profile")
Type
string
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.
string
Individual”s email address
string
URL pointing to the location of a profile image
string
Individual”s job title
string
First line of street address
string
Second line of street address
string
Latitude coordinate. We recommend providing a precision of four decimal places.
string
Time zone name. We recommend using time zones from the IANA Time Zone Database.
array
Remove a key or keys (and their values) completely from properties
string
Longitude coordinate. We recommend providing a precision of four decimal places.
string
Individual”s last name
string
Individual”s first name
string
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.
string
IP Address
string
Name of the company or organization within the company for whom the individual works
string
Anonymous Id
string
Zip code
string
Individual”s phone number in E.164 format
string
City name
string
Region within a country, such as state or province
string
Country name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("event-bulk-create-job")
Resource type identifier. Must be ‘event-bulk-create-job’.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("cancel" | "revert")
The action to perform. ‘cancel’ permanently cancels the campaign (status becomes CANCELED, irreversible). ‘revert’ returns the campaign to DRAFT status for further editing.
string
required
The unique identifier of the campaign send job to cancel or revert. This is the ID returned when creating a campaign send job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("back-in-stock-subscription")
Type
array
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).
string
Primary key that uniquely identifies this profile. Generated by Klaviyo.
string ("profile")
Type
string
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
string ("catalog-variant")
Type
string
Individual”s email address
string
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.
string
Anonymous Id
string
Individual”s phone number in E.164 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_CAMPAIGNCreates a campaign given a set of parameters, then returns it.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:write

Input Parameters

string ("campaign")
Type
string
The campaign name
object
Options to use when sending a campaign
object
The tracking options associated with the campaign
array
An optional list of excluded audiences
array
A list of included audiences
string
Describes the shape of the options object. Allowed values: [“static”, “throttled”, “immediate”, “smart_send_time”]
array
Data
string
The day to send on
string
The time to send at
string
The time to send at
boolean
If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time. Defaults to False.
boolean
Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends. Defaults to False.
integer
The percentage of recipients per hour to send to. Allowed values: [10, 11, 13, 14, 17, 20, 25, 33, 50]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_CAMPAIGN_CLONEClones an existing campaign, returning a new campaign based on the original with a new ID and name.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:write

Input Parameters

string
The campaign ID to be cloned
string ("campaign")
Type
string
The name for the new cloned campaign

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the campaign to perform recipient estimation for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_CAMPAIGN_SEND_JOBTrigger a campaign to send asynchronously

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:write

Input Parameters

string
required
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.
string ("campaign-send-job")
Resource type identifier. Must be ‘campaign-send-job’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_CATALOG_CATEGORYCreate a new catalog category.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string ("catalog-category")
Type
string
The name of the catalog category.
string
The ID of the catalog category in an external system.
string
The type of catalog. Currently only “$default” is supported.
array
Data
string ("$custom")
The integration type. Currently only “$custom” is supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSCreate a new item relationship for the given category ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string
required
The ID of the catalog category. Must be URL-encoded for the API request.
array
required
List of catalog item resource identifiers to add to the category. Each item should have ‘type’: ‘catalog-item’ and ‘id’: ‘<catalog-item-id>’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_CATALOG_ITEMCreate a new catalog item.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string ("catalog-item")
Type
string
URL pointing to the location of the catalog item on your website.
number
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.
string
The title of the catalog item.
array
List of URLs pointing to the locations of images of the catalog item.
boolean
Boolean value indicating whether the catalog item is published.
string
A description of the catalog item.
string
The ID of the catalog item in an external system.
string
The type of catalog. Currently only “$default” is supported.
string
URL pointing to the location of a full image of the catalog item.
string ("$custom")
The integration type. Currently only “$custom” is supported.
array
Data
string
URL pointing to the location of an image thumbnail of the catalog item

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESCreate a new catalog category relationship for the given item ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string
required
The ID of the catalog item (e.g., ‘$custom:::$default:::my-item-id’). Will be automatically URL-encoded for the API request.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_CATALOG_VARIANTCreate a new variant for a related catalog item.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string ("catalog-variant")
Type
string
The SKU of the catalog item variant.
string
URL pointing to the location of the catalog item variant on your website.
number
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.
string
The title of the catalog item variant.
array
List of URLs pointing to the locations of images of the catalog item variant.
boolean
Boolean value indicating whether the catalog item variant is published.
string
A description of the catalog item variant.
string
The ID of the catalog item variant in an external system.
string
The type of catalog. Currently only “$default” is supported.
string
URL pointing to the location of a full image of the catalog item variant.
string ("$custom")
The integration type. Currently only “$custom” is supported.
integer
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.
string
The original catalog item ID for which this is a variant.
number
The quantity of the catalog item variant currently in stock.
string ("catalog-item")
Type
string
URL pointing to the location of an image thumbnail of the catalog item variant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Your Public API Key / Site ID. See this article for more details.
string ("back-in-stock-subscription")
Type
array
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).
string
Primary key that uniquely identifies this profile. Generated by Klaviyo.
string ("profile")
Type
string
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
string ("catalog-variant")
Type
string
Individual”s email address
string
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.
string
Anonymous Id
string
Individual”s phone number in E.164 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
IP address
string
City name
string
URL to profile image
string
Profile’s job title
string
Region/state
string
Country name
string
First line of street address
string
Second line of street address
string
Latitude coordinate
string
Timezone
string
Zip code
string
Profile’s last name
string
Longitude coordinate
string
Unique identifier for the event to prevent duplicates
string
required
Your Public API Key / Site ID for client-side tracking. This appears in both the event attributes and profile attributes.
string
When the event occurred. Defaults to current time if not provided.
string
Profile’s first name
object
Custom properties for the event
number
Monetary value associated with the event (e.g., purchase amount)
string
required
Name of the event metric. Must be less than 128 characters.
string
Profile’s organization
string
Email address of the profile to associate with the event
string
Currency code for the event value (ISO 4217)
object
Custom properties to update on the profile
string
External ID of the profile
string
Anonymous ID of the profile
string
Phone number of the profile in E.164 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Your Public API Key / Site ID. See this article for more details.
string ("subscription")
Type
string
A custom method detail or source to store on the consent records for this subscription.
string
Primary key that uniquely identifies this profile. Generated by Klaviyo.
string
The list ID to add the newly subscribed profile to.
string ("profile")
Type
string ("list")
Type
string
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.
string
Individual”s email address
string
URL pointing to the location of a profile image
string
Individual”s job title
string
First line of street address
string
Second line of street address
string
Latitude coordinate. We recommend providing a precision of four decimal places.
string
Time zone name. We recommend using time zones from the IANA Time Zone Database.
array
Remove a key or keys (and their values) completely from properties
string
Longitude coordinate. We recommend providing a precision of four decimal places.
string
Individual”s last name
string
Individual”s first name
string
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.
string
IP Address
string
Name of the company or organization within the company for whom the individual works
string
Id that can be used to identify a profile when other identifiers are not available
string
Zip code
string
Individual”s phone number in E.164 format
string
City name
string
Region within a country, such as state or province
string
Country name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_COUPONCreates a new coupon.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: coupons:write

Input Parameters

string ("coupon")
Type
string
A description of the coupon.
string
This is the id that is stored in an integration such as Shopify or Magento.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_COUPON_CODECreate a coupon code for a given coupon. The action declares the coupon-codes:read scope.

Input Parameters

string ("coupon-code")
Type
string
The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.
string
This is a unique string that will be or is assigned to each customer/profile and is associated with a coupon.
string
Id
string ("coupon")
Type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("event")
Type
string
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.
integer
A numeric, monetary value to associate with this event. For example, the dollar amount of a purchase.
object
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.
string
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.
string
The ISO 4217 currency code of the value associated with the event.
string
Primary key that uniquely identifies this profile. Generated by Klaviyo.
string ("metric")
Type
string ("profile")
Type
string
Name of the event. Must be less than 128 characters.
string
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.
string
Individual”s email address
string
URL pointing to the location of a profile image
string
Individual”s job title
string
This is for advanced usage. For api requests, this should use the default, which is set to api.
string
First line of street address
string
Second line of street address
string
Latitude coordinate. We recommend providing a precision of four decimal places.
string
Time zone name. We recommend using time zones from the IANA Time Zone Database.
string
Longitude coordinate. We recommend providing a precision of four decimal places.
string
Individual”s last name
string
Individual”s first name
string
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.
string
IP Address
string
Name of the company or organization within the company for whom the individual works
string
Anonymous Id
string
Zip code
string
Individual”s phone number in E.164 format
string
City name
array
Remove a key or keys (and their values) completely from properties
string
Region within a country, such as state or province
string
Country name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_FLOWCreate a draft flow from an encoded flow definition. For a minimal flow, use one list trigger, an empty actions array, and a null entry_action_id as shown in the definition example.

Input Parameters

string
required
The name of the flow.
object
required
The encoded flow definition containing triggers, actions, and entry_action_id. New objects such as actions must use temporary_id instead of id.
array
Sparse fields to return for the created flow.
array
Additional flow fields to return. The supported value is definition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_FORMCreate a draft Klaviyo signup form from an encoded form definition.

Input Parameters

string
required
The name of the form.
string
The form status. New forms must be drafts.
boolean
Whether the form has an A/B test configured.
object
required
The encoded form definition. Every version must contain at least two steps.
array
Sparse form fields to return for the created form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_LISTCreate a new list.

Rate limits:
Burst: 10/s
Steady: 150/m
Daily: 100/d Scopes: lists:write

Input Parameters

string ("list")
Type
string
A helpful name to label the list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Primary key that uniquely identifies this profile. Generated by Klaviyo.
string
required
Your Public API Key / Site ID. See this article for more details.
string ("profile")
Type
string
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.
string
Individual”s email address
string
URL pointing to the location of a profile image
string
Individual”s job title
string
Individual”s last name
string
Individual”s first name
string
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.
string
IP Address
string
Name of the company or organization within the company for whom the individual works
string
Anonymous Id
string
Zip code
string
Individual”s phone number in E.164 format
string
City name
string
Region within a country, such as state or province
string
Country name
string
First line of street address
string
Second line of street address
string
Latitude coordinate. We recommend providing a precision of four decimal places.
string
Time zone name. We recommend using time zones from the IANA Time Zone Database.
array
Remove a key or keys (and their values) completely from properties
string
Longitude coordinate. We recommend providing a precision of four decimal places.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Your Public API Key / Site ID. See this article for more details.
string ("push-token")
Type
string
A push token from APNS or FCM.
string ("apns" | "fcm")
The vendor of the push token.
array
Remove a key or keys (and their values) completely from properties
string ("android" | "ios")
The platform on which the push token was created.
string ("AVAILABLE" | "DENIED" | "RESTRICTED")
The background state of the push token.
string
Primary key that uniquely identifies this profile. Generated by Klaviyo.
string ("AUTHORIZED" | "DENIED" | "NOT_DETERMINED" | "PROVISIONAL" | "UNAUTHORIZED")
This is the enablement status for the individual push token.
string ("profile")
Type
string
The ID of the app that created the push token
string ("android" | "ios" | "ipados" | "macos" | "tvos")
The name of the operating system on the device.
string
The name of the app that created the push token
string
The build of the app that created the push token
string
Relatively stable ID for the device. Will update on app uninstall and reinstall
string ("debug" | "release")
The environment in which the push token was created
string
The version of the operating system on the device
string
The version of the app that created the push token
string ("android" | "swift")
The name of the SDK used to create the push token.
string
The manufacturer of the device
string
The version of the SDK used to create the push token
string
The model of the device
string
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.
string
Individual”s email address
string
URL pointing to the location of a profile image
string
Individual”s job title
string
First line of street address
string
Second line of street address
string
Latitude coordinate. We recommend providing a precision of four decimal places.
string
Time zone name. We recommend using time zones from the IANA Time Zone Database.
string
Longitude coordinate. We recommend providing a precision of four decimal places.
string
Individual”s last name
string
Individual”s first name
string
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.
string
IP Address
string
Name of the company or organization within the company for whom the individual works
string
Id that can be used to identify a profile when other identifiers are not available
string
Zip code
string
Individual”s phone number in E.164 format
string
City name
string
Region within a country, such as state or province
string
Country name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_OR_UPDATE_PROFILECreate or update a Klaviyo profile using an email, phone number, external ID, or anonymous ID and supplied attributes. Null-valued fields are omitted from the request; the action requires profiles:write access.

Input Parameters

string
City name
string
Individual’s email address
string
URL pointing to the location of a profile image
string
Individual’s job title
string
Region within a country, such as state or province
string
Country name
string
First line of street address
string
Second line of street address
string
Latitude coordinate. We recommend providing a precision of four decimal places.
string
Time zone name. We recommend using time zones from the IANA Time Zone Database.
string
Zip code
string
Individual’s last name
string
Longitude coordinate. We recommend providing a precision of four decimal places.
string
Individual’s first name
object
Custom properties to associate with the profile
string
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system
string
Id that can be used to identify a profile when other identifiers are not available
string
Name of the company or organization within the company for whom the individual works
string
Individual’s phone number in E.164 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("push-token")
Resource type. Must be ‘push-token’.
string
A push token from APNS or FCM.
string ("apns" | "fcm")
The push notification vendor. Use ‘apns’ for iOS (Apple Push Notification Service) or ‘fcm’ for Android (Firebase Cloud Messaging).
array
Remove a key or keys (and their values) completely from properties
string ("android" | "ios")
The mobile platform. Use ‘ios’ for Apple devices or ‘android’ for Android devices.
string ("AVAILABLE" | "DENIED" | "RESTRICTED")
The background state of the push token.
string
Primary key that uniquely identifies this profile. Generated by Klaviyo.
string ("AUTHORIZED" | "DENIED" | "NOT_DETERMINED" | "PROVISIONAL" | "UNAUTHORIZED")
This is the enablement status for the individual push token.
string ("profile")
Profile resource type. Must be ‘profile’.
string
The ID of the app that created the push token
string ("android" | "ios" | "ipados" | "macos" | "tvos")
The name of the operating system on the device.
string
The name of the app that created the push token
string
The build of the app that created the push token
string
Relatively stable ID for the device. Will update on app uninstall and reinstall
string ("debug" | "release")
The environment in which the push token was created
string
The version of the operating system on the device
string
The version of the app that created the push token
string ("android" | "swift")
The name of the SDK used to create the push token.
string
The manufacturer of the device
string
The version of the SDK used to create the push token
string
The model of the device
string
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.
string
Individual”s email address
string
URL pointing to the location of a profile image
string
Individual”s job title
string
First line of street address
string
Second line of street address
string
Latitude coordinate. We recommend providing a precision of four decimal places.
string
Time zone name. We recommend using time zones from the IANA Time Zone Database.
string
Longitude coordinate. We recommend providing a precision of four decimal places.
string
Individual”s last name
string
Individual”s first name
string
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.
string
IP Address
string
Name of the company or organization within the company for whom the individual works
string
Id that can be used to identify a profile when other identifiers are not available
string
Zip code
string
Individual”s phone number in E.164 format
string
City name
string
Region within a country, such as state or province
string
Country name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_PROFILECreate a new profile.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: profiles:write

Input Parameters

string ("profile")
Type
string
Individual”s email address
string
URL pointing to the location of a profile image
string
Individual”s job title
string
Individual”s last name
string
Individual”s first name
string
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.
string
IP Address
string
Name of the company or organization within the company for whom the individual works
string
Zip code
string
Individual”s phone number in E.164 format
string
City name
string
Region within a country, such as state or province
string
Country name
string
First line of street address
string
Second line of street address
string
Latitude coordinate. We recommend providing a precision of four decimal places.
string
Time zone name. We recommend using time zones from the IANA Time Zone Database.
string
Longitude coordinate. We recommend providing a precision of four decimal places.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_SEGMENTCreate a segment.

Rate limits:
Burst: 1/s
Steady: 15/m
Daily: 100/d Scopes: segments:write

Input Parameters

string ("segment")
Type
string
Name
boolean
Is Starred
array
Condition Groups

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_TAGCreate a tag in an account, optionally specifying its tag group. The account has a maximum of 500 tags; rate limits are 3/s burst and 60/min steady.

Input Parameters

string ("tag")
Type
string
The Tag name
string
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.
string ("tag-group")
Type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("tag-group")
Type
string
The Tag Group name
boolean
Exclusive

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of resource identifiers to associate with the tag. Each item must have ‘type’ and ‘id’ fields.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_TEMPLATECreate a custom HTML template in Klaviyo, subject to the account limit of 1,000 templates. Rate limits are 10 per second and 150 per minute; requires the templates:write scope.

Input Parameters

string ("template")
Type
string
The HTML contents of the template
string
The name of the template
string
The plaintext version of the template
string
Restricted to CODE

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The ID of template to be cloned
string ("template")
Type
string
The name of the template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_TEMPLATE_RENDERRender an email template with specific context and return HTML and plain text. Rate limit: 3/s burst, 60/m steady; scope: templates:read.

Input Parameters

string
The ID of template
string ("template")
Type
object
The context (key-value pairs) to render the template with. Keys should match template variable names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_CREATE_WEBHOOKCreate a webhook to receive real-time notifications for specified Klaviyo events. The action declares webhooks:read and webhooks:write scopes; event-based topics may also require events:read, rate limits are burst 1/s and steady 15/m, and each account can have a maximum of 10 webhooks.

Input Parameters

string ("webhook")
The resource type for the webhook. Must be ‘webhook’.
string
A name for the webhook.
string
A description for the webhook.
string
A secret key used for HMAC-SHA256 signing of webhook requests. Use this to verify webhook authenticity on your server.
string
The HTTPS URL where webhook payloads will be sent. Must use HTTPS protocol (e.g., ‘https://example.com/webhook’).
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_DELETE_CAMPAIGNDelete a campaign with the given campaign ID.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:write

Input Parameters

string
required
The campaign ID to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_DELETE_CATALOG_CATEGORYDelete a catalog category using the given category ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string
required
The catalog category ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_DELETE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSDelete item relationships for the given category ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string
required
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.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_DELETE_CATALOG_ITEMDelete a catalog item with the given item ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string
required
The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_DELETE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESDelete catalog category relationships for the given item ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string
required
array
required
Data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_DELETE_CATALOG_VARIANTDelete a catalog item variant with the given variant ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string
required
The catalog variant ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_DELETE_COUPONDelete the coupon with the given coupon ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: coupons:write

Input Parameters

string
required
The internal id of a Coupon is equivalent to its external id stored within an integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: coupon-codes:write

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_DELETE_FLOWDelete a flow with the given flow ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:write

Input Parameters

string
required
ID of the Flow to delete. Ex: XVTP5Q

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_DELETE_FORMPermanently delete a Klaviyo form by ID. This action cannot be undone.

Input Parameters

string
required
The unique identifier of the Klaviyo form to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_DELETE_LISTDelete a list with the given list ID.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: lists:write

Input Parameters

string
required
Primary key that uniquely identifies this list. Generated by Klaviyo.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_DELETE_SEGMENTDelete a segment with the given segment ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: segments:write

Input Parameters

string
required
The unique identifier of the segment to delete. Segment IDs are alphanumeric strings (e.g., ‘TJx2Yb’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_DELETE_TAGDelete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: tags:read tags:write

Input Parameters

string
required
The Tag ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Tag Group ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The tag ID from which to remove resource associations
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the template to delete. Can be obtained from the get_templates or create_template actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Rate limits:
Burst: 1/s
Steady: 15/m Scopes: accounts:read

Input Parameters

string
required
The ID of the account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the coupon code bulk create job to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the bulk delete job to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOBGet a bulk profile import job with the given job ID.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: lists:read profiles:read

Input Parameters

string
required
ID of the job to retrieve.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_ERRORSGet import errors for the bulk profile import job with the given ID.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: profiles:read

Input Parameters

string
required
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.
integer
Default: 20. Min: 1. Max: 100.
string
Cursor for pagination. Use the value from the ‘next’ or ‘prev’ link in the response to fetch additional pages of errors.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_LISTSGet list for the bulk profile import job with the given ID.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: lists:read

Input Parameters

string
required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_PROFILESGet profiles for the bulk profile import job with the given ID.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: profiles:read

Input Parameters

string
required
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.
integer
Default: 20. Min: 1. Max: 100.
array
Request additional fields not included by default in the response. Supported values: “subscriptions”, “predictive_analytics”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_LISTSGet list relationship for the bulk profile import job with the given ID.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: lists:read

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_PROFILESGet profile relationships for the bulk profile import job with the given ID.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: profiles:read

Input Parameters

string
required
integer
Default: 20. Min: 1. Max: 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOBSGet bulk profile import jobs, with up to 100 jobs per request. Rate limits: 10/s burst and 150/m steady; the tool declares lists:write and profiles:write scopes.

Input Parameters

string ("created_at" | "-created_at")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
status: any, equals
integer
Default: 20. Min: 1. Max: 100.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
ID of the job to retrieve.
array
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.
array
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.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the bulk update categories job
boolean
Whether to include related category data in the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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.
string ("variants")
Options for including related resources in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The campaign ID to retrieve
boolean
Whether to include tags in the response
boolean
Whether to include campaign messages in the response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CAMPAIGN_CAMPAIGN_MESSAGESRetrieve messages belonging to a campaign; requires campaigns:read. The response can contain pagination links.

Input Parameters

string
required
The unique identifier of the campaign to retrieve messages for. You can obtain campaign IDs using the Get Campaigns action.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CAMPAIGN_MESSAGEReturns a specific message based on a required id.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:read

Input Parameters

string
required
The message ID to be retrieved
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CAMPAIGN_MESSAGE_CAMPAIGNReturn the related campaign

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:read

Input Parameters

string
required
The unique identifier of the campaign message. Used to retrieve the parent campaign associated with this message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CAMPAIGN_MESSAGE_RELATIONSHIPS_CAMPAIGNReturns the ID of the related campaign

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:read

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CAMPAIGN_MESSAGE_RELATIONSHIPS_TEMPLATEReturns the ID of the related template

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:read templates:read

Input Parameters

string
required
The unique identifier of the campaign message to retrieve the template relationship for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CAMPAIGN_MESSAGE_TEMPLATEReturn the related template

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:read templates:read

Input Parameters

string
required
The unique identifier of the campaign message. Example: ‘01KFGQQNRE7Z9FZ0AAQ3TQAKYZ’.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the campaign for which to get the estimated number of recipients
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATION_JOBRetrieve the status of a recipient estimation job triggered with the Create Campaign Recipient Estimation Job endpoint.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:read

Input Parameters

string
required
The ID of the campaign to get recipient estimation status
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_CAMPAIGN_MESSAGESReturns the IDs of all messages associated with the given campaign.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:read

Input Parameters

string
required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_TAGSReturns the IDs of all tags associated with the given campaign.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: campaigns:read tags:read

Input Parameters

string
required
The unique identifier of the campaign to retrieve tag relationships for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CAMPAIGNSRetrieve a page of Klaviyo campaigns filtered by channel, with optional additional filtering and sorting. The channel defaults to email, archived campaigns are excluded unless requested, and the required scope is campaigns:read.

Input Parameters

string ("created_at" | "-created_at" | "id" | "-id" | "name" | "-name" | "scheduled_at" | "-scheduled_at" | "updated_at" | "-updated_at")
Klaviyo API sort options - note the _at suffix is required for time-based fields.
string
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.
string ("email" | "sms")
Campaign channel to filter by (email or sms). Required by Klaviyo API.
string
Cursor for pagination to get the next page of results Iterate using links.next until it returns null to retrieve all results.
boolean
Whether to include archived campaigns in the results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CAMPAIGN_SEND_JOBGet a campaign send job

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:read

Input Parameters

string
required
The ID of the campaign to send
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CAMPAIGN_TAGSReturn all tags that belong to the given campaign.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: campaigns:read tags:read

Input Parameters

string
required
The unique identifier of the campaign to retrieve tags for (e.g., ‘01KFT75VHSJJ4X5E1G4ZT0VQCJ’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("created" | "-created")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
ids: any
item.id: equals
name: contains
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CATALOG_CATEGORYGet a catalog category with the given category ID.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: catalogs:read

Input Parameters

string
required
The catalog category ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
string ("created" | "-created")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
ids: any
category.id: equals
title: contains
published: equals
array
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSRetrieve catalog item identifiers associated with a category, up to 100 per request. Rate limits: 350/s burst and 3500/m steady; the tool declares the catalogs:write scope.

Input Parameters

string
required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CATALOG_ITEMGet a specific catalog item with the given item ID.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: catalogs:read

Input Parameters

string
required
The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.
array
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
string ("created" | "-created")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
ids: any
item.id: equals
name: contains
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESRetrieve catalog category identifiers associated with an item, up to 100 per request. Rate limits: 350/s burst and 3500/m steady; scope: catalogs:read.

Input Parameters

string
required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("created" | "-created")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
ids: any
category.id: equals
title: contains
published: equals
array
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
string ("created" | "-created")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
ids: any
item.id: equals
sku: equals
title: contains
published: equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CATALOG_VARIANTGet a catalog item variant with the given variant ID.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: catalogs:read

Input Parameters

string
required
The catalog variant ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("created" | "-created")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
ids: any
item.id: equals
sku: equals
title: contains
published: equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_COUPONGet a specific coupon by coupon ID. The action declares the coupon-codes:read scope.

Input Parameters

string
required
The internal id of a Coupon is equivalent to its external id stored within an integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_COUPON_CODEReturns a Coupon Code specified by the given identifier.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: coupon-codes:read

Input Parameters

string
required
The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOBGet a coupon code bulk create job with the given job ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: coupon-codes:read

Input Parameters

string
required
ID of the job to retrieve.
array
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOBSGet coupon code bulk create jobs, with cursor pagination and optional status filtering. The action declares the coupon-codes:write scope.

Input Parameters

string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
status: equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_COUPON_CODE_RELATIONSHIPS_COUPONGets a list of coupon code relationships associated with the given coupon id

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: coupon-codes:read

Input Parameters

string
required
The unique identifier of the coupon to retrieve coupon code relationships for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
expires_at: greater-or-equal, greater-than, less-or-equal, less-than
status: equals
coupon.id: any, equals
profile.id: any, equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_COUPON_CODES_FOR_COUPONGets a list of coupon codes associated with the given coupon id

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: coupon-codes:read

Input Parameters

string
required
The unique identifier of the coupon (external_id) for which to retrieve associated coupon codes.
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
expires_at: greater-or-equal, greater-than, less-or-equal, less-than
status: equals
coupon.id: any, equals
profile.id: any, equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_COUPON_FOR_COUPON_CODEGet the coupon associated with a given coupon code ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: coupons:read

Input Parameters

string
required
The unique identifier for the coupon code. This is typically in the format ‘{coupon_id}-{unique_code}’ (e.g., ‘PROMO_SUMMER_2026-SUMMER2026PROMO’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the coupon code to look up the relationship of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_COUPON_RELATIONSHIPS_COUPON_CODESRetrieve coupon code relationship identifiers for a given coupon; pagination links may be returned, but subsequent pages cannot be requested through this tool. The declared scope is coupons:read, with rate limits of 75/s burst and 700/m steady.

Input Parameters

string
required
The unique identifier of the coupon (external_id) to retrieve coupon code relationships for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_COUPONSGet all coupons in an account. To learn more, see our Coupons API guide.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: coupons:read

Input Parameters

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: catalogs:read

Input Parameters

string
required
ID of the job to retrieve.
array
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CREATE_CATEGORIES_JOBSGet catalog category bulk create jobs, with up to 100 jobs per request. The tool declares catalogs:write, with rate limits of 350/s burst and 3500/m steady.

Input Parameters

string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
status: equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: catalogs:read

Input Parameters

string
required
ID of the job to retrieve.
array
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CREATE_ITEMS_JOBSGet catalog item bulk create jobs, with up to 100 jobs per request. The tool declares catalogs:write, with rate limits of 350/s burst and 3500/m steady.

Input Parameters

string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
status: equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CREATE_VARIANTS_JOBGet a catalog variant bulk create job by its job ID to check its status and processing results. Related variants can be included, and sparse fieldsets can be requested. Requires the catalogs:read scope; rate limits are 350 requests per second burst and 3,500 per minute steady.

Input Parameters

string
required
ID of the job to retrieve.
array
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_CREATE_VARIANTS_JOBSGet catalog variant bulk create jobs, with up to 100 jobs per request. The tool declares catalogs:write, with rate limits of 350/s burst and 3500/m steady.

Input Parameters

string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
status: equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_DELETE_CATEGORIES_JOBGet a catalog category bulk delete job with the given job ID.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: catalogs:read

Input Parameters

string
required
ID of the job to retrieve.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_DELETE_CATEGORIES_JOBSGet catalog category bulk delete jobs, with up to 100 jobs per request. The tool declares catalogs:write, with rate limits of 350/s burst and 3500/m steady.

Input Parameters

string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
status: equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_DELETE_ITEMS_JOBSGet catalog item bulk delete jobs, with up to 100 jobs per request. The tool declares catalogs:write, with rate limits of 350/s burst and 3500/m steady.

Input Parameters

string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
status: equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_DELETE_VARIANTS_JOBGet a catalog variant bulk delete job with the given job ID.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: catalogs:read

Input Parameters

string
required
ID of the job to retrieve.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_DELETE_VARIANTS_JOBSGet catalog variant bulk delete jobs, with optional status filtering and cursor pagination, returning a maximum of 100 jobs per request. The tool is configured with the catalogs:write scope.

Input Parameters

string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
status: equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_EVENTGet an event with the given event ID.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: events:read

Input Parameters

string
required
ID of the event

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_EVENT_METRICGet the metric for an event with the given event ID.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: events:read metrics:read

Input Parameters

string
required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_EVENT_PROFILEGet the profile associated with an event with the given event ID.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: events:read profiles:read

Input Parameters

string
required
The unique identifier of the event to retrieve the associated profile for.
array
Request additional fields not included by default in the response. Supported values: “subscriptions”, “predictive_analytics”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the event
The type of relationship to retrieve - either ‘metric’ or ‘profile’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: events:read

Input Parameters

string ("datetime" | "-datetime" | "timestamp" | "-timestamp")
string
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
array
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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FLOWGet a flow with the given flow ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read

Input Parameters

string
required
The unique identifier of the flow to retrieve. Flow IDs can be obtained from the Get Flows endpoint.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FLOW_ACTIONGet a flow action from a flow with the given flow action ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read

Input Parameters

string
required
array
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FLOW_ACTION_FOR_MESSAGEGet the flow action for a flow message with the given message ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read

Input Parameters

string
required
The unique identifier of the flow message. Flow message IDs can be obtained from the GET flow action messages endpoint.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FLOW_ACTION_MESSAGESRetrieve flow messages for an action ID, with filtering, page size, and ascending or descending sorting. Rate limits are 3/s burst and 60/m steady; scope required is flows:read.

Input Parameters

string
required
The unique identifier of the flow action to retrieve messages for. Flow action IDs can be obtained from the Get Flow Actions endpoint.
string ("created" | "-created" | "id" | "-id" | "name" | "-name" | "updated" | "-updated")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
id: any
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
integer
Default: 50. Min: 1. Max: 100.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the flow action to retrieve message relationships for.
string ("created" | "-created" | "id" | "-id" | "name" | "-name" | "updated" | "-updated")
Sort field and direction for results. Options: ‘created’, ‘-created’, ‘id’, ‘-id’, ‘name’, ‘-name’, ‘updated’, ‘-updated’. Prefix with ’-’ for descending order.
string
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’).
integer
Number of results per page. Default: 50. Min: 1. Max: 50.
string
Cursor for pagination. Use the value from ‘links.next’ in a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read

Input Parameters

string
required
The unique identifier of the flow to retrieve flow actions for. Flow IDs can be obtained from the Get Flows endpoint.
string ("action_type" | "-action_type" | "created" | "-created" | "id" | "-id" | "status" | "-status" | "updated" | "-updated")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
id: any
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)
status: 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
integer
Default: 50. Min: 1. Max: 50.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FLOW_FOR_FLOW_ACTIONGet the flow associated with the given action ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read

Input Parameters

string
required
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FLOW_MESSAGEGet the flow message of a flow with the given message ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read

Input Parameters

string
required
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.
array
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FLOW_MESSAGE_RELATIONSHIPS_TEMPLATEReturns the ID of the related template

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: templates:read

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FLOW_MESSAGE_TEMPLATEReturn the related template

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: templates:read

Input Parameters

string
required
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.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FLOW_RELATIONSHIPS_FLOW_ACTIONSRetrieve flow action relationship identifiers for a flow ID, with filtering, sorting, and a configurable page size. Requires flows:read; rate limits are 3/s burst and 60/m steady.

Input Parameters

string
required
The unique identifier (ID) of the flow to retrieve flow action relationships for. Can be obtained from the Get Flows endpoint.
string ("created" | "-created" | "id" | "-id" | "status" | "-status" | "updated" | "-updated")
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.
string
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.
integer
Default: 50. Min: 1. Max: 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FLOW_RELATIONSHIPS_TAGSReturn the tag IDs of all tags associated with the given flow.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read tags:read

Input Parameters

string
required
The unique identifier of the flow to retrieve tag relationships for. Example: ‘RkaANL’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FLOWSGet all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read

Input Parameters

string ("created" | "-created" | "id" | "-id" | "name" | "-name" | "status" | "-status" | "trigger_type" | "-trigger_type" | "updated" | "-updated")
string
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
integer
Number of flows to return per page.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FLOW_TAGSReturn all tags associated with the given flow ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read tags:read

Input Parameters

string
required
The unique identifier of the flow to retrieve tags for. Example: ‘Yd27AJ’.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FORMGet the form with the given ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: forms:read

Input Parameters

string
required
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.
array
Related resources to include in the response. Currently supports: ‘form-versions’ to include detailed form version data.
array
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.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FORM_FOR_FORM_VERSIONGet the form associated with the given form version.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: forms:read

Input Parameters

string
required
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FORM_ID_FOR_FORM_VERSIONGet the ID of the form associated with the given form version.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: forms:read

Input Parameters

string
required
The unique identifier of the form version to retrieve the associated form ID for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_FORMSGet all forms in an account.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: forms:read

Input Parameters

string ("created_at" | "-created_at" | "updated_at" | "-updated_at")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
id: any, equals
name: any, contains, equals
ab_test: equals
updated_at: greater-or-equal, greater-than, less-or-equal, less-than
created_at: greater-or-equal, greater-than, less-or-equal, less-than
status: equals
integer
Default: 20. Min: 1. Max: 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the form version to retrieve. Obtain this ID from the ‘Get Versions for Form’ endpoint or from form version relationships.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_IMAGEGet the image with the given image ID.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: images:read

Input Parameters

string
required
The ID of the image
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_IMAGESGet all images in an account.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: images:read

Input Parameters

string ("format" | "-format" | "id" | "-id" | "name" | "-name" | "size" | "-size" | "updated_at" | "-updated_at")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
id: any, equals
updated_at: greater-or-equal, greater-than, less-or-equal, less-than
format: any, equals
name: any, contains, ends-with, equals, starts-with
size: greater-or-equal, greater-than, less-or-equal, less-than
hidden: any, equals
integer
Default: 20. Min: 1. Max: 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_LISTRetrieve a Klaviyo list by ID. Requires lists:read scope; rate limits are 75/s and 700/m, or 1/s and 15/m when requesting profile count.

Input Parameters

string
required
Primary key that uniquely identifies this list. Generated by Klaviyo.
array
Request additional fields not included by default in the response. Supported values: “profile_count”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the Klaviyo list to retrieve profiles from. Example: ‘Y6nRLr’
string ("joined_group_at" | "-joined_group_at")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
email: any, equals
phone_number: any, equals
push_token: any, equals
_kx: equals
joined_group_at: greater-or-equal, greater-than, less-or-equal, less-than
integer
Default: 20. Min: 1. Max: 100.
array
Request additional fields not included by default in the response. Supported values: “subscriptions”, “predictive_analytics”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the list
string
Cursor for pagination to get the next page of results
The type of related resource to retrieve (currently only ‘profiles’ is supported)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_LIST_RELATIONSHIPS_TAGSReturns the tag IDs of all tags associated with the given list.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: lists:read tags:read

Input Parameters

string
required
The unique identifier (ID) of the list to retrieve tag relationships for. Example: ‘TDFT78’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_LISTSRetrieve paginated marketing lists from a Klaviyo account, with optional filtering and sorting. Requires lists:read scope; rate limits are 75/s burst and 700/m steady.

Input Parameters

string ("created" | "-created" | "id" | "-id" | "name" | "-name" | "updated" | "-updated")
Sort lists by field (add ’-’ prefix for descending order)
string
Filter lists by name, creation date, etc. Example: ‘equals(name,“Newsletter”)’
string
Cursor for pagination to get the next page of results
boolean
Whether to include tags associated with the lists

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_LIST_TAGSReturn all tags associated with the given list ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: lists:read tags:read

Input Parameters

string
required
The unique identifier of the Klaviyo list to retrieve tags for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_METRICGet a metric with the given metric ID.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: metrics:read

Input Parameters

string
required
Metric ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: metrics:read

Input Parameters

string
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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_PROFILEGet the profile with the given profile ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: profiles:read

Input Parameters

string
required
array
Request additional fields not included by default in the response. Supported values: “subscriptions”, “predictive_analytics”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_PROFILE_LISTSGet list memberships for a profile with the given profile ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: lists:read profiles:read

Input Parameters

string
required
The unique identifier of the profile to retrieve list memberships for. This is a Klaviyo profile ID (e.g., ‘01KFT7HBHVKV3D25581YVCNAJN’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("created" | "-created" | "email" | "-email" | "id" | "-id" | "updated" | "-updated")
Sort profiles by field (add ’-’ prefix for descending order)
string
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.
integer
Number of profiles to return per page (1-100)
string
Cursor for pagination to get the next page of results
boolean
Whether to include subscription information in the response
boolean
Whether to include predictive analytics data (note: this may reduce rate limits)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_PROFILE_SEGMENTSGet segment memberships for a profile with the given profile ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: profiles:read segments:read

Input Parameters

string
required

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_REVIEWSList Klaviyo review records with filtering, sparse fields, related events, sorting, and cursor pagination.

Input Parameters

string ("created" | "-created" | "rating" | "-rating" | "updated" | "-updated")
Sort reviews by created, rating, or updated, ascending or descending.
string
Klaviyo filter over created, rating, id, item.id, content, status, review_type, or verified.
array
Related resources to include. The reviews endpoint supports events.
integer
Number of reviews to return per page, from 1 to 100.
string
Cursor from the previous response’s links.next URL.
array
Sparse fields to return for included events.
array
Sparse fields to return for each review.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the segment to retrieve. This ID is returned when creating segments or listing segments via the API.
array
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.
array
Specify which tag fields to include in the response when using include=[‘tags’]. Available fields: ‘name’. If not specified, all tag fields are returned.
array
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.
array
Request additional fields not included by default in the response. Supported values: “profile_count”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
string ("joined_group_at" | "-joined_group_at")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
email: any, equals
phone_number: any, equals
push_token: any, equals
_kx: equals
joined_group_at: greater-or-equal, greater-than, less-or-equal, less-than
integer
Default: 20. Min: 1. Max: 100.
array
Request additional fields not included by default in the response. Supported values: “subscriptions”, “predictive_analytics”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_SEGMENT_RELATIONSHIPSGet a page of profile membership or tag relationships for a segment, with pagination links when returned. The action declares profiles:read, segments:read, and tags:read scopes.

Input Parameters

string
required
The segment identifier (e.g., ‘TJx2Yb’)
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("created" | "-created" | "id" | "-id" | "name" | "-name" | "updated" | "-updated")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
name: any, equals
id: any, equals
created: greater-than
updated: greater-than
is_active: any, equals
is_starred: equals

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_SEGMENT_TAGSReturn all tags associated with the given segment ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: segments:read tags:read

Input Parameters

string
required
The unique identifier of the segment to retrieve tags for (e.g., ‘TJx2Yb’). Use KLAVIYO_GET_SEGMENTS to list available segment IDs.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_TAGRetrieve the tag with the given tag ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: tags:read

Input Parameters

string
required
The unique identifier (UUID) of the tag to retrieve.
array
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.
array
Sparse fieldset for the tag resource. Limits which fields are returned in the tag’s attributes. Allowed values: ‘name’.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_TAG_GROUPRetrieve the tag group with the given tag group ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: tags:read

Input Parameters

string
required
The Tag Group ID
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_TAG_GROUP_RELATIONSHIPS_TAGSReturns the tag IDs of all tags inside the given tag group.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: tags:read

Input Parameters

string
required
The unique identifier (UUID) of the tag group to retrieve tag relationships for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("id" | "-id" | "name" | "-name")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
name: contains, ends-with, equals, starts-with
exclusive: equals
default: equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_TAG_GROUP_TAGSReturn the tags for a given tag group ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: tags:read

Input Parameters

string
required
The unique identifier (UUID) of the tag group to retrieve tags from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("id" | "-id" | "name" | "-name")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
name: contains, ends-with, equals, starts-with
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_TAG_TAG_GROUPReturns the tag group resource for a given tag ID.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: tags:read

Input Parameters

string
required
The unique identifier (UUID) of the tag whose tag group should be retrieved.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_TEMPLATEGet a template by ID, optionally requesting specific fields; the action raises an error if a requested field is absent from the response. Rate limits: 10/s burst, 150/m steady; requires templates:read.

Input Parameters

string
required
The unique identifier of the template to retrieve (e.g., ‘Rz66gr’).
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("created" | "-created" | "id" | "-id" | "name" | "-name" | "updated" | "-updated")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
id: any, equals
name: any, 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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_TRANSLATIONSList translations through Klaviyo’s beta, non-production API with filtering, sparse fields, related resources, sorting, and cursor pagination. This endpoint is subject to change.

Input Parameters

string ("id" | "-id")
Sort translations by ID in ascending or descending order.
string
Klaviyo filter over id, resource_type, channel, or related_resource_id.
array
Related resource types to include in the JSON:API response.
integer
Number of translations to return per page, from 1 to 100.
string
Cursor from the previous response’s links.next URL.
array
Sparse fields to return for included templates.
array
Sparse fields to return for each translation.
array
Sparse fields to return for included flow messages.
array
Sparse fields to return for included campaign variations.
array
Sparse fields to return for included template universal content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_UPDATE_CATEGORIES_JOBSGet all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: catalogs:read

Input Parameters

string
Filter jobs by status using equals operator. Format: equals(status,‘<value>’). Valid status values: ‘cancelled’, ‘complete’, ‘processing’, ‘queued’. Example: equals(status,‘complete’)
string
Cursor-based pagination token from a previous response’s ‘links.next’ field to fetch the next page of results.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: catalogs:read

Input Parameters

string
required
ID of the job to retrieve.
array
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.
array
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.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_UPDATE_ITEMS_JOBSGet catalog item bulk update jobs, with status filtering and cursor pagination, returning a maximum of 100 jobs per request. Rate limits: 350/s burst and 3500/m steady; the tool declares the catalogs:write scope.

Input Parameters

string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
status: equals
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_UPDATE_VARIANTS_JOBSGet all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: catalogs:read

Input Parameters

string
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.
string
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.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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.
string ("created" | "-created")
Sort options for variant IDs.
string
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’])
string
Cursor for pagination to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_VERSION_IDS_FOR_FORMGet the IDs of the form versions for the given form.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: forms:read

Input Parameters

string
required
The unique identifier of the form to retrieve version IDs for. Use the Get Forms endpoint to retrieve available form IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_VERSIONS_FOR_FORMGet the form versions for the given form.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: forms:read

Input Parameters

string
required
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/&lt;FORM_ID>).
string ("created_at" | "-created_at" | "updated_at" | "-updated_at")
string
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
form_type: any, equals
status: equals
updated_at: greater-or-equal, greater-than, less-or-equal, less-than
created_at: greater-or-equal, greater-than, less-or-equal, less-than
integer
Default: 20. Min: 1. Max: 100.
array

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_WEBHOOKGet the webhook with the given ID.

Rate limits:
Burst: 1/s
Steady: 15/m Scopes: webhooks:read

Input Parameters

string
required
The unique identifier of the webhook to retrieve. Obtain this from the list webhooks endpoint or webhook creation response.
array
Include related resources in the response. Use ‘webhook-topics’ to include the topics that trigger this webhook.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_WEBHOOKSGet webhooks in an account; the response can include pagination links. Scope: webhooks:read; rate limits: burst 1/s, steady 15/m.

Input Parameters

array
Optional list of related resources to include in the response. Use ‘webhook-topics’ to include the event topics that trigger each webhook.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_GET_WEBHOOK_TOPICSGet webhook topics in a Klaviyo account; the response can include pagination links. Scope: webhooks:read; rate limits: burst 1/s, steady 15/m.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the destination profile that will receive the merged data. This profile will be kept after the merge.
string ("profile-merge")
The resource type for merge operation. Must be ‘profile-merge’.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_QUERY_CAMPAIGN_VALUESReturns the requested campaign analytics values data

Rate limits:
Burst: 1/s
Steady: 2/m
Daily: 225/d Scopes: campaigns:read

Input Parameters

string ("campaign-values-report")
Resource type for the campaign values report request. Must be ‘campaign-values-report’.
string
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.
object
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.
array
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’.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("flow-series-report")
The resource type. Must be ‘flow-series-report’.
string
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”)’
string ("daily" | "hourly" | "monthly" | "weekly")
required
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.
object
required
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.
array
required
List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_QUERY_FLOW_VALUESReturns the requested flow analytics values data

Rate limits:
Burst: 1/s
Steady: 2/m
Daily: 225/d Scopes: flows:read

Input Parameters

string ("flow-values-report")
Resource type for the flow values report request. Must be ‘flow-values-report’.
string
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.
object
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.
array
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’.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_QUERY_FORM_SERIESReturn Klaviyo form performance metrics broken into time intervals.

Input Parameters

string
Filter over form_id or form_version_id using equals or any, joined only by AND. Use at most one filter per attribute and at most 100 values in any. Example: and(equals(form_id,“abc123”),any(form_version_id,[“xyz123”])).
array
Attributes to group by. form_version_id requires form_id. Defaults to form_id.
string ("daily" | "hourly" | "monthly" | "weekly")
required
Aggregation interval. Hourly supports at most 7 days, daily 60 days, and monthly 52 weeks.
string
required
Either one predefined key or a custom start/end range of at most one year.
array
required
Form metrics to return. Rate metrics are fractions from 0.0 to 1.0.
array
Sparse form-series-report fields to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_QUERY_FORM_VALUESReturn aggregate Klaviyo form performance statistics for a timeframe.

Input Parameters

string
Filter over form_id or form_version_id using equals or any, joined only by AND. Use at most one filter per attribute and at most 100 values in any. Example: and(equals(form_id,“abc123”),any(form_version_id,[“xyz123”])).
array
Attributes to group by. form_version_id requires form_id. Defaults to form_id.
string
required
Either one predefined key or a custom start/end range of at most one year.
array
required
Form metrics to return. Rate metrics are fractions from 0.0 to 1.0.
array
Sparse form-values-report fields to return. The live API currently accepts only results; it rejects the documented id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_QUERY_METRIC_AGGREGATESQuery aggregated metric measurements with grouping, sorting, and time-based filters. Rate limits: 3 requests per second and 60 per minute; scope: metrics:read.

Input Parameters

string ("metric-aggregate")
Type
array
Optional attribute(s) used for partitioning by the aggregation function
string ("$attributed_channel" | "-$attributed_channel" | "$attributed_flow" | "-$attributed_flow" | "$attributed_message" | "-$attributed_message" | "$attributed_variation" | "-$attributed_variation" | "$campaign_channel" | "-$campaign_channel" | "$flow" | "-$flow" | "$flow_channel" | "-$flow_channel" | "$message" | "-$message" | "$message_send_cohort" | "-$message_send_cohort" | "$variation" | "-$variation" | "$variation_send_cohort" | "-$variation_send_cohort" | "Bot Click" | "-Bot Click" | "Bounce Type" | "-Bounce Type" | "Campaign Name" | "-Campaign Name" | "Client Canonical" | "-Client Canonical" | "Client Name" | "-Client Name" | "Client Type" | "-Client Type" | "Email Domain" | "-Email Domain" | "Failure Source" | "-Failure Source" | "Failure Type" | "-Failure Type" | "From Number" | "-From Number" | "From Phone Region" | "-From Phone Region" | "Inbox Provider" | "-Inbox Provider" | "List" | "-List" | "Message Name" | "-Message Name" | "Message Type" | "-Message Type" | "Method" | "-Method" | "Subject" | "-Subject" | "To Number" | "-To Number" | "To Phone Region" | "-To Phone Region" | "URL" | "-URL" | "count" | "-count" | "form_id" | "-form_id" | "sum_value" | "-sum_value" | "unique" | "-unique")
Provide a sort key (e.g. -$message)
array
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”)’]
string ("day" | "hour" | "month" | "week")
Aggregation interval, e.g. “hour”, “day”, “week”, “month”
string
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. While most are supported, a few notable exceptions are Factory, Europe/Kyiv and Pacific/Kanton. This field is case-sensitive.
object
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’}
string
The metric ID used in the aggregation.
integer
Alter the maximum number of returned rows in a single page of aggregation results
array
Measurement key, e.g. unique, sum_value, count
string
Optional pagination cursor to iterate over large result sets
array
Provide fields to limit the returned data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_REMOVE_PROFILE_FROM_LISTRemove up to 1000 profiles from a Klaviyo list by profile IDs or email addresses. Email addresses are looked up as existing profiles; unmatched addresses are skipped, and the action returns an empty result even if none are found.

Input Parameters

array
List of email addresses to remove from the list (alternative to profile_ids)
string
required
The ID of the list to remove profiles from
array
List of profile IDs to remove from the list (max 1000 per call)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("data-privacy-deletion-job")
Resource type for the deletion job request. Must be ‘data-privacy-deletion-job’.
string
Klaviyo profile ID to delete. Use this OR email OR phone_number (only one identifier required).
string ("profile")
Resource type for the profile to delete. Must be ‘profile’.
string
Email address of the profile to delete. Use this OR profile ID OR phone_number (only one identifier required).
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("profile-bulk-import-job")
Type
array
Data
array
Data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("coupon-code-bulk-create-job")
Resource type for the bulk create job. Must be ‘coupon-code-bulk-create-job’.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("catalog-category-bulk-create-job")
The type of resource. Must be ‘catalog-category-bulk-create-job’.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("catalog-item-bulk-create-job")
Resource type for the bulk create job. Must be ‘catalog-item-bulk-create-job’.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("catalog-variant-bulk-create-job")
Resource type identifier. Must be ‘catalog-variant-bulk-create-job’.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("catalog-category-bulk-delete-job")
Resource type for the bulk delete job. Must be ‘catalog-category-bulk-delete-job’.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("catalog-item-bulk-delete-job")
The resource type for this bulk delete job. Must be ‘catalog-item-bulk-delete-job’.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("catalog-variant-bulk-delete-job")
Resource type for the bulk delete job. Must be ‘catalog-variant-bulk-delete-job’.
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("catalog-category-bulk-update-job")
Type
array
Data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("catalog-item-bulk-update-job")
The resource type for the bulk update job. Must be ‘catalog-item-bulk-update-job’.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("catalog-variant-bulk-update-job")
Resource type for the bulk update job. Must be ‘catalog-variant-bulk-update-job’.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_SUBSCRIBE_PROFILESSubmit a bulk job to subscribe profiles to marketing, optionally adding them to a list; supports double opt-in and historical imports, and may reset opt-outs for returning users. Caps at 1,000 profiles, with rate limits of 75/s and 700/min; requires lists:write, profiles:write, and subscriptions:write.

Input Parameters

string ("profile-subscription-bulk-create-job")
Resource type. Must be ‘profile-subscription-bulk-create-job’.
string
A custom method detail or source to store on the consent records.
array
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.
string
The list to add the newly subscribed profiles to
boolean
Whether this subscription is part of a historical import. If true, the consented_at field must be provided for each profile.
string ("list")
Resource type for the list relationship. Must be ‘list’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("profile-suppression-bulk-create-job")
Resource type identifier. Must be ‘profile-suppression-bulk-create-job’.
array
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.
string
The ID of the list whose profiles should be suppressed. All current members of this list will be suppressed from email marketing.
string ("list")
Resource type for list relationship. Must be ‘list’ when suppressing by list.
string
The ID of the segment whose profiles should be suppressed. All current members of this segment will be suppressed from email marketing.
string ("segment")
Resource type for segment relationship. Must be ‘segment’ when suppressing by segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Your Public API Key / Site ID. See this article for more details.
string ("push-token-unregister")
Type
string
A push token from APNS or FCM.
string ("apns" | "fcm")
The vendor of the push token.
string ("android" | "ios")
The platform on which the push token was created.
string
Primary key that uniquely identifies this profile. Generated by Klaviyo.
string ("profile")
Type
string
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.
string
Individual”s email address
string
URL pointing to the location of a profile image
string
Individual”s job title
string
First line of street address
string
Second line of street address
string
Latitude coordinate. We recommend providing a precision of four decimal places.
string
Time zone name. We recommend using time zones from the IANA Time Zone Database.
array
Remove a key or keys (and their values) completely from properties
string
Longitude coordinate. We recommend providing a precision of four decimal places.
string
Individual”s last name
string
Individual”s first name
string
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.
string
IP Address
string
Name of the company or organization within the company for whom the individual works
string
Id that can be used to identify a profile when other identifiers are not available
string
Zip code
string
Individual”s phone number in E.164 format
string
City name
string
Region within a country, such as state or province
string
Country name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("profile-subscription-bulk-delete-job")
Resource type. Must be ‘profile-subscription-bulk-delete-job’.
array
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’}}]
string
The ID of the Klaviyo list to unsubscribe the profiles from.
string ("list")
Resource type for the list relationship. Must be ‘list’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UNSUBSCRIBE_PROFILES_BULKSubmit a bulk unsubscription request for up to 100 email addresses and a Klaviyo list ID. A successful response indicates the job was accepted for asynchronous processing.

Input Parameters

array
required
Array of email addresses to unsubscribe. Maximum 100 profiles per request.
string
required
The ID of the Klaviyo list from which profiles should be unsubscribed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("profile-suppression-bulk-delete-job")
Resource type, must be ‘profile-suppression-bulk-delete-job’.
array
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.
string
The ID of the list whose members should be unsuppressed. When specified, all profiles in this list will have their USER_SUPPRESSED status removed.
string ("list")
Resource type for list relationship, must be ‘list’. Required when specifying a list ID.
string
The ID of the segment whose members should be unsuppressed. When specified, all profiles in this segment will have their USER_SUPPRESSED status removed.
string ("segment")
Resource type for segment relationship, must be ‘segment’. Required when specifying a segment ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UNSUPPRESS_PROFILES_BULKSubmit a bulk request to remove USER_SUPPRESSED email marketing suppressions from profiles identified by email address; other suppression reasons remain unchanged. Provide 1–100 email addresses. A 202 response indicates the request was accepted, but does not provide a job ID for monitoring completion.

Input Parameters

array
required
List of suppression objects containing email addresses to unsuppress. Maximum 100 profiles per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_CAMPAIGNUpdate a campaign’s settings, including its name, audiences, send options, tracking options, and send strategy; requires campaigns:write. Static send strategies also include default local-time settings when those options are omitted.

Input Parameters

string
The campaign name
string
required
The unique identifier of the campaign to update. Use GET /api/campaigns to list available campaigns.
object
Additional send options (advanced use)
string
Date to send on for Smart Send Time (YYYY-MM-DD format)
object
Tracking options for the campaign
array
List of list/segment IDs to exclude from audiences
array
List of list/segment IDs to include as audiences
integer ("10" | "11" | "13" | "14" | "17" | "20" | "25" | "33" | "50")
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’.
string ("static" | "throttled" | "immediate" | "smart_send_time")
Method for sending the campaign. Options: ‘static’ (scheduled time), ‘throttled’ (gradual sending), ‘immediate’ (send now), ‘smart_send_time’ (AI-optimized timing)
string
When to send the campaign (for static strategy)
string
When to start sending the campaign (for throttled strategy)
boolean
Whether to send in recipients’ local timezones
boolean
Whether to send immediately to recipients in past timezones. Only valid when static_is_local_timezone is True.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_CAMPAIGN_MESSAGEUpdate a campaign message

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:write

Input Parameters

string
required
The message ID to be retrieved
string
The message ID to be retrieved
string ("campaign-message")
Type
string
The label or name on the message
object
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
boolean
Add Org Prefix
boolean
Add Opt Out Language

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_CATALOG_CATEGORYUpdate a catalog category with the given category ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string
required
The catalog category ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.
string
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.
string ("catalog-category")
The resource type for the catalog category. Must be ‘catalog-category’.
string
The name of the catalog category.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the catalog category to update relationships for. Format: ‘$custom:::$default:::{external_id}’ (e.g., ‘$custom:::$default:::test-category-001’).
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSUpdate item relationships for the given category ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string
required
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
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_CATALOG_ITEMUpdate a catalog item with the given item ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string
required
The catalog item ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.
string
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.
string ("catalog-item")
The resource type. Must be ‘catalog-item’.
string
URL pointing to the location of the catalog item on your website.
number
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.
string
The title of the catalog item.
array
List of URLs pointing to the locations of images of the catalog item.
boolean
Boolean value indicating whether the catalog item is published.
string
A description of the catalog item.
string
URL pointing to the location of a full image of the catalog item.
array
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’).
string
URL pointing to the location of an image thumbnail of the catalog item

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESUpdate catalog category relationships for the given item ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string
required
The unique identifier of the catalog item in the format ‘$custom:::$default:::{external_id}’ (e.g., ‘$custom:::$default:::my-product-123’).
array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_CATALOG_VARIANTUpdate a catalog item variant with the given variant ID.

Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write

Input Parameters

string
required
The catalog variant ID is a compound ID (string), with format: {integration}:::{catalog}:::{external_id}. Currently, the only supported integration type is $custom, and the only supported catalog is $default.
string
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.
string ("catalog-variant")
Type
string
The SKU of the catalog item variant.
string
URL pointing to the location of the catalog item variant on your website.
number
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.
string
The title of the catalog item variant.
array
List of URLs pointing to the locations of images of the catalog item variant.
boolean
Boolean value indicating whether the catalog item variant is published.
string
A description of the catalog item variant.
string
URL pointing to the location of a full image of the catalog item variant.
integer
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.
number
The quantity of the catalog item variant currently in stock.
string
URL pointing to the location of an image thumbnail of the catalog item variant.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_COUPONUpdate an existing coupon’s description by coupon ID. The action declares coupons:read and coupons:write scopes.

Input Parameters

string
required
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’).
string
The coupon ID in the request body. Must match the ‘id’ path parameter.
string ("coupon")
The resource type. Must be ‘coupon’ for coupon objects.
string
The new description for the coupon. Can be used to add or update the coupon’s description text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_COUPON_CODEUpdates a coupon code specified by the given identifier synchronously. We allow updating the ‘status’ and ‘expires_at’ of coupon codes.

Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: coupon-codes:write

Input Parameters

string
required
The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
string
The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
string ("coupon-code")
The resource type. Must be ‘coupon-code’ for coupon code resources.
string ("ASSIGNED_TO_PROFILE" | "DELETING" | "PROCESSING" | "UNASSIGNED" | "USED" | "VERSION_NOT_ACTIVE")
The API status of our coupon codes.
string
The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the flow to update (e.g., ‘XVTP5Q’). This ID is used in the URL path.
string
The flow ID in the request body. If not provided, defaults to the ‘id’ path parameter value. Must match the path parameter ‘id’.
string ("flow")
Resource type for the request body. Must always be ‘flow’.
string ("draft" | "manual" | "live")
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_FORMUpdate a Klaviyo form’s name or replace its complete stored definition. Omitted attributes remain unchanged; live versions and lifecycle fields cannot be edited.

Input Parameters

string
required
The unique identifier of the draft Klaviyo form to update.
string
A replacement name for the form.
object
A complete encoded form definition that replaces the stored definition.
array
Sparse form fields to return for the updated form.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_IMAGEUpdate an image’s name or hidden status by image ID. Requires images:write scope; rate limits are 10/s burst and 150/m steady.

Input Parameters

string
required
The ID of the image
string
The ID of the image in the request body. Must match the ‘id’ path parameter.
string ("image")
Resource type for the request body. Must always be ‘image’.
string
A name for the image. Can contain Unicode characters and special characters.
boolean
If true, the image is hidden and not shown in the asset library. Defaults to false if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_LISTUpdate the name of a list with the given list ID.

Rate limits:
Burst: 10/s
Steady: 150/m Scopes: lists:write

Input Parameters

string
required
Primary key that uniquely identifies this list. Generated by Klaviyo.
string
Primary key that uniquely identifies this list. Generated by Klaviyo.
string ("list")
Type
string
A helpful name to label the list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_PROFILEUpdate a Klaviyo profile by ID with supplied attributes. Null-valued fields are omitted from the request; existing custom property keys can be removed using the unset operation. Requires profiles:write access

Input Parameters

string
required
Primary key that uniquely identifies this profile. Generated by Klaviyo.
string
Primary key that uniquely identifies this profile. Generated by Klaviyo.
string ("profile")
Resource type. Must be ‘profile’.
string
Individual’s email address
string
URL pointing to the location of a profile image
string
Individual’s job title
string
Individual’s last name
string
Individual’s first name
string
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.
string
IP Address
string
Name of the company or organization within the company for whom the individual works
string
Anonymous identifier for tracking profiles before they are identified with an email or external ID
string
Zip code
string
Individual’s phone number in E.164 format (e.g., +15005550006)
string
City name
string
Region within a country, such as state or province
string
Country name
string
First line of street address
string
Second line of street address
string
Latitude coordinate. We recommend providing a precision of four decimal places.
string
Time zone name. We recommend using time zones from the IANA Time Zone Database.
array
Remove a key or keys (and their values) completely from properties
string
Longitude coordinate. We recommend providing a precision of four decimal places.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_SEGMENTUpdate a segment with the given segment ID.

Rate limits:
Burst: 1/s
Steady: 15/m
Daily: 100/d Scopes: segments:write

Input Parameters

string
required
The unique identifier of the segment to update (e.g., ‘XTTNN5’). This is a required path parameter.
string
The ID of the segment being updated. Should match the path parameter ‘id’.
string ("segment")
The resource type. Must be ‘segment’ for segment updates.
string
The display name of the segment. Use this to rename the segment.
boolean
Whether the segment should be starred/favorited for quick access. Set to true to star or false to unstar.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The Tag ID
string
The Tag ID in the request body. Must match the ‘id’ path parameter.
string ("tag")
The resource type for the request body. Must be ‘tag’.
string
required
The new name for the tag. This is the only attribute that can be updated.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Rate limits:
Burst: 3/s
Steady: 60/m Scopes: tags:read tags:write

Input Parameters

string
required
The Tag Group ID
string
The Tag Group ID in the request body. Must match the ‘id’ path parameter.
string ("tag-group")
Resource type identifier. Must be ‘tag-group’. Defaults to ‘tag-group’ if not provided.
string
The new name for the tag group. This is the only attribute that can be modified after creation.
array
Optional list of fields to return in the response. If not specified, default fields are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the template to update. Used in the URL path.
string
The template ID in the request body. Must match the ‘id’ path parameter.
string ("template")
Resource type identifier. Must be ‘template’.
string
The new HTML content for the template. Only works with CODE editor type templates, not drag & drop templates.
string
The new name for the template. Optional - only include if updating the name.
string
The new plaintext version of the template. This is the fallback content for email clients that don’t support HTML.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPDATE_WEBHOOKUpdate the webhook with the given ID. The action declares webhooks:read and webhooks:write scopes; rate limits are burst 1/s and steady 15/m.

Input Parameters

string
required
The ID of the webhook.
string
The ID of the webhook.
string ("webhook")
Resource type identifier. Must be set to ‘webhook’ for webhook resources.
string
A name for the webhook.
boolean
Boolean flag to enable or disable the webhook. Set to true to enable the webhook to receive events, or false to disable it.
string
A description for the webhook.
string
A secret key, that will be used for webhook request signing.
string
A url to send webhook calls to. Must be https.
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Rate limits:
Burst: 3/s
Steady: 100/m
Daily: 100/d Scopes: images:write

Input Parameters

object
required
The image file to upload. Supported formats: jpeg, png, gif. Maximum file size: 5 MB.
string
A name for the image. If not provided, defaults to the filename.
boolean
If True, the image will not be shown in the asset library. Defaults to False.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KLAVIYO_UPLOAD_IMAGE_FROM_URLImport an image from a URL or data URI. Rate limits: 3/s burst, 100/m steady, and 100/d daily; the tool declares the images:read scope.

Input Parameters

string ("image")
Resource type for the request. Must be ‘image’.
string
A name for the image. Defaults to the filename if not provided. If the name matches an existing image, a suffix will be added.
boolean
If true, this image is not shown in the asset library.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not