Klaviyo

Your Toolhouse AI Worker can connect to Klaviyo using 225 specialized tools.

Auth Connection

This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under Auth Connections.

Tools (225)

`Klaviyo Add Profile To List`

Integration name: KLAVIYO_ADD_PROFILE_TO_LIST

Add profiles to a Klaviyo list by profile IDs or email addresses. This action subscribes profiles to a marketing list, which is ideal for giving marketing consent. You can add up to 1000 profiles per call using either their Klaviyo profile IDs or email addresses. Rate limits: 10/s burst, 150/m steady. Required scopes: lists:write and profiles:write. Preconditions: - Either profile_ids or emails must be provided (not both) - Maximum 1000 profiles per call - Email addresses must be valid format - The list must exist and be accessible

Parameters

Parameter

Type

Required

Example

Description

emails

array

["user1@example.com","user2@example.com"]

List of email addresses to add to the list (alternative to profile_ids)

list_id

string

✅

"QRXm9k"

The ID of the list to add profiles to

profile_ids

array

["01HS3XYN7G7XS49CA9VR8TV123","01J4PBK0HYDM23RCPV9JFRHE2Y"]

List of profile IDs to add to the list (max 1000 per call)

`Klaviyo Assign Campaign Message Template`

Integration name: KLAVIYO_ASSIGN_CAMPAIGN_MESSAGE_TEMPLATE

Creates a non-reusable version of the template and assigns it to the message. Rate limits: Burst: 10/s Steady: 150/m Scopes: campaigns:write

Parameters

Parameter

Type

Required

Example

Description

data__id

string

✅

—

The unique identifier of the campaign message to assign the template to. Obtained from campaign creation or get campaign messages endpoints.

data__type

string

—

Resource type for the campaign message. Must be 'campaign-message'.

data__relationships__template__data__id

string

✅

—

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.

data__relationships__template__data__type

string

—

Resource type for the template. Must be 'template'.

`Klaviyo Bulk Create Client Events`

Integration name: KLAVIYO_BULK_CREATE_CLIENT_EVENTS

Use the client-side endpoint with a public API key to track profile activity. It accepts up to 1000 events/request with rates of 10/s burst and 150/m steady. For server-side, use the bulk create event endpoint.

Parameters

Parameter

Type

Required

Example

Description

company_id

string

✅

—

Your Public API Key / Site ID. See this article for more details.

data__type

string

—

Type

data__attributes__events__data

array

—

Data

data__attributes__profile__data__id

string

—

Primary key that uniquely identifies this profile. Generated by Klaviyo.

data__attributes__profile__data__type

string

—

Type

data__attributes__profile__data__attributes____kx

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.

data__attributes__profile__data__attributes__email

string

—

Individual"s email address

data__attributes__profile__data__attributes__image

string

—

URL pointing to the location of a profile image

data__attributes__profile__data__attributes__title

string

—

Individual"s job title

data__attrs__profile__data__attrs__location__address1

string

—

First line of street address

data__attrs__profile__data__attrs__location__address2

string

—

Second line of street address

data__attrs__profile__data__attrs__location__latitude

string

—

Latitude coordinate. We recommend providing a precision of four decimal places.

data__attrs__profile__data__attrs__location__timezone

string

—

Time zone name. We recommend using time zones from the IANA Time Zone Database.

data__attrs__profile__data__meta__patch__props__unset

array

—

Remove a key or keys (and their values) completely from properties

data__attrs__profile__data__attrs__location__longitude

string

—

Longitude coordinate. We recommend providing a precision of four decimal places.

data__attributes__profile__data__attributes__last__name

string

—

Individual"s last name

data__attributes__profile__data__attributes__first__name

string

—

Individual"s first name

data__attributes__profile__data__attributes__external__id

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.

data__attributes__profile__data__attributes__location__ip

string

—

IP Address

data__attributes__profile__data__attributes__organization

string

—

Name of the company or organization within the company for whom the individual works

data__attributes__profile__data__attributes__anonymous__id

string

—

Anonymous Id

data__attributes__profile__data__attributes__location__zip

string

—

Zip code

data__attributes__profile__data__attributes__phone__number

string

—

Individual"s phone number in E.164 format

data__attributes__profile__data__attributes__location__city

string

—

City name

data__attributes__profile__data__attributes__location__region

string

—

Region within a country, such as state or province

data__attributes__profile__data__attributes__location__country

string

—

Country name

`Klaviyo Bulk Create Events`

Integration name: KLAVIYO_BULK_CREATE_EVENTS

Bulk 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.

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Resource type identifier. Must be 'event-bulk-create-job'.

data__attributes__events__bulk__create__data

array

✅

—

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"}}}]}}}]

`Klaviyo Cancel Campaign Send`

Integration name: KLAVIYO_CANCEL_CAMPAIGN_SEND

Cancel 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)

Parameters

Parameter

Type

Required

Example

Description

action

string

—

The action to perform. 'cancel' permanently cancels the campaign (status becomes CANCELED, irreversible). 'revert' returns the campaign to DRAFT status for further editing.

campaign_send_job_id

string

✅

"01KFTA19C27H8M8CVX876YPT2T"

The unique identifier of the campaign send job to cancel or revert. This is the ID returned when creating a campaign send job.

`Klaviyo Create Back In Stock Subscription`

Integration name: KLAVIYO_CREATE_BACK_IN_STOCK_SUBSCRIPTION

Use 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.

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__channels

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).

data__attributes__profile__data__id

string

—

Primary key that uniquely identifies this profile. Generated by Klaviyo.

data__attributes__profile__data__type

string

—

Type

data__relationships__variant__data__id

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

data__relationships__variant__data__type

string

—

Type

data__attributes__profile__data__attributes__email

string

—

Individual"s email address

data__attributes__profile__data__attributes__external__id

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.

data__attributes__profile__data__attributes__anonymous__id

string

—

Anonymous Id

data__attributes__profile__data__attributes__phone__number

string

—

Individual"s phone number in E.164 format

`Klaviyo Create Campaign`

Integration name: KLAVIYO_CREATE_CAMPAIGN

Creates a campaign given a set of parameters, then returns it. Rate limits: Burst: 10/s Steady: 150/m Scopes: campaigns:write

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__name

string

—

The campaign name

data__attributes__send__options

object

—

Options to use when sending a campaign

data__attributes__tracking__options

object

—

The tracking options associated with the campaign

data__attributes__audiences__excluded

array

—

An optional list of excluded audiences

data__attributes__audiences__included

array

—

A list of included audiences

data__attributes__send__strategy__method

string

—

Describes the shape of the options object. Allowed values: ["static", "throttled", "immediate", "smart_send_time"]

data__attributes__campaign__messages__data

array

—

Data

data__attributes__send__strategy__options__sto__date

string

—

The day to send on

data__attrs__send__strategy__options__throttled__datetime

string

—

The time to send at

data__attributes__send__strategy__options__static__datetime

string

—

The time to send at

data__attributes__send__strategy__options__static__is__local

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.

data__attrs__send__strategy__options__static__past__recipients

boolean

—

Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends. Defaults to False.

data__attrs__send__strategy__options__throttled__throttle__pct

integer

—

The percentage of recipients per hour to send to. Allowed values: [10, 11, 13, 14, 17, 20, 25, 33, 50]

`Klaviyo Create Campaign Clone`

Integration name: KLAVIYO_CREATE_CAMPAIGN_CLONE

Clones an existing campaign, returning a new campaign based on the original with a new ID and name. Rate limits: Burst: 10/s Steady: 150/m Scopes: campaigns:write

Parameters

Parameter

Type

Required

Example

Description

data__id

string

—

The campaign ID to be cloned

data__type

string

—

Type

data__attributes__new__name

string

—

The name for the new cloned campaign

`Klaviyo Create Campaign Recipient Estimation Job`

Integration name: KLAVIYO_CREATE_CAMPAIGN_RECIPIENT_ESTIMATION_JOB

Start 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

Parameters

Parameter

Type

Required

Example

Description

campaign_id

string

✅

"01GDDKASAP8TKDDA2GRZDSVP4H"

The ID of the campaign to perform recipient estimation for

`Klaviyo Create Campaign Send Job`

Integration name: KLAVIYO_CREATE_CAMPAIGN_SEND_JOB

Trigger a campaign to send asynchronously Rate limits: Burst: 10/s Steady: 150/m Scopes: campaigns:write

Parameters

Parameter

Type

Required

Example

Description

data__id

string

✅

—

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.

data__type

string

—

Resource type identifier. Must be 'campaign-send-job'.

`Klaviyo Create Catalog Category`

Integration name: KLAVIYO_CREATE_CATALOG_CATEGORY

Create a new catalog category. Rate limits: Burst: 75/s Steady: 700/m Scopes: catalogs:write

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__name

string

—

The name of the catalog category.

data__attributes__external__id

string

—

The ID of the catalog category in an external system.

data__attributes__catalog__type

string

—

The type of catalog. Currently only "$default" is supported.

data__relationships__items__data

array

—

Data

data__attributes__integration__type

string

—

The integration type. Currently only "$custom" is supported.

`Klaviyo Create Catalog Category Relationships Items`

Integration name: KLAVIYO_CREATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMS

Create a new item relationship for the given category ID. Rate limits: Burst: 75/s Steady: 700/m Scopes: catalogs:write

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

The ID of the catalog category. Must be URL-encoded for the API request.

data

array

✅

—

List of catalog item resource identifiers to add to the category. Each item should have 'type': 'catalog-item' and 'id': ''.

`Klaviyo Create Catalog Item`

Integration name: KLAVIYO_CREATE_CATALOG_ITEM

Create a new catalog item. Rate limits: Burst: 75/s Steady: 700/m Scopes: catalogs:write

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__url

string

—

URL pointing to the location of the catalog item on your website.

data__attributes__price

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.

data__attributes__title

string

—

The title of the catalog item.

data__attributes__images

array

—

List of URLs pointing to the locations of images of the catalog item.

data__attributes__published

boolean

—

Boolean value indicating whether the catalog item is published.

data__attributes__description

string

—

A description of the catalog item.

data__attributes__external__id

string

—

The ID of the catalog item in an external system.

data__attributes__catalog__type

string

—

The type of catalog. Currently only "$default" is supported.

data__attributes__image__full__url

string

—

URL pointing to the location of a full image of the catalog item.

data__attributes__integration__type

string

—

The integration type. Currently only "$custom" is supported.

data__relationships__categories__data

array

—

Data

data__attributes__image__thumbnail__url

string

—

URL pointing to the location of an image thumbnail of the catalog item

`Klaviyo Create Catalog Item Relationships Categories`

Integration name: KLAVIYO_CREATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIES

Create a new catalog category relationship for the given item ID. Rate limits: Burst: 75/s Steady: 700/m Scopes: catalogs:write

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

The ID of the catalog item (e.g., '$custom:::$default:::my-item-id'). Will be automatically URL-encoded for the API request.

data

array

✅

—

List of catalog category resource identifiers to add to the item. Each entry should have 'type': 'catalog-category' and 'id': '' (e.g., '$custom:::$default:::my-category').

`Klaviyo Create Catalog Variant`

Integration name: KLAVIYO_CREATE_CATALOG_VARIANT

Create a new variant for a related catalog item. Rate limits: Burst: 75/s Steady: 700/m Scopes: catalogs:write

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__sku

string

—

The SKU of the catalog item variant.

data__attributes__url

string

—

URL pointing to the location of the catalog item variant on your website.

data__attributes__price

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.

data__attributes__title

string

—

The title of the catalog item variant.

data__attributes__images

array

—

List of URLs pointing to the locations of images of the catalog item variant.

data__attributes__published

boolean

—

Boolean value indicating whether the catalog item variant is published.

data__attributes__description

string

—

A description of the catalog item variant.

data__attributes__external__id

string

—

The ID of the catalog item variant in an external system.

data__attributes__catalog__type

string

—

The type of catalog. Currently only "$default" is supported.

data__attributes__image__full__url

string

—

URL pointing to the location of a full image of the catalog item variant.

data__attributes__integration__type

string

—

The integration type. Currently only "$custom" is supported.

data__attributes__inventory__policy

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.

data__relationships__item__data__id

string

—

The original catalog item ID for which this is a variant.

data__attributes__inventory__quantity

number

—

The quantity of the catalog item variant currently in stock.

data__relationships__item__data__type

string

—

Type

data__attributes__image__thumbnail__url

string

—

URL pointing to the location of an image thumbnail of the catalog item variant.

`Klaviyo Create Client Back In Stock Subscription`

Integration name: KLAVIYO_CREATE_CLIENT_BACK_IN_STOCK_SUBSCRIPTION

Use 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.

Parameters

Parameter

Type

Required

Example

Description

company_id

string

✅

—

Your Public API Key / Site ID. See this article for more details.

data__type

string

—

Type

data__attributes__channels

array

—

data__attributes__profile__data__id

string

—

Primary key that uniquely identifies this profile. Generated by Klaviyo.

data__attributes__profile__data__type

string

—

Type

data__relationships__variant__data__id

string

—

data__relationships__variant__data__type

string

—

Type

data__attributes__profile__data__attributes__email

string

—

Individual"s email address

data__attributes__profile__data__attributes__external__id

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.

data__attributes__profile__data__attributes__anonymous__id

string

—

Anonymous Id

data__attributes__profile__data__attributes__phone__number

string

—

Individual"s phone number in E.164 format

`Klaviyo Create Client Event2`

Integration name: KLAVIYO_CREATE_CLIENT_EVENT2

Create 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.

Parameters

Parameter

Type

Required

Example

Description

ip

string

"192.168.1.1"

IP address

city

string

"New York"

City name

image

string

"https://example.com/image.jpg"

URL to profile image

title

string

"Software Engineer"

Profile's job title

region

string

"NY"

Region/state

country

string

"United States"

Country name

address1

string

"123 Main St"

First line of street address

address2

string

"Apt 4B"

Second line of street address

latitude

string

"40.7128"

Latitude coordinate

timezone

string

"America/New_York"

Timezone

zip_code

string

"10001"

Zip code

last_name

string

"Doe"

Profile's last name

longitude

string

"-74.0060"

Longitude coordinate

unique_id

string

—

Unique identifier for the event to prevent duplicates

company_id

string

✅

"UmABLy"

Your Public API Key / Site ID for client-side tracking. This appears in both the event attributes and profile attributes.

event_time

string

—

When the event occurred. Defaults to current time if not provided.

first_name

string

"John"

Profile's first name

properties

object

{"category":"electronics","product_id":"123"}

Custom properties for the event

event_value

number

29.99

Monetary value associated with the event (e.g., purchase amount)

metric_name

string

✅

"Viewed Product"

Name of the event metric. Must be less than 128 characters.

organization

string

"Example Corp"

Profile's organization

profile_email

string

"user@example.com"

Email address of the profile to associate with the event

value_currency

string

"USD"

Currency code for the event value (ISO 4217)

profile_properties

object

{"favorite_color":"blue"}

Custom properties to update on the profile

profile_external_id

string

"customer_123"

External ID of the profile

profile_anonymous_id

string

—

Anonymous ID of the profile

profile_phone_number

string

"+1234567890"

Phone number of the profile in E.164 format

`Klaviyo Create Client Subscription`

Integration name: KLAVIYO_CREATE_CLIENT_SUBSCRIPTION

Endpoint 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'.

Parameters

Parameter

Type

Required

Example

Description

company_id

string

✅

—

Your Public API Key / Site ID. See this article for more details.

data__type

string

—

Type

data__attributes__custom__source

string

—

A custom method detail or source to store on the consent records for this subscription.

data__attributes__profile__data__id

string

—

Primary key that uniquely identifies this profile. Generated by Klaviyo.

data__relationships__list__data__id

string

—

The list ID to add the newly subscribed profile to.

data__attributes__profile__data__type

string

—

Type

data__relationships__list__data__type

string

—

Type

data__attributes__profile__data__attributes____kx

string

—

data__attributes__profile__data__attributes__email

string

—

Individual"s email address

data__attributes__profile__data__attributes__image

string

—

URL pointing to the location of a profile image

data__attributes__profile__data__attributes__title

string

—

Individual"s job title

data__attrs__profile__data__attrs__location__address1

string

—

First line of street address

data__attrs__profile__data__attrs__location__address2

string

—

Second line of street address

data__attrs__profile__data__attrs__location__latitude

string

—

Latitude coordinate. We recommend providing a precision of four decimal places.

data__attrs__profile__data__attrs__location__timezone

string

—

Time zone name. We recommend using time zones from the IANA Time Zone Database.

data__attrs__profile__data__meta__patch__props__unset

array

—

Remove a key or keys (and their values) completely from properties

data__attrs__profile__data__attrs__location__longitude

string

—

Longitude coordinate. We recommend providing a precision of four decimal places.

data__attributes__profile__data__attributes__last__name

string

—

Individual"s last name

data__attributes__profile__data__attributes__first__name

string

—

Individual"s first name

data__attributes__profile__data__attributes__external__id

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.

data__attributes__profile__data__attributes__location__ip

string

—

IP Address

data__attributes__profile__data__attributes__organization

string

—

Name of the company or organization within the company for whom the individual works

data__attributes__profile__data__attributes__anonymous__id

string

—

Id that can be used to identify a profile when other identifiers are not available

data__attributes__profile__data__attributes__location__zip

string

—

Zip code

data__attributes__profile__data__attributes__phone__number

string

—

Individual"s phone number in E.164 format

data__attributes__profile__data__attributes__location__city

string

—

City name

data__attributes__profile__data__attributes__location__region

string

—

Region within a country, such as state or province

data__attributes__profile__data__attributes__location__country

string

—

Country name

`Klaviyo Create Coupon`

Integration name: KLAVIYO_CREATE_COUPON

Creates a new coupon. Rate limits: Burst: 3/s Steady: 60/m Scopes: coupons:write

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__description

string

—

A description of the coupon.

data__attributes__external__id

string

—

This is the id that is stored in an integration such as Shopify or Magento.

`Klaviyo Create Coupon Code`

Integration name: KLAVIYO_CREATE_COUPON_CODE

Synchronously creates a coupon code for the given coupon. Rate limits: Burst: 350/s Steady: 3500/m Scopes: coupon-codes:write

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__expires__at

string

—

The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.

data__attributes__unique__code

string

—

This is a unique string that will be or is assigned to each customer/profile and is associated with a coupon.

data__relationships__coupon__data__id

string

—

data__relationships__coupon__data__type

string

—

Type

`Klaviyo Create Event`

Integration name: KLAVIYO_CREATE_EVENT

Create 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.

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__time

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.

data__attributes__value

integer

—

A numeric, monetary value to associate with this event. For example, the dollar amount of a purchase.

data__attributes__properties

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.

data__attributes__unique__id

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.

data__attributes__value__currency

string

—

The ISO 4217 currency code of the value associated with the event.

data__attributes__profile__data__id

string

—

Primary key that uniquely identifies this profile. Generated by Klaviyo.

data__attributes__metric__data__type

string

—

Type

data__attributes__profile__data__type

string

—

Type

data__attributes__metric__data__attributes__name

string

—

Name of the event. Must be less than 128 characters.

data__attributes__profile__data__attributes____kx

string

—

data__attributes__profile__data__attributes__email

string

—

Individual"s email address

data__attributes__profile__data__attributes__image

string

—

URL pointing to the location of a profile image

data__attributes__profile__data__attributes__title

string

—

Individual"s job title

data__attributes__metric__data__attributes__service

string

—

This is for advanced usage. For api requests, this should use the default, which is set to api.

data__attrs__profile__data__attrs__location__address1

string

—

First line of street address

data__attrs__profile__data__attrs__location__address2

string

—

Second line of street address

data__attrs__profile__data__attrs__location__latitude

string

—

Latitude coordinate. We recommend providing a precision of four decimal places.

data__attrs__profile__data__attrs__location__timezone

string

—

Time zone name. We recommend using time zones from the IANA Time Zone Database.

data__attrs__profile__data__attrs__location__longitude

string

—

Longitude coordinate. We recommend providing a precision of four decimal places.

data__attributes__profile__data__attributes__last__name

string

—

Individual"s last name

data__attributes__profile__data__attributes__first__name

string

—

Individual"s first name

data__attributes__profile__data__attributes__external__id

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.

data__attributes__profile__data__attributes__location__ip

string

—

IP Address

data__attributes__profile__data__attributes__organization

string

—

Name of the company or organization within the company for whom the individual works

data__attributes__profile__data__attributes__anonymous__id

string

—

Anonymous Id

data__attributes__profile__data__attributes__location__zip

string

—

Zip code

data__attributes__profile__data__attributes__phone__number

string

—

Individual"s phone number in E.164 format

data__attributes__profile__data__attributes__location__city

string

—

City name

data__attrs__profile__data__attrs__meta__patch__props__unset

array

—

Remove a key or keys (and their values) completely from properties

data__attributes__profile__data__attributes__location__region

string

—

Region within a country, such as state or province

data__attributes__profile__data__attributes__location__country

string

—

Country name

`Klaviyo Create List`

Integration name: KLAVIYO_CREATE_LIST

Create a new list. Rate limits: Burst: 10/s Steady: 150/m Daily: 100/d Scopes: lists:write

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__name

string

—

A helpful name to label the list

`Klaviyo Create Or Update Client Profile`

Integration name: KLAVIYO_CREATE_OR_UPDATE_CLIENT_PROFILE

Update 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.

Parameters

Parameter

Type

Required

Example

Description

data__id

string

—

Primary key that uniquely identifies this profile. Generated by Klaviyo.

company_id

string

✅

—

Your Public API Key / Site ID. See this article for more details.

data__type

string

—

Type

data__attributes____kx

string

—

data__attributes__email

string

—

Individual"s email address

data__attributes__image

string

—

URL pointing to the location of a profile image

data__attributes__title

string

—

Individual"s job title

data__attributes__last__name

string

—

Individual"s last name

data__attributes__first__name

string

—

Individual"s first name

data__attributes__external__id

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.

data__attributes__location__ip

string

—

IP Address

data__attributes__organization

string

—

Name of the company or organization within the company for whom the individual works

data__attributes__anonymous__id

string

—

Anonymous Id

data__attributes__location__zip

string

—

Zip code

data__attributes__phone__number

string

—

Individual"s phone number in E.164 format

data__attributes__location__city

string

—

City name

data__attributes__location__region

string

—

Region within a country, such as state or province

data__attributes__location__country

string

—

Country name

data__attributes__location__address1

string

—

First line of street address

data__attributes__location__address2

string

—

Second line of street address

data__attributes__location__latitude

string

—

Latitude coordinate. We recommend providing a precision of four decimal places.

data__attributes__location__timezone

string

—

Time zone name. We recommend using time zones from the IANA Time Zone Database.

data__meta__patch__properties__unset

array

—

Remove a key or keys (and their values) completely from properties

data__attributes__location__longitude

string

—

Longitude coordinate. We recommend providing a precision of four decimal places.

`Klaviyo Create Or Update Push Token`

Integration name: KLAVIYO_CREATE_OR_UPDATE_PUSH_TOKEN

Create 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

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Resource type. Must be 'push-token'.

data__attributes__token

string

—

A push token from APNS or FCM.

data__attributes__vendor

string

—

The push notification vendor. Use 'apns' for iOS (Apple Push Notification Service) or 'fcm' for Android (Firebase Cloud Messaging).

profile_meta_patch_unset

array

—

Remove a key or keys (and their values) completely from properties

data__attributes__platform

string

—

The mobile platform. Use 'ios' for Apple devices or 'android' for Android devices.

data__attributes__background

string

—

The background state of the push token.

data__attributes__profile__data__id

string

—

Primary key that uniquely identifies this profile. Generated by Klaviyo.

data__attributes__enablement__status

string

—

This is the enablement status for the individual push token.

data__attributes__profile__data__type

string

—

Profile resource type. Must be 'profile'.

data__attributes__device__metadata__app__id

string

—

The ID of the app that created the push token

data__attributes__device__metadata__os__name

string

—

The name of the operating system on the device.

data__attributes__device__metadata__app__name

string

—

The name of the app that created the push token

data__attributes__device__metadata__app__build

string

—

The build of the app that created the push token

data__attributes__device__metadata__device__id

string

—

Relatively stable ID for the device. Will update on app uninstall and reinstall

data__attributes__device__metadata__environment

string

—

The environment in which the push token was created

data__attributes__device__metadata__os__version

string

—

The version of the operating system on the device

data__attributes__device__metadata__app__version

string

—

The version of the app that created the push token

data__attributes__device__metadata__klaviyo__sdk

string

—

The name of the SDK used to create the push token.

data__attributes__device__metadata__manufacturer

string

—

The manufacturer of the device

data__attributes__device__metadata__sdk__version

string

—

The version of the SDK used to create the push token

data__attributes__device__metadata__device__model

string

—

The model of the device

data__attributes__profile__data__attributes____kx

string

—

data__attributes__profile__data__attributes__email

string

—

Individual"s email address

data__attributes__profile__data__attributes__image

string

—

URL pointing to the location of a profile image

data__attributes__profile__data__attributes__title

string

—

Individual"s job title

data__attrs__profile__data__attrs__location__address1

string

—

First line of street address

data__attrs__profile__data__attrs__location__address2

string

—

Second line of street address

data__attrs__profile__data__attrs__location__latitude

string

—

Latitude coordinate. We recommend providing a precision of four decimal places.

data__attrs__profile__data__attrs__location__timezone

string

—

Time zone name. We recommend using time zones from the IANA Time Zone Database.

data__attrs__profile__data__attrs__location__longitude

string

—

Longitude coordinate. We recommend providing a precision of four decimal places.

data__attributes__profile__data__attributes__last__name

string

—

Individual"s last name

data__attributes__profile__data__attributes__first__name

string

—

Individual"s first name

data__attributes__profile__data__attributes__external__id

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.

data__attributes__profile__data__attributes__location__ip

string

—

IP Address

data__attributes__profile__data__attributes__organization

string

—

Name of the company or organization within the company for whom the individual works

data__attributes__profile__data__attributes__anonymous__id

string

—

Id that can be used to identify a profile when other identifiers are not available

data__attributes__profile__data__attributes__location__zip

string

—

Zip code

data__attributes__profile__data__attributes__phone__number

string

—

Individual"s phone number in E.164 format

data__attributes__profile__data__attributes__location__city

string

—

City name

data__attributes__profile__data__attributes__location__region

string

—

Region within a country, such as state or province

data__attributes__profile__data__attributes__location__country

string

—

Country name

`Klaviyo Create Profile`

Integration name: KLAVIYO_CREATE_PROFILE

Create a new profile. Rate limits: Burst: 75/s Steady: 700/m Scopes: profiles:write

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__email

string

—

Individual"s email address

data__attributes__image

string

—

URL pointing to the location of a profile image

data__attributes__title

string

—

Individual"s job title

data__attributes__last__name

string

—

Individual"s last name

data__attributes__first__name

string

—

Individual"s first name

data__attributes__external__id

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.

data__attributes__location__ip

string

—

IP Address

data__attributes__organization

string

—

Name of the company or organization within the company for whom the individual works

data__attributes__location__zip

string

—

Zip code

data__attributes__phone__number

string

—

Individual"s phone number in E.164 format

data__attributes__location__city

string

—

City name

data__attributes__location__region

string

—

Region within a country, such as state or province

data__attributes__location__country

string

—

Country name

data__attributes__location__address1

string

—

First line of street address

data__attributes__location__address2

string

—

Second line of street address

data__attributes__location__latitude

string

—

Latitude coordinate. We recommend providing a precision of four decimal places.

data__attributes__location__timezone

string

—

Time zone name. We recommend using time zones from the IANA Time Zone Database.

data__attributes__location__longitude

string

—

Longitude coordinate. We recommend providing a precision of four decimal places.

`Klaviyo Create Segment`

Integration name: KLAVIYO_CREATE_SEGMENT

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

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__name

string

—

Name

data__attributes__is__starred

boolean

—

Is Starred

data__attributes__definition__condition__groups

array

—

Condition Groups

`Klaviyo Create Tag`

Integration name: KLAVIYO_CREATE_TAG

Summary: Instructions on creating a tag within an account's designated tag group with a maximum of 500 tags, with optional tag group specification. Rate limits are 3/s burst and 60/min steady. Tag: #TagCreationLimitAndRate

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__name

string

—

The Tag name

data__relationships__tag__group__data__id

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.

data__relationships__tag__group__data__type

string

—

Type

Integration name: KLAVIYO_CREATE_TAG_GROUP

Create 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.

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__name

string

—

The Tag Group name

data__attributes__exclusive

boolean

—

Exclusive

`Klaviyo Create Tag Relationships`

Integration name: KLAVIYO_CREATE_TAG_RELATIONSHIPS

Associate 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).

Parameters

Parameter

Type

Required

Example

Description

data

array

✅

[{"id":"QRXm9k","type":"list"}]

List of resource identifiers to associate with the tag. Each item must have 'type' and 'id' fields.

tag_id

string

✅

"3ff51536-c269-461e-bd7e-70b467d3624f"

The unique identifier (UUID) of the tag to associate with resources

related_resource

string

✅

"lists"

The type of resource to associate the tag with (flows, lists, segments, or campaigns)

`Klaviyo Create Template`

Integration name: KLAVIYO_CREATE_TEMPLATE

Summary: Custom HTML templates can be created unless an account reaches 1,000 template limit. Use sparse fieldsets to request specific fields. Rate limits are 10 per second and 150 per minute. Requires 'templates:write' scope.

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__html

string

—

The HTML contents of the template

data__attributes__name

string

—

The name of the template

data__attributes__text

string

—

The plaintext version of the template

data__attributes__editor__type

string

—

Restricted to CODE

`Klaviyo Create Template Clone`

Integration name: KLAVIYO_CREATE_TEMPLATE_CLONE

Clone 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.

Parameters

Parameter

Type

Required

Example

Description

data__id

string

—

The ID of template to be cloned

data__type

string

—

Type

data__attributes__name

string

—

The name of the template

`Klaviyo Create Template Render`

Integration name: KLAVIYO_CREATE_TEMPLATE_RENDER

Render an email template with specific context and sparse fieldsets, then get HTML/plain text. Rate limit: 3/s burst, 60/m steady. Scope: templates:read.

Parameters

Parameter

Type

Required

Example

Description

data__id

string

—

The ID of template

data__type

string

—

Type

data__attributes__context

object

—

The context (key-value pairs) to render the template with. Keys should match template variable names.

`Klaviyo Create Webhook`

Integration name: KLAVIYO_CREATE_WEBHOOK

Create a new Webhook to receive real-time notifications when specific events occur in Klaviyo (e.g., email clicks, SMS sent). Rate limits: Burst: 1/s, Steady: 15/m Required scopes: webhooks:write, events:read (for event-based topics) Note: Each Klaviyo account can have a maximum of 10 webhooks.

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

The resource type for the webhook. Must be 'webhook'.

data__attributes__name

string

—

A name for the webhook.

data__attributes__description

string

—

A description for the webhook.

data__attributes__secret__key

string

Parameter

Type

Required

Example

Description

id

string

✅

—

The Tag ID

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Accounts`

Integration name: KLAVIYO_GET_ACCOUNTS

Use 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.

Parameter

Type

Required

Example

Description

job_id

string

✅

—

ID of the job to retrieve.

include

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships

fields__list

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

fields__profile__bulk__import__job

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Bulk Profile Import Job Errors`

Integration name: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_ERRORS

Get import errors for the bulk profile import job with the given ID. Rate limits: Burst: 10/s Steady: 150/m Scopes: profiles:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

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.

page__size

integer

—

Default: 20. Min: 1. Max: 100.

page__cursor

string

—

Cursor for pagination. Use the value from the 'next' or 'prev' link in the response to fetch additional pages of errors.

fields__import__error

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.

`Klaviyo Get Bulk Profile Import Job Lists`

Integration name: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_LISTS

Get list for the bulk profile import job with the given ID. Rate limits: Burst: 10/s Steady: 150/m Scopes: lists:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

fields__list

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Bulk Profile Import Job Profiles`

Integration name: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_PROFILES

Get profiles for the bulk profile import job with the given ID. Rate limits: Burst: 10/s Steady: 150/m Scopes: profiles:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

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.

page__size

integer

—

Default: 20. Min: 1. Max: 100.

page__cursor

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

fields__profile

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

additional__fields__profile

array

—

Request additional fields not included by default in the response. Supported values: "subscriptions", "predictive_analytics"

`Klaviyo Get Bulk Profile Import Job Relationships Lists`

Integration name: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_LISTS

Get list relationship for the bulk profile import job with the given ID. Rate limits: Burst: 10/s Steady: 150/m Scopes: lists:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

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.

`Klaviyo Get Bulk Profile Import Job Relationships Profiles`

Integration name: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_PROFILES

Get profile relationships for the bulk profile import job with the given ID. Rate limits: Burst: 10/s Steady: 150/m Scopes: profiles:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

page__size

integer

—

Default: 20. Min: 1. Max: 100.

page__cursor

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

`Klaviyo Get Bulk Profile Import Jobs`

Integration name: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOBS

Get all bulk profile import jobs. Returns a maximum of 100 jobs per request. Rate limits: Burst: 10/s Steady: 150/m Scopes: lists:read profiles:read

Parameters

Parameter

Type

Required

Example

Description

sort

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting

filter

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

page__size

integer

—

Default: 20. Min: 1. Max: 100.

page__cursor

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

fields__profile__bulk__import__job

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Bulk Update Catalog Items Job`

Integration name: KLAVIYO_GET_BULK_UPDATE_CATALOG_ITEMS_JOB

Get 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.

Parameters

Parameter

Type

Required

Example

Description

job_id

string

✅

—

ID of the job to retrieve.

include

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.

fields__catalog__item

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.

fields__catalog__item__bulk__update__job

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.

`Klaviyo Get Bulk Update Categories Job`

Integration name: KLAVIYO_GET_BULK_UPDATE_CATEGORIES_JOB

Retrieve 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

Parameters

Parameter

Type

Required

Example

Description

job_id

string

✅

"01KHENY78Y4RKXCP7WC1DWBVG3"

The unique identifier for the bulk update categories job

include_categories

boolean

—

Whether to include related category data in the response

`Klaviyo Get Bulk Update Variants Job`

Integration name: KLAVIYO_GET_BULK_UPDATE_VARIANTS_JOB

Tool 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.

Parameters

Parameter

Type

Required

Example

Description

job_id

string

✅

"01KHENWQ890549M8B5905PWKE0"

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.

include

string

—

Options for including related resources in the response.

`Klaviyo Get Campaign`

Integration name: KLAVIYO_GET_CAMPAIGN

Retrieve 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

Parameters

Parameter

Type

Required

Example

Description

campaign_id

string

✅

"01GDDKASAP8TKDDA2GRZDSVP4H"

The campaign ID to retrieve

include_tags

boolean

—

Whether to include tags in the response

include_messages

boolean

—

Whether to include campaign messages in the response

`Klaviyo Get Campaign Campaign Messages`

Integration name: KLAVIYO_GET_CAMPAIGN_CAMPAIGN_MESSAGES

Return all messages that belong to the given campaign. Rate limits: Burst: 10/s Steady: 150/m Scopes: campaigns:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

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

include

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships

fields__campaign

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

fields__template

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

fields__campaign__message

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Campaign Message`

Integration name: KLAVIYO_GET_CAMPAIGN_MESSAGE

Returns a specific message based on a required id. Rate limits: Burst: 10/s Steady: 150/m Scopes: campaigns:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

The message ID to be retrieved

include

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships

fields__campaign

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

fields__template

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

fields__campaign__message

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.

`Klaviyo Get Campaign Message Campaign`

Integration name: KLAVIYO_GET_CAMPAIGN_MESSAGE_CAMPAIGN

Return the related campaign Rate limits: Burst: 10/s Steady: 150/m Scopes: campaigns:read

Parameters

Parameter

Type

Required

Example

Parameter

Type

Required

Example

Description

id

string

✅

—

The unique identifier of the campaign message. Example: '01KFGQQNRE7Z9FZ0AAQ3TQAKYZ'.

fields__template

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.

`Klaviyo Get Campaign Recipient Estimation`

Integration name: KLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATION

Get 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.

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

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

fields__campaign__recipient__estimation

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Campaign Recipient Estimation Job`

Integration name: KLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATION_JOB

Retrieve the status of a recipient estimation job triggered with the Create Campaign Recipient Estimation Job endpoint. Rate limits: Burst: 10/s Steady: 150/m Scopes: campaigns:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

The ID of the campaign to get recipient estimation status

fields__campaign__recipient__estimation__job

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Campaign Relationships Campaign Messages`

Integration name: KLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_CAMPAIGN_MESSAGES

Returns the IDs of all messages associated with the given campaign. Rate limits: Burst: 10/s Steady: 150/m Scopes: campaigns:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

`Klaviyo Get Campaign Relationships Tags`

Integration name: KLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_TAGS

Returns the IDs of all tags associated with the given campaign. Rate limits: Burst: 3/s Steady: 60/m Scopes: campaigns:read tags:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

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

`Klaviyo Get Campaigns`

Integration name: KLAVIYO_GET_CAMPAIGNS

Retrieve campaigns from your Klaviyo account. This action allows you to fetch campaigns with optional filtering and sorting. Klaviyo requires specifying a channel (email or sms) to list campaigns. You can add additional filters for status, name, creation date, and other attributes. Results are paginated with a default of 10 campaigns per page. Rate limits: 10/s burst, 150/m steady. Required scope: campaigns:read. Preconditions: - Valid API key with campaigns:read scope - Channel must be specified (email or sms) - Additional filter syntax must be valid if provided

Parameters

Parameter

Type

Required

Example

Description

sort

string

—

Klaviyo API sort options - note the _at suffix is required for time-based fields.

filter

string

"equals(status,\"draft\")"

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.

channel

string

—

Campaign channel to filter by (email or sms). Required by Klaviyo API.

page_cursor

string

—

Cursor for pagination to get the next page of results Iterate using links.next until it returns null to retrieve all results.

include_archived

boolean

—

Whether to include archived campaigns in the results

`Klaviyo Get Campaign Send Job`

Integration name: KLAVIYO_GET_CAMPAIGN_SEND_JOB

Get a campaign send job Rate limits: Burst: 10/s Steady: 150/m Scopes: campaigns:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

The ID of the campaign to send

fields__campaign__send__job

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Campaign Tags`

Integration name: KLAVIYO_GET_CAMPAIGN_TAGS

Return all tags that belong to the given campaign. Rate limits: Burst: 3/s Steady: 60/m Scopes: campaigns:read tags:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

The unique identifier of the campaign to retrieve tags for (e.g., '01KFT75VHSJJ4X5E1G4ZT0VQCJ').

fields__tag

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Catalog Categories`

Integration name: KLAVIYO_GET_CATALOG_CATEGORIES

Retrieve 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.

Parameters

Parameter

Type

Required

Example

Description

sort

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting

filter

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

page__cursor

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

fields__catalog__category

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Catalog Category`

Integration name: KLAVIYO_GET_CATALOG_CATEGORY

Get a catalog category with the given category ID. Rate limits: Burst: 350/s Steady: 3500/m Scopes: catalogs:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

fields__catalog__category

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Catalog Category Items`

Integration name: KLAVIYO_GET_CATALOG_CATEGORY_ITEMS

Retrieve 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.

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

sort

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting

filter

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

include

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships

page__cursor

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

fields__catalog__item

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

fields__catalog__variant

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Catalog Item`

Integration name: KLAVIYO_GET_CATALOG_ITEM

Get a specific catalog item with the given item ID. Rate limits: Burst: 350/s Steady: 3500/m Scopes: catalogs:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

include

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships

fields__catalog__item

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

fields__catalog__variant

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Catalog Item Variants`

Integration name: KLAVIYO_GET_CATALOG_ITEM_VARIANTS

Retrieve 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.

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

sort

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting

filter

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

page__cursor

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

fields__catalog__variant

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Coupon`

Integration name: KLAVIYO_GET_COUPON

Get a specific coupon with the given coupon ID. Rate limits: Burst: 75/s Steady: 700/m Scopes: coupons:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

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

fields__coupon

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Coupon Code`

Integration name: KLAVIYO_GET_COUPON_CODE

Returns a Coupon Code specified by the given identifier. Rate limits: Burst: 350/s Steady: 3500/m Scopes: coupon-codes:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

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

include

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships

fields__coupon

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

fields__coupon__code

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Coupon Codes`

Integration name: KLAVIYO_GET_COUPON_CODES

Obtains coupon codes using necessary coupon or profile filters. Rate limits: 350/s, 3500/m. Requires 'coupon-codes:read' scope.

Parameters

Parameter

Type

Required

Example

Description

filter

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

include

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships

page__cursor

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

fields__coupon

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

fields__coupon__code

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Coupon For Coupon Code`

Integration name: KLAVIYO_GET_COUPON_FOR_COUPON_CODE

Get the coupon associated with a given coupon code ID. Rate limits: Burst: 75/s Steady: 700/m Scopes: coupons:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

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

fields__coupon

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Forms`

Integration name: KLAVIYO_GET_FORMS

Get all forms in an account. Rate limits: Burst: 3/s Steady: 60/m Scopes: forms:read

Parameters

Parameter

Type

Required

Example

Description

sort

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting

filter

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

page__size

integer

—

Default: 20. Min: 1. Max: 100.

fields__form

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

page__cursor

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

`Klaviyo Get Image`

Integration name: KLAVIYO_GET_IMAGE

Get the image with the given image ID. Rate limits: Burst: 10/s Steady: 150/m Scopes: images:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

The ID of the image

fields__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.

`Klaviyo Get List`

Integration name: KLAVIYO_GET_LIST

API allows 75 req/sec and 700 req/min, but with 'profile_count' param, it's 1 req/sec and 15 req/min. 'lists:read' scope needed. See developer guide for details.

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

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

include

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships

fields__tag

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

fields__list

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

additional__fields__list

array

—

Request additional fields not included by default in the response. Supported values: "profile_count"

`Klaviyo Get Metrics`

Integration name: KLAVIYO_GET_METRICS

Get 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

Parameters

Parameter

Type

Required

Example

Description

filter

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

page__cursor

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

fields__metric

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

`Klaviyo Get Profile`

Integration name: KLAVIYO_GET_PROFILE

Get the profile with the given profile ID. Rate limits: Burst: 75/s Steady: 700/m Scopes: profiles:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

include

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships

fields__list

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

fields__profile

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

fields__segment

array

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

additional__fields__profile

array

—

Request additional fields not included by default in the response. Supported values: "subscriptions", "predictive_analytics"

`Klaviyo Get Profiles`

Integration name: KLAVIYO_GET_PROFILES

Retrieve profiles from your Klaviyo account. This action allows you to fetch profiles with optional filtering and sorting. You can filter by email, external_id, created 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

Parameters

Parameter

Type

Required

Example

Description

sort

string

—

Sort profiles by field (add '-' prefix for descending order)

filter

string

"equals(email,\"user@example.com\")"

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.

page_size

integer

—

Number of profiles to return per page (1-100)

page_cursor

string

—

Cursor for pagination to get the next page of results

include_subscriptions

boolean

—

Whether to include subscription information in the response

include_predictive_analytics

boolean

—

Whether to include predictive analytics data (note: this may reduce rate limits)

`Klaviyo Get Segment`

Integration name: KLAVIYO_GET_SEGMENT

Fetch 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.

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

The unique identifier of the segment to retrieve. This ID is returned when creating segments or listing segments via the API.

include

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.

fields__tag

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.

fields__segment

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.

additional__fields__segment

array

—

Request additional fields not included by default in the response. Supported values: "profile_count"

`Klaviyo Get Template`

Integration name: KLAVIYO_GET_TEMPLATE

Get a template with the given template ID. Rate limits: Burst: 10/s Steady: 150/m Scopes: templates:read

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

The unique identifier of the template to retrieve (e.g., 'Rz66gr').

fields__template

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.

`Klaviyo Get Webhook Topics`

Integration name: KLAVIYO_GET_WEBHOOK_TOPICS

Get all webhook topics in a Klaviyo account. Rate limits: Burst: 1/s Steady: 15/m Scopes: webhooks:read

Parameters

No parameters required.

`Klaviyo Merge Profiles`

Integration name: KLAVIYO_MERGE_PROFILES

Merge 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.

Parameters

Parameter

Type

Required

Example

Description

data__id

string

✅

—

The ID of the destination profile that will receive the merged data. This profile will be kept after the merge.

data__type

string

—

The resource type for merge operation. Must be 'profile-merge'.

data__relationships__profiles__data

array

✅

—

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'}]

`Klaviyo Query Campaign Values`

Integration name: KLAVIYO_QUERY_CAMPAIGN_VALUES

Returns the requested campaign analytics values data Rate limits: Burst: 1/s Steady: 2/m Daily: 225/d Scopes: campaigns:read

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Resource type for the campaign values report request. Must be 'campaign-values-report'.

page_cursor

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

data__attributes__filter

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.

data__attributes__timeframe

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.

data__attributes__statistics

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'.

data__attributes__conversion__metric__id

string

✅

—

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.

`Klaviyo Query Flow Series`

Integration name: KLAVIYO_QUERY_FLOW_SERIES

Returns 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

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

The resource type. Must be 'flow-series-report'.

page_cursor

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

data__attributes__filter

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")'

data__attributes__interval

string

✅

—

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.

data__attributes__timeframe

object

✅

—

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.

data__attributes__statistics

array

✅

—

List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]

data__attributes__conversion__metric__id

string

✅

—

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'.

`Klaviyo Query Flow Values`

Integration name: KLAVIYO_QUERY_FLOW_VALUES

Returns the requested flow analytics values data Rate limits: Burst: 1/s Steady: 2/m Daily: 225/d Scopes: flows:read

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Resource type for the flow values report request. Must be 'flow-values-report'.

page_cursor

string

—

For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

data__attributes__filter

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.

data__attributes__timeframe

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.

data__attributes__statistics

array

—

data__attributes__conversion_metric_id

string

✅

—

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.

`Klaviyo Query Metric Aggregates`

Integration name: KLAVIYO_QUERY_METRIC_AGGREGATES

The Klaviyo endpoint fetches metric events, handling JSON requests for custom data queries, sorting, and filtering; offers grouping and time-based filters; requires adherence to rate limits (3 requests per second, 60 per minute) under 'metrics:read'.

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Type

data__attributes__by

array

—

Optional attribute(s) used for partitioning by the aggregation function

data__attributes__sort

string

—

Provide a sort key (e.g. -$message)

data__attributes__filter

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")']

data__attributes__interval

string

—

Aggregation interval, e.g. "hour", "day", "week", "month"

data__attributes__timezone

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.

data__attributes__timeframe

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'}

data__attributes__metric__id

string

—

The metric ID used in the aggregation.

data__attributes__page__size

integer

—

Alter the maximum number of returned rows in a single page of aggregation results

data__attributes__measurements

array

—

Measurement key, e.g. unique, sum_value, count

data__attributes__page__cursor

string

—

Optional pagination cursor to iterate over large result sets

data__attributes__return__fields

array

—

Provide fields to limit the returned data

`Klaviyo Unregister Client Push Token`

Integration name: KLAVIYO_UNREGISTER_CLIENT_PUSH_TOKEN

This 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.

Parameters

Parameter

Type

Required

Example

Description

company_id

string

✅

—

Your Public API Key / Site ID. See this article for more details.

data__type

string

—

Type

data__attributes__token

string

—

A push token from APNS or FCM.

data__attributes__vendor

string

—

The vendor of the push token.

data__attributes__platform

string

—

The platform on which the push token was created.

data__attributes__profile__data__id

string

—

Primary key that uniquely identifies this profile. Generated by Klaviyo.

data__attributes__profile__data__type

string

—

Type

data__attributes__profile__data__attributes____kx

string

—

data__attributes__profile__data__attributes__email

string

—

Individual"s email address

data__attributes__profile__data__attributes__image

string

—

URL pointing to the location of a profile image

data__attributes__profile__data__attributes__title

string

—

Individual"s job title

data__attrs__profile__data__attrs__location__address1

string

—

First line of street address

data__attrs__profile__data__attrs__location__address2

string

—

Second line of street address

data__attrs__profile__data__attrs__location__latitude

string

—

Latitude coordinate. We recommend providing a precision of four decimal places.

data__attrs__profile__data__attrs__location__timezone

string

—

Time zone name. We recommend using time zones from the IANA Time Zone Database.

data__attrs__profile__data__meta__patch__props__unset

array

—

Remove a key or keys (and their values) completely from properties

data__attrs__profile__data__attrs__location__longitude

string

—

Longitude coordinate. We recommend providing a precision of four decimal places.

data__attributes__profile__data__attributes__last__name

string

—

Individual"s last name

data__attributes__profile__data__attributes__first__name

string

—

Individual"s first name

data__attributes__profile__data__attributes__external__id

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.

data__attributes__profile__data__attributes__location__ip

string

—

IP Address

data__attributes__profile__data__attributes__organization

string

—

Name of the company or organization within the company for whom the individual works

data__attributes__profile__data__attributes__anonymous__id

string

—

Id that can be used to identify a profile when other identifiers are not available

data__attributes__profile__data__attributes__location__zip

string

—

Zip code

data__attributes__profile__data__attributes__phone__number

string

—

Individual"s phone number in E.164 format

data__attributes__profile__data__attributes__location__city

string

—

City name

data__attributes__profile__data__attributes__location__region

string

—

Region within a country, such as state or province

data__attributes__profile__data__attributes__location__country

string

—

Country name

`Klaviyo Update Profile`

Integration name: KLAVIYO_UPDATE_PROFILE

Update profiles with the provided ID. Setting fields to null clears them; omitting fields retains existing data. Rate limits: 75/s burst, 700/m steady. Required scope: profiles:write.

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

Primary key that uniquely identifies this profile. Generated by Klaviyo.

data__id

string

—

Primary key that uniquely identifies this profile. Generated by Klaviyo.

data__type

string

—

Resource type. Must be 'profile'.

data__attributes__email

string

—

Individual's email address

data__attributes__image

string

—

URL pointing to the location of a profile image

data__attributes__title

string

—

Individual's job title

data__attributes__last__name

string

—

Individual's last name

data__attributes__first__name

string

—

Individual's first name

data__attributes__external__id

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.

data__attributes__location__ip

string

—

IP Address

data__attributes__organization

string

—

Name of the company or organization within the company for whom the individual works

data__attributes__anonymous__id

string

—

Anonymous identifier for tracking profiles before they are identified with an email or external ID

data__attributes__location__zip

string

—

Zip code

data__attributes__phone__number

string

—

Individual's phone number in E.164 format (e.g., +15005550006)

data__attributes__location__city

string

—

City name

data__attributes__location__region

string

—

Region within a country, such as state or province

data__attributes__location__country

string

—

Country name

data__attributes__location__address1

string

—

First line of street address

data__attributes__location__address2

string

—

Second line of street address

data__attributes__location__latitude

string

—

Latitude coordinate. We recommend providing a precision of four decimal places.

data__attributes__location__timezone

string

—

Time zone name. We recommend using time zones from the IANA Time Zone Database.

data__meta__patch__properties__unset

array

—

Remove a key or keys (and their values) completely from properties

data__attributes__location__longitude

string

—

Longitude coordinate. We recommend providing a precision of four decimal places.

`Klaviyo Update Segment`

Integration name: KLAVIYO_UPDATE_SEGMENT

Update a segment with the given segment ID. Rate limits: Burst: 1/s Steady: 15/m Daily: 100/d Scopes: segments:write

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

The unique identifier of the segment to update (e.g., 'XTTNN5'). This is a required path parameter.

data__id

string

—

The ID of the segment being updated. Should match the path parameter 'id'.

data__type

string

—

The resource type. Must be 'segment' for segment updates.

data__attributes__name

string

—

The display name of the segment. Use this to rename the segment.

data__attributes__is__starred

boolean

—

Whether the segment should be starred/favorited for quick access. Set to true to star or false to unstar.

data__attributes__definition__condition__groups

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'}}]}]

`Klaviyo Update Template`

Integration name: KLAVIYO_UPDATE_TEMPLATE

Update 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.

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

The unique identifier of the template to update. Used in the URL path.

data__id

string

—

The template ID in the request body. Must match the 'id' path parameter.

data__type

string

—

Resource type identifier. Must be 'template'.

data__attributes__html

string

—

The new HTML content for the template. Only works with CODE editor type templates, not drag & drop templates.

data__attributes__name

string

—

The new name for the template. Optional - only include if updating the name.

data__attributes__text

string

—

The new plaintext version of the template. This is the fallback content for email clients that don't support HTML.

`Klaviyo Update Webhook`

Integration name: KLAVIYO_UPDATE_WEBHOOK

Update the webhook with the given ID. Rate limits: Burst: 1/s Steady: 15/m Scopes: webhooks:write

Parameters

Parameter

Type

Required

Example

Description

id

string

✅

—

The ID of the webhook.

data__id

string

—

The ID of the webhook.

data__type

string

—

Resource type identifier. Must be set to 'webhook' for webhook resources.

data__attributes__name

string

—

A name for the webhook.

data__attributes__enabled

boolean

—

Boolean flag to enable or disable the webhook. Set to true to enable the webhook to receive events, or false to disable it.

data__attributes__description

string

—

A description for the webhook.

data__attributes__secret__key

string

—

A secret key, that will be used for webhook request signing.

data__attributes__endpoint__url

string

—

A url to send webhook calls to. Must be https.

data__relationships__webhook__topics__data

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').

`Klaviyo Upload Image From File`

Integration name: KLAVIYO_UPLOAD_IMAGE_FROM_FILE

Upload 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

Parameters

Parameter

Type

Required

Example

Description

file

object

✅

—

The image file to upload. Supported formats: jpeg, png, gif. Maximum file size: 5 MB.

name

string

—

A name for the image. If not provided, defaults to the filename.

hidden

boolean

—

If True, the image will not be shown in the asset library. Defaults to False.

`Klaviyo Upload Image From Url`

Integration name: KLAVIYO_UPLOAD_IMAGE_FROM_URL

Import an image from a url or data uri. If you want to upload an image from a file, use the Upload Image From File endpoint instead. Rate limits: Burst: 3/s Steady: 100/m Daily: 100/d Scopes: images:write

Parameters

Parameter

Type

Required

Example

Description

data__type

string

—

Resource type for the request. Must be 'image'.

data__attributes__name

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.

data__attributes__hidden

boolean

—

If true, this image is not shown in the asset library.

data__attributes__import__from__url

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.

PreviousKit NextLinear

Auth Connection

Tools (225)

Klaviyo Add Profile To List

Parameters

Klaviyo Assign Campaign Message Template

Parameters

Klaviyo Bulk Create Client Events

Parameters

Klaviyo Bulk Create Events

Parameters

Klaviyo Cancel Campaign Send

Parameters

Klaviyo Create Back In Stock Subscription

Parameters

Klaviyo Create Campaign

Parameters

Klaviyo Create Campaign Clone

Parameters

Klaviyo Create Campaign Recipient Estimation Job

Parameters

Klaviyo Create Campaign Send Job

Parameters

Klaviyo Create Catalog Category

Parameters

Klaviyo Create Catalog Category Relationships Items

Parameters

Klaviyo Create Catalog Item

Parameters

Klaviyo Create Catalog Item Relationships Categories

Parameters

Klaviyo Create Catalog Variant

Parameters

Klaviyo Create Client Back In Stock Subscription

Parameters

Klaviyo Create Client Event2

Parameters

Klaviyo Create Client Subscription

Parameters

Klaviyo Create Coupon

Parameters

Klaviyo Create Coupon Code

Parameters

Klaviyo Create Event

Parameters

Klaviyo Create List

Parameters

Klaviyo Create Or Update Client Profile

Parameters

Klaviyo Create Or Update Push Token

Parameters

Klaviyo Create Profile

Parameters

Klaviyo Create Segment

Parameters

Klaviyo Create Tag

Parameters

Klaviyo Create Tag Group

Parameters

Klaviyo Create Tag Relationships

Parameters

Klaviyo Create Template

Parameters

Klaviyo Create Template Clone

Parameters

Klaviyo Create Template Render

Parameters

Klaviyo Create Webhook

Parameters

Klaviyo Delete Campaign

Parameters

Klaviyo Delete Catalog Category

Parameters

Klaviyo Delete Catalog Item

Parameters

Klaviyo Delete Coupon

Parameters

Klaviyo Delete Coupon Code

Parameters

Klaviyo Delete Flow

Parameters

`Klaviyo Add Profile To List`

`Klaviyo Assign Campaign Message Template`

`Klaviyo Bulk Create Client Events`

`Klaviyo Bulk Create Events`

`Klaviyo Cancel Campaign Send`

`Klaviyo Create Back In Stock Subscription`

`Klaviyo Create Campaign`

`Klaviyo Create Campaign Clone`

`Klaviyo Create Campaign Recipient Estimation Job`

`Klaviyo Create Campaign Send Job`

`Klaviyo Create Catalog Category`

`Klaviyo Create Catalog Category Relationships Items`

`Klaviyo Create Catalog Item`

`Klaviyo Create Catalog Item Relationships Categories`

`Klaviyo Create Catalog Variant`

`Klaviyo Create Client Back In Stock Subscription`

`Klaviyo Create Client Event2`

`Klaviyo Create Client Subscription`

`Klaviyo Create Coupon`

`Klaviyo Create Coupon Code`

`Klaviyo Create Event`

`Klaviyo Create List`

`Klaviyo Create Or Update Client Profile`

`Klaviyo Create Or Update Push Token`

`Klaviyo Create Profile`

`Klaviyo Create Segment`

`Klaviyo Create Tag`

`Klaviyo Create Tag Group`

`Klaviyo Create Tag Relationships`

`Klaviyo Create Template`

`Klaviyo Create Template Clone`

`Klaviyo Create Template Render`

`Klaviyo Create Webhook`

`Klaviyo Delete Campaign`

`Klaviyo Delete Catalog Category`

`Klaviyo Delete Catalog Item`

`Klaviyo Delete Coupon`

`Klaviyo Delete Coupon Code`

`Klaviyo Delete Flow`

`Klaviyo Delete List`

`Klaviyo Delete Segment`

`Klaviyo Delete Tag`

`Klaviyo Delete Tag Group`

`Klaviyo Delete Template`

`Klaviyo Delete Webhook`

`Klaviyo Get Account`

`Klaviyo Get Accounts`

`Klaviyo Get Bulk Create Coupon Codes Job`

`Klaviyo Get Bulk Delete Catalog Items Job`

`Klaviyo Get Bulk Profile Import Job`

`Klaviyo Get Bulk Profile Import Job Errors`

`Klaviyo Get Bulk Profile Import Job Lists`

`Klaviyo Get Bulk Profile Import Job Profiles`

`Klaviyo Get Bulk Profile Import Job Relationships Lists`

`Klaviyo Get Bulk Profile Import Job Relationships Profiles`

`Klaviyo Get Bulk Profile Import Jobs`

`Klaviyo Get Bulk Update Catalog Items Job`

`Klaviyo Get Bulk Update Categories Job`

`Klaviyo Get Bulk Update Variants Job`

`Klaviyo Get Campaign`

`Klaviyo Get Campaign Campaign Messages`

`Klaviyo Get Campaign Message`

`Klaviyo Get Campaign Message Campaign`

`Klaviyo Get Campaign Message Relationships Campaign`

`Klaviyo Get Campaign Message Relationships Template`

`Klaviyo Get Campaign Message Template`

`Klaviyo Get Campaign Recipient Estimation`

`Klaviyo Get Campaign Recipient Estimation Job`

`Klaviyo Get Campaign Relationships Campaign Messages`

`Klaviyo Get Campaign Relationships Tags`

`Klaviyo Get Campaigns`

`Klaviyo Get Campaign Send Job`

`Klaviyo Get Campaign Tags`

`Klaviyo Get Catalog Categories`