Klaviyo | Composio Docs

Overview

SLUG

KLAVIYO

Description

Klaviyo is a data-driven email and SMS marketing platform that allows e-commerce brands to deliver targeted messages, track conversions, and scale customer relationships

Authentication Details

OAuth2

client_id

stringRequired

client_secret

stringRequired

oauth_redirect_uri

stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add

scopes

stringDefaults to accounts:read,campaigns:read,campaigns:write,conversations:read,conversations:write,catalogs:read,catalogs:write,coupons:read,coupons:write,coupon-codes:read,coupon-codes:write,data-privacy:read,data-privacy:write,events:read,events:write,flows:read,flows:write,images:read,images:write,lists:read,lists:write,metrics:read,metrics:write,profiles:read,profiles:write,push-tokens:read,push-tokens:write,segments:read,segments:write,subscriptions:read,subscriptions:write,tags:read,tags:write,templates:read,templates:write

bearer_token

string

API Key

generic_api_key

stringRequired

Tools

Add Profile to List

SLUG: 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

Action Parameters

emails

array

list_id

stringRequired

profile_ids

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create Campaign Recipient Estimation Job

SLUG: 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

Action Parameters

campaign_id

stringRequired

Action Response

data

objectRequired

error

string

job_id

string

successful

booleanRequired

Create event

SLUG: 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`.

Action Parameters

data__attributes__metric__data__attributes__name

string

data__attributes__metric__data__attributes__service

string

data__attributes__metric__data__type

string

data__attributes__profile__data__attributes____kx

string

data__attributes__profile__data__attributes__anonymous__id

string

data__attributes__profile__data__attributes__email

string

data__attributes__profile__data__attributes__external__id

string

data__attributes__profile__data__attributes__first__name

string

data__attributes__profile__data__attributes__image

string

data__attributes__profile__data__attributes__last__name

string

data__attributes__profile__data__attributes__location__address1

string

data__attributes__profile__data__attributes__location__address2

string

data__attributes__profile__data__attributes__location__city

string

data__attributes__profile__data__attributes__location__country

string

data__attributes__profile__data__attributes__location__ip

string

data__attributes__profile__data__attributes__location__latitude

string

data__attributes__profile__data__attributes__location__longitude

string

data__attributes__profile__data__attributes__location__region

string

data__attributes__profile__data__attributes__location__timezone

string

data__attributes__profile__data__attributes__location__zip

string

data__attributes__profile__data__attributes__meta__patch__properties__unset

array

data__attributes__profile__data__attributes__organization

string

data__attributes__profile__data__attributes__phone__number

string

data__attributes__profile__data__attributes__title

string

data__attributes__profile__data__id

string

data__attributes__profile__data__type

string

data__attributes__time

string

data__attributes__unique__id

string

data__attributes__value

integer

data__attributes__value__currency

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create list

SLUG: KLAVIYO_CREATE_LIST

Create a new list.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m`<br />daily: `100/d` **scopes:** `lists:write`

Action Parameters

data__attributes__name

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create or Update Profile

SLUG: KLAVIYO_CREATE_OR_UPDATE_PROFILE

Create or update a profile in klaviyo with the given attributes. this action allows you to create a new profile or update an existing one if it already exists (based on email or other identifiers). returns 201 for creation, 200 for update. empty fields are cleared with `null`; omitted fields remain unchanged. rate limits: 75/s burst, 700/m steady. required scope: `profiles:write`. preconditions: - at least one identifier (email, phone number, external id, or anonymous id) must be provided - email must be in valid format if provided - phone number must be in e.164 format if provided

Action Parameters

address1

string

address2

string

anonymous_id

string

city

string

country

string

stringRequired

external_id

string

first_name

string

image

string

last_name

string

latitude

string

longitude

string

organization

string

phone_number

string

properties

object

region

string

timezone

string

title

string

zip_code

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create profile

SLUG: KLAVIYO_CREATE_PROFILE

Create a new profile.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `profiles:write`

Action Parameters

data__attributes__email

string

data__attributes__external__id

string

data__attributes__first__name

string

data__attributes__image

string

data__attributes__last__name

string

data__attributes__location__address1

string

data__attributes__location__address2

string

data__attributes__location__city

string

data__attributes__location__country

string

data__attributes__location__ip

string

data__attributes__location__latitude

string

data__attributes__location__longitude

string

data__attributes__location__region

string

data__attributes__location__timezone

string

data__attributes__location__zip

string

data__attributes__organization

string

data__attributes__phone__number

string

data__attributes__title

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get Campaign

SLUG: 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

Action Parameters

campaign_id

stringRequired

include_messages

boolean

include_tags

boolean

Action Response

data

objectRequired

error

string

included

array

successful

booleanRequired

Get Campaigns

SLUG: 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

Action Parameters

channel

stringDefaults to email

filter

string

include_archived

boolean

page_cursor

string

sort

string

Action Response

data

arrayRequired

error

string

links

object

successful

booleanRequired

Get events

SLUG: KLAVIYO_GET_EVENTS

Get all events in an account requests can be sorted by the following fields: `datetime`, `timestamp` returns a maximum of 200 events per page.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `events:read`

Action Parameters

fields__event

array

fields__metric

array

fields__profile

array

filter

string

include

array

page__cursor

string

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get Lists

SLUG: KLAVIYO_GET_LISTS

Retrieve marketing lists from your klaviyo account. this action allows you to fetch lists with optional filtering and sorting. you can filter by name, creation date, and other attributes. results are paginated with a default of 10 lists per page. rate limits: 75/s burst, 700/m steady. required scope: `lists:read`. preconditions: - valid api key with lists:read scope - filter syntax must be valid if provided

Action Parameters

filter

string

include_tags

boolean

page_cursor

string

sort

stringDefaults to name

Action Response

data

arrayRequired

error

string

included

array

links

object

successful

booleanRequired

Get Profiles

SLUG: 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, creation date, and other attributes. results are paginated with a configurable page size. rate limits: 75/s burst, 700/m steady (lower with predictive analytics). required scope: `profiles:read`. preconditions: - valid api key with profiles:read scope - filter syntax must be valid if provided - page size must be between 1 and 100

Action Parameters

filter

string

include_predictive_analytics

boolean

include_subscriptions

boolean

page_cursor

string

page_size

integerDefaults to 20

sort

stringDefaults to -created

Action Response

data

arrayRequired

error

string

links

object

successful

booleanRequired

Update Campaign

SLUG: KLAVIYO_UPDATE_CAMPAIGN

Update a campaign with the specified attributes. this action allows you to modify campaign settings including name, audiences, and send strategy. only the fields you provide will be updated; others remain unchanged. rate limits: 10/s burst, 150/m steady. required scope: `campaigns:write`. preconditions: - valid api key with campaigns:write scope - campaign id must exist and be accessible - campaign must be in a state that allows updates (usually draft status) - send strategy options must match the selected method

Action Parameters

campaign_id

stringRequired

excluded_audiences

array

included_audiences

array

name

string

send_options

object

send_strategy_method

string

static_is_local_timezone

boolean

static_send_datetime

string

static_send_past_recipients_immediately

boolean

sto_send_date

string

throttle_percentage

integer

throttled_send_datetime

string

tracking_options

object

Action Response

data

objectRequired

error

string

successful

booleanRequired

Assign campaign message template

SLUG: KLAVIYO_ASSIGN_CAMPAIGN_MESSAGE_TEMPLATE

Creates a non-reusable version of the template and assigns it to the message.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:write`

Action Parameters

data__id

string

data__relationships__template__data__id

string

data__relationships__template__data__type

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Bulk create client events

SLUG: 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.

Action Parameters

company_id

stringRequired

data__attributes__events__data

array

data__attributes__profile__data__attributes____kx

string

data__attributes__profile__data__attributes__anonymous__id

string

data__attributes__profile__data__attributes__email

string

data__attributes__profile__data__attributes__external__id

string

data__attributes__profile__data__attributes__first__name

string

data__attributes__profile__data__attributes__image

string

data__attributes__profile__data__attributes__last__name

string

data__attributes__profile__data__attributes__location__address1

string

data__attributes__profile__data__attributes__location__address2

string

data__attributes__profile__data__attributes__location__city

string

data__attributes__profile__data__attributes__location__country

string

data__attributes__profile__data__attributes__location__ip

string

data__attributes__profile__data__attributes__location__latitude

string

data__attributes__profile__data__attributes__location__longitude

string

data__attributes__profile__data__attributes__location__region

string

data__attributes__profile__data__attributes__location__timezone

string

data__attributes__profile__data__attributes__location__zip

string

data__attributes__profile__data__attributes__organization

string

data__attributes__profile__data__attributes__phone__number

string

data__attributes__profile__data__attributes__title

string

data__attributes__profile__data__id

string

data__attributes__profile__data__meta__patch__properties__unset

array

data__attributes__profile__data__type

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Bulk create events

SLUG: KLAVIYO_BULK_CREATE_EVENTS

This api endpoint creates or updates profiles by batching up to 1,000 events, with a 5mb payload limit. minimum required: a profile id and metric name. it has rate limits of 10 events per second burst and 150 events per minute. scope is `events:write`.

Action Parameters

data__attributes__events__bulk__create__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create back in stock subscription

SLUG: 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.

Action Parameters

data__attributes__channels

array

data__attributes__profile__data__attributes__anonymous__id

string

data__attributes__profile__data__attributes__email

string

data__attributes__profile__data__attributes__external__id

string

data__attributes__profile__data__attributes__phone__number

string

data__attributes__profile__data__id

string

data__attributes__profile__data__type

string

data__relationships__variant__data__id

string

data__relationships__variant__data__type

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create campaign

SLUG: KLAVIYO_CREATE_CAMPAIGN

Creates a campaign given a set of parameters, then returns it.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:write`

Action Parameters

data__attributes__audiences__excluded

array

data__attributes__audiences__included

array

data__attributes__campaign__messages__data

array

data__attributes__name

string

data__attributes__send__options

object

data__attributes__send__strategy__method

string

data__attributes__send__strategy__options__static__datetime

string

data__attributes__send__strategy__options__static__is__local

boolean

data__attributes__send__strategy__options__static__send__past__recipients__immediately

boolean

data__attributes__send__strategy__options__sto__date

string

data__attributes__send__strategy__options__throttled__datetime

string

data__attributes__send__strategy__options__throttled__throttle__percentage

integer

data__attributes__tracking__options

object

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create campaign clone

SLUG: KLAVIYO_CREATE_CAMPAIGN_CLONE

Clones an existing campaign, returning a new campaign based on the original with a new id and name.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:write`

Action Parameters

data__attributes__new__name

string

data__id

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create campaign send job

SLUG: KLAVIYO_CREATE_CAMPAIGN_SEND_JOB

Trigger a campaign to send asynchronously<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:write`

Action Parameters

data__id

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create catalog category

SLUG: KLAVIYO_CREATE_CATALOG_CATEGORY

Create a new catalog category.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

data__attributes__catalog__type

stringDefaults to $default

data__attributes__external__id

string

data__attributes__integration__type

stringDefaults to $custom

data__attributes__name

string

data__relationships__items__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create catalog category relationships items

SLUG: KLAVIYO_CREATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMS

Create a new item relationship for the given category id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create catalog item

SLUG: KLAVIYO_CREATE_CATALOG_ITEM

Create a new catalog item.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

data__attributes__catalog__type

stringDefaults to $default

data__attributes__description

string

data__attributes__external__id

string

data__attributes__image__full__url

string

data__attributes__image__thumbnail__url

string

data__attributes__images

array

data__attributes__integration__type

stringDefaults to $custom

data__attributes__price

integer

data__attributes__published

booleanDefaults to True

data__attributes__title

string

data__attributes__url

string

data__relationships__categories__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create catalog item relationships categories

SLUG: KLAVIYO_CREATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIES

Create a new catalog category relationship for the given item id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create catalog variant

SLUG: KLAVIYO_CREATE_CATALOG_VARIANT

Create a new variant for a related catalog item.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

data__attributes__catalog__type

stringDefaults to $default

data__attributes__description

string

data__attributes__external__id

string

data__attributes__image__full__url

string

data__attributes__image__thumbnail__url

string

data__attributes__images

array

data__attributes__integration__type

stringDefaults to $custom

data__attributes__inventory__policy

integer

data__attributes__inventory__quantity

integer

data__attributes__price

integer

data__attributes__published

booleanDefaults to True

data__attributes__sku

string

data__attributes__title

string

data__attributes__url

string

data__relationships__item__data__id

string

data__relationships__item__data__type

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create client back in stock subscription

SLUG: 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.

Action Parameters

company_id

stringRequired

data__attributes__channels

array

data__attributes__profile__data__attributes__anonymous__id

string

data__attributes__profile__data__attributes__email

string

data__attributes__profile__data__attributes__external__id

string

data__attributes__profile__data__attributes__phone__number

string

data__attributes__profile__data__id

string

data__attributes__profile__data__type

string

data__relationships__variant__data__id

string

data__relationships__variant__data__type

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create client event

SLUG: KLAVIYO_CREATE_CLIENT_EVENT

Create client-side events to track profiles using a public api key, not for updating identifiers (server-side only). rate limits: 350/s, 3500/m. use `events:write` scope.

Action Parameters

company_id

stringRequired

data__attributes__metric__data__attributes__name

string

data__attributes__metric__data__attributes__service

string

data__attributes__metric__data__type

string

data__attributes__profile__data__attributes____kx

string

data__attributes__profile__data__attributes__anonymous__id

string

data__attributes__profile__data__attributes__email

string

data__attributes__profile__data__attributes__external__id

string

data__attributes__profile__data__attributes__first__name

string

data__attributes__profile__data__attributes__image

string

data__attributes__profile__data__attributes__last__name

string

data__attributes__profile__data__attributes__location__address1

string

data__attributes__profile__data__attributes__location__address2

string

data__attributes__profile__data__attributes__location__city

string

data__attributes__profile__data__attributes__location__country

string

data__attributes__profile__data__attributes__location__ip

string

data__attributes__profile__data__attributes__location__latitude

string

data__attributes__profile__data__attributes__location__longitude

string

data__attributes__profile__data__attributes__location__region

string

data__attributes__profile__data__attributes__location__timezone

string

data__attributes__profile__data__attributes__location__zip

string

data__attributes__profile__data__attributes__meta__patch__properties__unset

array

data__attributes__profile__data__attributes__organization

string

data__attributes__profile__data__attributes__phone__number

string

data__attributes__profile__data__attributes__title

string

data__attributes__profile__data__id

string

data__attributes__profile__data__type

string

data__attributes__time

string

data__attributes__unique__id

string

data__attributes__value

integer

data__attributes__value__currency

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create client subscription

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

Action Parameters

company_id

stringRequired

data__attributes__custom__source

string

data__attributes__profile__data__attributes____kx

string

data__attributes__profile__data__attributes__anonymous__id

string

data__attributes__profile__data__attributes__email

string

data__attributes__profile__data__attributes__external__id

string

data__attributes__profile__data__attributes__first__name

string

data__attributes__profile__data__attributes__image

string

data__attributes__profile__data__attributes__last__name

string

data__attributes__profile__data__attributes__location__address1

string

data__attributes__profile__data__attributes__location__address2

string

data__attributes__profile__data__attributes__location__city

string

data__attributes__profile__data__attributes__location__country

string

data__attributes__profile__data__attributes__location__ip

string

data__attributes__profile__data__attributes__location__latitude

string

data__attributes__profile__data__attributes__location__longitude

string

data__attributes__profile__data__attributes__location__region

string

data__attributes__profile__data__attributes__location__timezone

string

data__attributes__profile__data__attributes__location__zip

string

data__attributes__profile__data__attributes__organization

string

data__attributes__profile__data__attributes__phone__number

string

data__attributes__profile__data__attributes__title

string

data__attributes__profile__data__id

string

data__attributes__profile__data__meta__patch__properties__unset

array

data__attributes__profile__data__type

string

data__relationships__list__data__id

string

data__relationships__list__data__type

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create coupon

SLUG: KLAVIYO_CREATE_COUPON

Creates a new coupon.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `coupons:write`

Action Parameters

data__attributes__description

string

data__attributes__external__id

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create coupon code

SLUG: KLAVIYO_CREATE_COUPON_CODE

Synchronously creates a coupon code for the given coupon.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `coupon-codes:write`

Action Parameters

data__attributes__expires__at

string

data__attributes__unique__code

string

data__relationships__coupon__data__id

string

data__relationships__coupon__data__type

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create or update client profile

SLUG: 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.

Action Parameters

company_id

stringRequired

data__attributes____kx

string

data__attributes__anonymous__id

string

data__attributes__email

string

data__attributes__external__id

string

data__attributes__first__name

string

data__attributes__image

string

data__attributes__last__name

string

data__attributes__location__address1

string

data__attributes__location__address2

string

data__attributes__location__city

string

data__attributes__location__country

string

data__attributes__location__ip

string

data__attributes__location__latitude

string

data__attributes__location__longitude

string

data__attributes__location__region

string

data__attributes__location__timezone

string

data__attributes__location__zip

string

data__attributes__organization

string

data__attributes__phone__number

string

data__attributes__title

string

data__id

string

data__meta__patch__properties__unset

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create or update client push token

SLUG: KLAVIYO_CREATE_OR_UPDATE_CLIENT_PUSH_TOKEN

This endpoint for mobile sdks (ios & android) creates/updates push tokens using a public api key. push notifications must be enabled. for migrating tokens use the server-side post endpoint. rate limits are 3/s burst, 150/m steady.

Action Parameters

company_id

stringRequired

data__attributes__background

stringDefaults to AVAILABLE

data__attributes__device__metadata__app__build

string

data__attributes__device__metadata__app__id

string

data__attributes__device__metadata__app__name

string

data__attributes__device__metadata__app__version

string

data__attributes__device__metadata__device__id

string

data__attributes__device__metadata__device__model

string

data__attributes__device__metadata__environment

string

data__attributes__device__metadata__klaviyo__sdk

string

data__attributes__device__metadata__manufacturer

string

data__attributes__device__metadata__os__name

string

data__attributes__device__metadata__os__version

string

data__attributes__device__metadata__sdk__version

string

data__attributes__enablement__status

stringDefaults to AUTHORIZED

data__attributes__platform

string

data__attributes__profile__data__attributes____kx

string

data__attributes__profile__data__attributes__anonymous__id

string

data__attributes__profile__data__attributes__email

string

data__attributes__profile__data__attributes__external__id

string

data__attributes__profile__data__attributes__first__name

string

data__attributes__profile__data__attributes__image

string

data__attributes__profile__data__attributes__last__name

string

data__attributes__profile__data__attributes__location__address1

string

data__attributes__profile__data__attributes__location__address2

string

data__attributes__profile__data__attributes__location__city

string

data__attributes__profile__data__attributes__location__country

string

data__attributes__profile__data__attributes__location__ip

string

data__attributes__profile__data__attributes__location__latitude

string

data__attributes__profile__data__attributes__location__longitude

string

data__attributes__profile__data__attributes__location__region

string

data__attributes__profile__data__attributes__location__timezone

string

data__attributes__profile__data__attributes__location__zip

string

data__attributes__profile__data__attributes__meta__patch__properties__unset

array

data__attributes__profile__data__attributes__organization

string

data__attributes__profile__data__attributes__phone__number

string

data__attributes__profile__data__attributes__title

string

data__attributes__profile__data__id

string

data__attributes__profile__data__type

string

data__attributes__token

string

data__attributes__vendor

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create or update push token

SLUG: KLAVIYO_CREATE_OR_UPDATE_PUSH_TOKEN

Migrate or create push tokens with klaviyo's endpoint, utilizing their mobile sdks for ios & android. rate limits: 75/s burst, 700/m steady. requires profiles:write and push-tokens:write scopes.

Action Parameters

data__attributes__background

stringDefaults to AVAILABLE

data__attributes__device__metadata__app__build

string

data__attributes__device__metadata__app__id

string

data__attributes__device__metadata__app__name

string

data__attributes__device__metadata__app__version

string

data__attributes__device__metadata__device__id

string

data__attributes__device__metadata__device__model

string

data__attributes__device__metadata__environment

string

data__attributes__device__metadata__klaviyo__sdk

string

data__attributes__device__metadata__manufacturer

string

data__attributes__device__metadata__os__name

string

data__attributes__device__metadata__os__version

string

data__attributes__device__metadata__sdk__version

string

data__attributes__enablement__status

stringDefaults to AUTHORIZED

data__attributes__platform

string

data__attributes__profile__data__attributes____kx

string

data__attributes__profile__data__attributes__anonymous__id

string

data__attributes__profile__data__attributes__email

string

data__attributes__profile__data__attributes__external__id

string

data__attributes__profile__data__attributes__first__name

string

data__attributes__profile__data__attributes__image

string

data__attributes__profile__data__attributes__last__name

string

data__attributes__profile__data__attributes__location__address1

string

data__attributes__profile__data__attributes__location__address2

string

data__attributes__profile__data__attributes__location__city

string

data__attributes__profile__data__attributes__location__country

string

data__attributes__profile__data__attributes__location__ip

string

data__attributes__profile__data__attributes__location__latitude

string

data__attributes__profile__data__attributes__location__longitude

string

data__attributes__profile__data__attributes__location__region

string

data__attributes__profile__data__attributes__location__timezone

string

data__attributes__profile__data__attributes__location__zip

string

data__attributes__profile__data__attributes__meta__patch__properties__unset

array

data__attributes__profile__data__attributes__organization

string

data__attributes__profile__data__attributes__phone__number

string

data__attributes__profile__data__attributes__title

string

data__attributes__profile__data__id

string

data__attributes__profile__data__type

string

data__attributes__token

string

data__attributes__vendor

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create segment

SLUG: KLAVIYO_CREATE_SEGMENT

Create a segment.<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `15/m`<br />daily: `100/d` **scopes:** `segments:write`

Action Parameters

data__attributes__definition__condition__groups

array

data__attributes__is__starred

boolean

data__attributes__name

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create tag

SLUG: 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

Action Parameters

data__attributes__name

string

data__relationships__tag__group__data__id

string

data__relationships__tag__group__data__type

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create tag relationships campaigns

SLUG: KLAVIYO_CREATE_TAG_RELATIONSHIPS_CAMPAIGNS

Summary: link a tag to campaigns, ensuring a limit of 100 tags per campaign. campaign ids should be sent via request body. rate limit: 3/s, 60/m. required scopes: campaigns:write, tags:write. tag: #campaigntagginglimits

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create tag relationships flows

SLUG: KLAVIYO_CREATE_TAG_RELATIONSHIPS_FLOWS

Assign tags to flows using their ids in the request body, ensuring a flow is not linked to over 100 tags. rate limits are 3/s burst and 60/m steady. required scopes: `flows:write` and `tags:write`. tag: flow-tag association limits

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create tag relationships lists

SLUG: KLAVIYO_CREATE_TAG_RELATIONSHIPS_LISTS

Summary: a tag can be added to one or more lists, with a max of 100 tags per list. use the request body to link tag and list ids. tag: #apiusagelimits scopes: lists:write, tags:write

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create tag relationships segments

SLUG: KLAVIYO_CREATE_TAG_RELATIONSHIPS_SEGMENTS

Summary: set tag associations with segments using the request body, limited to one tag per segment and up to 100 tags per segment. rate limits are three requests per second and sixty per minute. tags: segments:write, tags:write

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create template

SLUG: 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.

Action Parameters

data__attributes__editor__type

string

data__attributes__html

string

data__attributes__name

string

data__attributes__text

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create template clone

SLUG: 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.

Action Parameters

data__attributes__name

string

data__id

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create template render

SLUG: 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.

Action Parameters

data__id

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create webhook

SLUG: KLAVIYO_CREATE_WEBHOOK

Create a new webhook<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `15/m` **scopes:** `webhooks:write`

Action Parameters

data__attributes__description

string

data__attributes__endpoint__url

string

data__attributes__name

string

data__attributes__secret__key

string

data__relationships__webhook__topics__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete campaign

SLUG: KLAVIYO_DELETE_CAMPAIGN

Delete a campaign with the given campaign id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:write`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete catalog category

SLUG: KLAVIYO_DELETE_CATALOG_CATEGORY

Delete a catalog category using the given category id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete catalog category relationships items

SLUG: KLAVIYO_DELETE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMS

Delete item relationships for the given category id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete catalog item

SLUG: KLAVIYO_DELETE_CATALOG_ITEM

Delete a catalog item with the given item id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete catalog item relationships categories

SLUG: KLAVIYO_DELETE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIES

Delete catalog category relationships for the given item id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete catalog variant

SLUG: KLAVIYO_DELETE_CATALOG_VARIANT

Delete a catalog item variant with the given variant id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete coupon

SLUG: KLAVIYO_DELETE_COUPON

Delete the coupon with the given coupon id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `coupons:write`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete coupon code

SLUG: KLAVIYO_DELETE_COUPON_CODE

Deletes a coupon code specified by the given identifier synchronously. if a profile has been assigned to the coupon code, an exception will be raised<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `coupon-codes:write`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete flow

SLUG: KLAVIYO_DELETE_FLOW

Delete a flow with the given flow id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:write`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete list

SLUG: KLAVIYO_DELETE_LIST

Delete a list with the given list id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `lists:write`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete segment

SLUG: KLAVIYO_DELETE_SEGMENT

Delete a segment with the given segment id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `segments:write`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete tag

SLUG: KLAVIYO_DELETE_TAG

Delete the tag with the given tag id. any associations between the tag and other resources will also be removed.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `tags:read` `tags:write`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete tag relationships campaigns

SLUG: KLAVIYO_DELETE_TAG_RELATIONSHIPS_CAMPAIGNS

Disconnect a tag from campaigns using the campaign id(s) in the request body. rate limits: 3 requests/second, 60 requests/minute. required scopes: campaigns:write, tags:write.

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete tag relationships flows

SLUG: KLAVIYO_DELETE_TAG_RELATIONSHIPS_FLOWS

Remove a tag's association with one or more flows. use the request body to pass in the id(s) of the flows(s) whose association with the tag will be removed.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:write` `tags:write`

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete tag relationships lists

SLUG: KLAVIYO_DELETE_TAG_RELATIONSHIPS_LISTS

Remove a tag's association with one or more lists. use the request body to pass in the id(s) of the list(s) whose association with the tag will be removed.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `lists:write` `tags:write`

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete tag relationships segments

SLUG: KLAVIYO_DELETE_TAG_RELATIONSHIPS_SEGMENTS

Use the request body to de-associate a tag from specified segment ids. rate limits are 3 requests/sec and 60 requests/min. required scopes are 'segments:write' and 'tags:write'.

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete template

SLUG: KLAVIYO_DELETE_TEMPLATE

Delete a template with the given template id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `templates:write`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete webhook

SLUG: KLAVIYO_DELETE_WEBHOOK

Delete a webhook with the given id.<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `15/m` **scopes:** `webhooks:write`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get account

SLUG: KLAVIYO_GET_ACCOUNT

Retrieve a single account object by its account id. you can only request the account by which the private api key was generated.<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `15/m` **scopes:** `accounts:read`

Action Parameters

fields__account

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get accounts

SLUG: 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`.

Action Parameters

fields__account

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get bulk profile import job

SLUG: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB

Get a bulk profile import job with the given job id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `lists:read` `profiles:read`

Action Parameters

fields__list

array

fields__profile__bulk__import__job

array

include

array

job_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get bulk profile import jobs

SLUG: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOBS

Get all bulk profile import jobs. returns a maximum of 100 jobs per request.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `lists:read` `profiles:read`

Action Parameters

fields__profile__bulk__import__job

array

filter

string

page__cursor

string

page__size

integerDefaults to 20

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get bulk profile import job errors

SLUG: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_ERRORS

Get import errors for the bulk profile import job with the given id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `profiles:read`

Action Parameters

fields__import__error

array

stringRequired

page__cursor

string

page__size

integerDefaults to 20

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get bulk profile import job lists

SLUG: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_LISTS

Get list for the bulk profile import job with the given id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `lists:read`

Action Parameters

fields__list

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get bulk profile import job profiles

SLUG: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_PROFILES

Get profiles for the bulk profile import job with the given id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `profiles:read`

Action Parameters

additional__fields__profile

array

fields__profile

array

stringRequired

page__cursor

string

page__size

integerDefaults to 20

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get bulk profile import job relationships lists

SLUG: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_LISTS

Get list relationship for the bulk profile import job with the given id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `lists:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get bulk profile import job relationships profiles

SLUG: KLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_PROFILES

Get profile relationships for the bulk profile import job with the given id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `profiles:read`

Action Parameters

stringRequired

page__cursor

string

page__size

integerDefaults to 20

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get campaign campaign messages

SLUG: KLAVIYO_GET_CAMPAIGN_CAMPAIGN_MESSAGES

Return all messages that belong to the given campaign.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:read`

Action Parameters

fields__campaign

array

fields__campaign__message

array

fields__template

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get campaign message

SLUG: KLAVIYO_GET_CAMPAIGN_MESSAGE

Returns a specific message based on a required id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:read`

Action Parameters

fields__campaign

array

fields__campaign__message

array

fields__template

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get campaign message campaign

SLUG: KLAVIYO_GET_CAMPAIGN_MESSAGE_CAMPAIGN

Return the related campaign<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:read`

Action Parameters

fields__campaign

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get campaign message relationships campaign

SLUG: KLAVIYO_GET_CAMPAIGN_MESSAGE_RELATIONSHIPS_CAMPAIGN

Returns the id of the related campaign<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get campaign message relationships template

SLUG: KLAVIYO_GET_CAMPAIGN_MESSAGE_RELATIONSHIPS_TEMPLATE

Returns the id of the related template<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:read` `templates:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get campaign message template

SLUG: KLAVIYO_GET_CAMPAIGN_MESSAGE_TEMPLATE

Return the related template<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:read` `templates:read`

Action Parameters

fields__template

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get campaign recipient estimation

SLUG: 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`.

Action Parameters

fields__campaign__recipient__estimation

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get campaign recipient estimation job

SLUG: KLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATION_JOB

Retrieve the status of a recipient estimation job triggered with the `create campaign recipient estimation job` endpoint.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:read`

Action Parameters

fields__campaign__recipient__estimation__job

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get campaign relationships campaign messages

SLUG: KLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_CAMPAIGN_MESSAGES

Returns the ids of all messages associated with the given campaign.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get campaign relationships tags

SLUG: KLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_TAGS

Returns the ids of all tags associated with the given campaign.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `campaigns:read` `tags:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get campaign send job

SLUG: KLAVIYO_GET_CAMPAIGN_SEND_JOB

Get a campaign send job<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:read`

Action Parameters

fields__campaign__send__job

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get campaign tags

SLUG: KLAVIYO_GET_CAMPAIGN_TAGS

Return all tags that belong to the given campaign.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `campaigns:read` `tags:read`

Action Parameters

fields__tag

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get catalog categories

SLUG: 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.

Action Parameters

fields__catalog__category

array

filter

string

page__cursor

string

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get catalog category

SLUG: KLAVIYO_GET_CATALOG_CATEGORY

Get a catalog category with the given category id.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__category

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get catalog category items

SLUG: 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.

Action Parameters

fields__catalog__item

array

fields__catalog__variant

array

filter

string

stringRequired

include

array

page__cursor

string

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get catalog category relationships items

SLUG: KLAVIYO_GET_CATALOG_CATEGORY_RELATIONSHIPS_ITEMS

Get all items in the given category id. returns a maximum of 100 items per request.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

stringRequired

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get catalog item

SLUG: KLAVIYO_GET_CATALOG_ITEM

Get a specific catalog item with the given item id.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__item

array

fields__catalog__variant

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get catalog items

SLUG: KLAVIYO_GET_CATALOG_ITEMS

Retrieve up to 100 sorted catalog items per account, with `$custom` integration and `$default` type. rate limits: 350/s burst, 3500/m steady. scope required: `catalogs:read`.

Action Parameters

fields__catalog__item

array

fields__catalog__variant

array

filter

string

include

array

page__cursor

string

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get catalog item categories

SLUG: KLAVIYO_GET_CATALOG_ITEM_CATEGORIES

Retrieve the catalog categories for an item by id, sorted by 'created' date, with a 100-category maximum per request. rate limits: 350/s burst, 3500/m steady. requires 'catalogs:read' scope.

Action Parameters

fields__catalog__category

array

filter

string

stringRequired

page__cursor

string

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get catalog item relationships categories

SLUG: KLAVIYO_GET_CATALOG_ITEM_RELATIONSHIPS_CATEGORIES

Get all catalog categories that a particular item is in. returns a maximum of 100 categories per request.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

stringRequired

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get catalog item variants

SLUG: 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.

Action Parameters

fields__catalog__variant

array

filter

string

stringRequired

page__cursor

string

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get catalog variant

SLUG: KLAVIYO_GET_CATALOG_VARIANT

Get a catalog item variant with the given variant id.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__variant

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get catalog variants

SLUG: KLAVIYO_GET_CATALOG_VARIANTS

Retrieve up to 100 account variants per request, sortable by creation date. supports only `$custom` integration and `$default` catalog types. rate limits are 350/s burst and 3500/m steady. requires `catalogs:read` scope.

Action Parameters

fields__catalog__variant

array

filter

string

page__cursor

string

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get coupon

SLUG: KLAVIYO_GET_COUPON

Get a specific coupon with the given coupon id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `coupons:read`

Action Parameters

fields__coupon

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get coupons

SLUG: KLAVIYO_GET_COUPONS

Get all coupons in an account. to learn more, see our [coupons api guide](https://developers.klaviyo.com/en/docs/use klaviyos coupons api).<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `coupons:read`

Action Parameters

fields__coupon

array

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get coupon code

SLUG: KLAVIYO_GET_COUPON_CODE

Returns a coupon code specified by the given identifier.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `coupon-codes:read`

Action Parameters

fields__coupon

array

fields__coupon__code

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get coupon codes

SLUG: KLAVIYO_GET_COUPON_CODES

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

Action Parameters

fields__coupon

array

fields__coupon__code

array

filter

string

include

array

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get coupon codes for coupon

SLUG: KLAVIYO_GET_COUPON_CODES_FOR_COUPON

Gets a list of coupon codes associated with the given coupon id<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `coupon-codes:read`

Action Parameters

fields__coupon__code

array

filter

string

stringRequired

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get coupon code bulk create job

SLUG: KLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOB

Get a coupon code bulk create job with the given job id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `coupon-codes:read`

Action Parameters

fields__coupon__code

array

fields__coupon__code__bulk__create__job

array

include

array

job_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get coupon code bulk create jobs

SLUG: KLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOBS

Get all coupon code bulk create jobs. returns a maximum of 100 jobs per request.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `coupon-codes:read`

Action Parameters

fields__coupon__code__bulk__create__job

array

filter

string

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get coupon code relationships coupon

SLUG: KLAVIYO_GET_COUPON_CODE_RELATIONSHIPS_COUPON

Gets a list of coupon code relationships associated with the given coupon id<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `coupon-codes:read`

Action Parameters

stringRequired

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get coupon for coupon code

SLUG: KLAVIYO_GET_COUPON_FOR_COUPON_CODE

Get the coupon associated with a given coupon code id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `coupons:read`

Action Parameters

fields__coupon

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get coupon relationships coupon codes

SLUG: KLAVIYO_GET_COUPON_RELATIONSHIPS_COUPON_CODES

Gets the coupon relationship associated with the given coupon code id<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `coupons:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get create categories job

SLUG: KLAVIYO_GET_CREATE_CATEGORIES_JOB

Get a catalog category bulk create job with the given job id. an `include` parameter can be provided to get the following related resource data: `categories`.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__category

array

fields__catalog__category__bulk__create__job

array

include

array

job_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get create categories jobs

SLUG: KLAVIYO_GET_CREATE_CATEGORIES_JOBS

Get all catalog category bulk create jobs. returns a maximum of 100 jobs per request.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__category__bulk__create__job

array

filter

string

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get create items job

SLUG: KLAVIYO_GET_CREATE_ITEMS_JOB

Get a catalog item bulk create job with the given job id. an `include` parameter can be provided to get the following related resource data: `items`.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__item

array

fields__catalog__item__bulk__create__job

array

include

array

job_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get create items jobs

SLUG: KLAVIYO_GET_CREATE_ITEMS_JOBS

Get all catalog item bulk create jobs. returns a maximum of 100 jobs per request.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__item__bulk__create__job

array

filter

string

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get create variants job

SLUG: KLAVIYO_GET_CREATE_VARIANTS_JOB

Get a catalog variant bulk create job with the given job id. an `include` parameter can be provided to get the following related resource data: `variants`.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__variant

array

fields__catalog__variant__bulk__create__job

array

include

array

job_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get create variants jobs

SLUG: KLAVIYO_GET_CREATE_VARIANTS_JOBS

Get all catalog variant bulk create jobs. returns a maximum of 100 jobs per request.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__variant__bulk__create__job

array

filter

string

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get delete categories job

SLUG: KLAVIYO_GET_DELETE_CATEGORIES_JOB

Get a catalog category bulk delete job with the given job id.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__category__bulk__delete__job

array

job_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get delete categories jobs

SLUG: KLAVIYO_GET_DELETE_CATEGORIES_JOBS

Get all catalog category bulk delete jobs. returns a maximum of 100 jobs per request.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__category__bulk__delete__job

array

filter

string

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get delete items job

SLUG: KLAVIYO_GET_DELETE_ITEMS_JOB

Get a catalog item bulk delete job with the given job id.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__item__bulk__delete__job

array

job_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get delete items jobs

SLUG: KLAVIYO_GET_DELETE_ITEMS_JOBS

Get all catalog item bulk delete jobs. returns a maximum of 100 jobs per request.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__item__bulk__delete__job

array

filter

string

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get delete variants job

SLUG: KLAVIYO_GET_DELETE_VARIANTS_JOB

Get a catalog variant bulk delete job with the given job id.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__variant__bulk__delete__job

array

job_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get delete variants jobs

SLUG: KLAVIYO_GET_DELETE_VARIANTS_JOBS

Get all catalog variant bulk delete jobs. returns a maximum of 100 jobs per request.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__variant__bulk__delete__job

array

filter

string

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get event

SLUG: KLAVIYO_GET_EVENT

Get an event with the given event id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `events:read`

Action Parameters

fields__event

array

fields__metric

array

fields__profile

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get event metric

SLUG: KLAVIYO_GET_EVENT_METRIC

Get the metric for an event with the given event id.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `events:read` `metrics:read`

Action Parameters

fields__metric

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get event profile

SLUG: KLAVIYO_GET_EVENT_PROFILE

Get the profile associated with an event with the given event id.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `events:read` `profiles:read`

Action Parameters

additional__fields__profile

array

fields__profile

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get event relationships metric

SLUG: KLAVIYO_GET_EVENT_RELATIONSHIPS_METRIC

Get a list of related metrics for an event<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `events:read` `metrics:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get event relationships profile

SLUG: KLAVIYO_GET_EVENT_RELATIONSHIPS_PROFILE

Get profile [relationships](https://developers.klaviyo.com/en/reference/api overview#relationships) for an event with the given event id.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `events:read` `profiles:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow

SLUG: KLAVIYO_GET_FLOW

Get a flow with the given flow id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:read`

Action Parameters

fields__flow

array

fields__flow__action

array

fields__tag

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flows

SLUG: KLAVIYO_GET_FLOWS

Get all flows in an account. returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:read`

Action Parameters

fields__flow

array

fields__flow__action

array

fields__tag

array

filter

string

include

array

page__cursor

string

page__size

integerDefaults to 50

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow action

SLUG: KLAVIYO_GET_FLOW_ACTION

Get a flow action from a flow with the given flow action id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:read`

Action Parameters

fields__flow

array

fields__flow__action

array

fields__flow__message

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow action for message

SLUG: KLAVIYO_GET_FLOW_ACTION_FOR_MESSAGE

Get the flow action for a flow message with the given message id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:read`

Action Parameters

fields__flow__action

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow action messages

SLUG: KLAVIYO_GET_FLOW_ACTION_MESSAGES

Retrieve up to 50 flow messages per request by action id, sortable by various fields, with ascending/descending options, and paginated using `page[size]` and `page[number]`. rate limits: 3/s burst, 60/m steady. scope required: `flows:read`.

Action Parameters

fields__flow__message

array

filter

string

stringRequired

page__size

integerDefaults to 50

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow action relationships flow

SLUG: KLAVIYO_GET_FLOW_ACTION_RELATIONSHIPS_FLOW

Get the flow associated with the given action id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow action relationships messages

SLUG: KLAVIYO_GET_FLOW_ACTION_RELATIONSHIPS_MESSAGES

Retrieves up to 50 flow message relationships per request for a specified flow action id, with cursor pagination. rate limits: 3/s burst, 60/min steady. requires `flows:read` scope.

Action Parameters

filter

string

stringRequired

page__cursor

string

page__size

integerDefaults to 50

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow flow actions

SLUG: KLAVIYO_GET_FLOW_FLOW_ACTIONS

Get all flow actions associated with the given flow id. returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:read`

Action Parameters

fields__flow__action

array

filter

string

stringRequired

page__cursor

string

page__size

integerDefaults to 50

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow for flow action

SLUG: KLAVIYO_GET_FLOW_FOR_FLOW_ACTION

Get the flow associated with the given action id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:read`

Action Parameters

fields__flow

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow message

SLUG: KLAVIYO_GET_FLOW_MESSAGE

Get the flow message of a flow with the given message id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:read`

Action Parameters

fields__flow__action

array

fields__flow__message

array

fields__template

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow message relationships action

SLUG: KLAVIYO_GET_FLOW_MESSAGE_RELATIONSHIPS_ACTION

Get the [relationship](https://developers.klaviyo.com/en/reference/api overview#relationships) for a flow message's flow action, given the flow id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow message relationships template

SLUG: KLAVIYO_GET_FLOW_MESSAGE_RELATIONSHIPS_TEMPLATE

Returns the id of the related template<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `templates:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow message template

SLUG: KLAVIYO_GET_FLOW_MESSAGE_TEMPLATE

Return the related template<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `templates:read`

Action Parameters

fields__template

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow relationships flow actions

SLUG: KLAVIYO_GET_FLOW_RELATIONSHIPS_FLOW_ACTIONS

Retrieve all flow action relationships for a specific flow id, sortable by `id`, `status`, `created`, `updated`. refine with filters, max 50 per page, paginated by `page[size]` and `page[number]`. rate limits: burst 3/s, steady 60/m. scope: `flows:read`.

Action Parameters

filter

string

stringRequired

page__size

integerDefaults to 50

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow relationships tags

SLUG: KLAVIYO_GET_FLOW_RELATIONSHIPS_TAGS

Return the tag ids of all tags associated with the given flow.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:read` `tags:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get flow tags

SLUG: KLAVIYO_GET_FLOW_TAGS

Return all tags associated with the given flow id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:read` `tags:read`

Action Parameters

fields__tag

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get form

SLUG: KLAVIYO_GET_FORM

Get the form with the given id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `forms:read`

Action Parameters

fields__form

array

fields__form__version

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get forms

SLUG: KLAVIYO_GET_FORMS

Get all forms in an account.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `forms:read`

Action Parameters

fields__form

array

filter

string

page__cursor

string

page__size

integerDefaults to 20

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get form for form version

SLUG: KLAVIYO_GET_FORM_FOR_FORM_VERSION

Get the form associated with the given form version.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `forms:read`

Action Parameters

fields__form

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get form id for form version

SLUG: KLAVIYO_GET_FORM_ID_FOR_FORM_VERSION

Get the id of the form associated with the given form version.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `forms:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get form version

SLUG: KLAVIYO_GET_FORM_VERSION

Get the form version with the given id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `forms:read`

Action Parameters

fields__form__version

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get image

SLUG: KLAVIYO_GET_IMAGE

Get the image with the given image id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `images:read`

Action Parameters

fields__image

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get images

SLUG: KLAVIYO_GET_IMAGES

Get all images in an account.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `images:read`

Action Parameters

fields__image

array

filter

string

page__cursor

string

page__size

integerDefaults to 20

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get list

SLUG: 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.

Action Parameters

additional__fields__list

array

fields__list

array

fields__tag

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get list profiles

SLUG: KLAVIYO_GET_LIST_PROFILES

Retrieve profiles in a list by id, filterable by email/phone/push token/join date, sortable by join date. regular rate limit: 75/s, 700/m; with predictive analytics: 10/s, 150/m. details at klaviyo guide. scopes required: lists:read, profiles:read.

Action Parameters

additional__fields__profile

array

fields__profile

array

filter

string

stringRequired

page__cursor

string

page__size

integerDefaults to 20

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get list relationships profiles

SLUG: KLAVIYO_GET_LIST_RELATIONSHIPS_PROFILES

Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api overview#relationships) for a list with the given list id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `lists:read` `profiles:read`

Action Parameters

filter

string

stringRequired

page__cursor

string

page__size

integerDefaults to 20

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get list relationships tags

SLUG: KLAVIYO_GET_LIST_RELATIONSHIPS_TAGS

Returns the tag ids of all tags associated with the given list.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `lists:read` `tags:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get metric

SLUG: KLAVIYO_GET_METRIC

Get a metric with the given metric id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `metrics:read`

Action Parameters

fields__metric

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get metrics

SLUG: 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.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `metrics:read`

Action Parameters

fields__metric

array

filter

string

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get profile

SLUG: KLAVIYO_GET_PROFILE

Get the profile with the given profile id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `profiles:read`

Action Parameters

additional__fields__profile

array

fields__list

array

fields__profile

array

fields__segment

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get profile lists

SLUG: KLAVIYO_GET_PROFILE_LISTS

Get list memberships for a profile with the given profile id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `lists:read` `profiles:read`

Action Parameters

fields__list

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get profile relationships lists

SLUG: KLAVIYO_GET_PROFILE_RELATIONSHIPS_LISTS

Get list memberships for a profile with the given profile id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `lists:read` `profiles:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get profile relationships segments

SLUG: KLAVIYO_GET_PROFILE_RELATIONSHIPS_SEGMENTS

Get segment membership relationships for a profile with the given profile id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `profiles:read` `segments:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get profile segments

SLUG: KLAVIYO_GET_PROFILE_SEGMENTS

Get segment memberships for a profile with the given profile id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `profiles:read` `segments:read`

Action Parameters

fields__segment

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get segment

SLUG: 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`.

Action Parameters

additional__fields__segment

array

fields__segment

array

fields__tag

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get segments

SLUG: KLAVIYO_GET_SEGMENTS

Fetch segments from an account with filters like `name`, `created`, and `updated`. max 10 results/page. rate limits are 75/s burst, 700/m steady. requires `segments:read` scope.

Action Parameters

fields__segment

array

fields__tag

array

filter

string

include

array

page__cursor

string

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get segment profiles

SLUG: KLAVIYO_GET_SEGMENT_PROFILES

Retrieve profiles in a segment by id, filtering by email, phone, token, or join date, and sorting by join date. rate limit: 75/s burst, 700/m steady. requires profiles:read and segments:read scopes.

Action Parameters

additional__fields__profile

array

fields__profile

array

filter

string

stringRequired

page__cursor

string

page__size

integerDefaults to 20

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get segment relationships profiles

SLUG: KLAVIYO_GET_SEGMENT_RELATIONSHIPS_PROFILES

Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api overview#relationships) for the given segment id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `profiles:read` `segments:read`

Action Parameters

filter

string

stringRequired

page__cursor

string

page__size

integerDefaults to 20

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get segment relationships tags

SLUG: KLAVIYO_GET_SEGMENT_RELATIONSHIPS_TAGS

If `related resource` is `tags`, returns the tag ids of all tags associated with the given segment id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `segments:read` `tags:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get segment tags

SLUG: KLAVIYO_GET_SEGMENT_TAGS

Return all tags associated with the given segment id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `segments:read` `tags:read`

Action Parameters

fields__tag

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get tag

SLUG: KLAVIYO_GET_TAG

Retrieve the tag with the given tag id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `tags:read`

Action Parameters

fields__tag

array

fields__tag__group

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get tags

SLUG: KLAVIYO_GET_TAGS

Retrieve up to 50 account tags at once, filterable/sortable by name or id, with cursor pagination. rate limits: 3/s burst, 60/m steady. requires `tags:read` scope.

Action Parameters

fields__tag

array

fields__tag__group

array

filter

string

include

array

page__cursor

string

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get tag groups

SLUG: KLAVIYO_GET_TAG_GROUPS

Retrieve up to 25 tag groups per account, sortable/filterable by specific attributes. default group included. supports cursor pagination and adheres to rate limits of 3 requests per second and 60 per minute. requires `tags:read` scope.

Action Parameters

fields__tag__group

array

filter

string

page__cursor

string

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get tag relationships campaigns

SLUG: KLAVIYO_GET_TAG_RELATIONSHIPS_CAMPAIGNS

Returns the ids of all campaigns associated with the given tag.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `campaigns:read` `tags:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get tag relationships flows

SLUG: KLAVIYO_GET_TAG_RELATIONSHIPS_FLOWS

Returns the ids of all flows associated with the given tag.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:read` `tags:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get tag relationships lists

SLUG: KLAVIYO_GET_TAG_RELATIONSHIPS_LISTS

Returns the ids of all lists associated with the given tag.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `lists:read` `tags:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get tag relationships segments

SLUG: KLAVIYO_GET_TAG_RELATIONSHIPS_SEGMENTS

Returns the ids of all segments associated with the given tag.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `segments:read` `tags:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get template

SLUG: KLAVIYO_GET_TEMPLATE

Get a template with the given template id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `templates:read`

Action Parameters

fields__template

array

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get templates

SLUG: KLAVIYO_GET_TEMPLATES

Retrieve account templates with sorting options (`id`, `name`, `created`, `updated`). limit of 10 results per page, rate limits at 10/s burst and 150/m steady. requires `templates:read` scope.

Action Parameters

fields__template

array

filter

string

page__cursor

string

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get update categories job

SLUG: KLAVIYO_GET_UPDATE_CATEGORIES_JOB

Get a catalog category bulk update job with the given job id. an `include` parameter can be provided to get the following related resource data: `categories`.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__category

array

fields__catalog__category__bulk__update__job

array

include

array

job_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get update categories jobs

SLUG: KLAVIYO_GET_UPDATE_CATEGORIES_JOBS

Get all catalog category bulk update jobs. returns a maximum of 100 jobs per request.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__category__bulk__update__job

array

filter

string

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get update items job

SLUG: KLAVIYO_GET_UPDATE_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`.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__item

array

fields__catalog__item__bulk__update__job

array

include

array

job_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get update items jobs

SLUG: KLAVIYO_GET_UPDATE_ITEMS_JOBS

Get all catalog item bulk update jobs. returns a maximum of 100 jobs per request.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__item__bulk__update__job

array

filter

string

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get update variants job

SLUG: KLAVIYO_GET_UPDATE_VARIANTS_JOB

Get a catalog variate bulk update job with the given job id. an `include` parameter can be provided to get the following related resource data: `variants`.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__variant

array

fields__catalog__variant__bulk__update__job

array

include

array

job_id

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get update variants jobs

SLUG: KLAVIYO_GET_UPDATE_VARIANTS_JOBS

Get all catalog variant bulk update jobs. returns a maximum of 100 jobs per request.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `catalogs:read`

Action Parameters

fields__catalog__variant__bulk__update__job

array

filter

string

page__cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get versions for form

SLUG: KLAVIYO_GET_VERSIONS_FOR_FORM

Get the form versions for the given form.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `forms:read`

Action Parameters

fields__form__version

array

filter

string

stringRequired

page__cursor

string

page__size

integerDefaults to 20

sort

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get version ids for form

SLUG: KLAVIYO_GET_VERSION_IDS_FOR_FORM

Get the ids of the form versions for the given form.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `forms:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get webhook

SLUG: KLAVIYO_GET_WEBHOOK

Get the webhook with the given id.<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `15/m` **scopes:** `webhooks:read`

Action Parameters

fields__webhook

array

stringRequired

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get webhooks

SLUG: KLAVIYO_GET_WEBHOOKS

Get all webhooks in an account.<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `15/m` **scopes:** `webhooks:read`

Action Parameters

fields__webhook

array

include

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get webhook topic

SLUG: KLAVIYO_GET_WEBHOOK_TOPIC

Get the webhook topic with the given id.<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `15/m` **scopes:** `webhooks:read`

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get webhook topics

SLUG: KLAVIYO_GET_WEBHOOK_TOPICS

Get all webhook topics in a klaviyo account.<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `15/m` **scopes:** `webhooks:read`

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Merge profiles

SLUG: KLAVIYO_MERGE_PROFILES

Queue a task to merge one source profile into a destination profile using their ids. deletes the source afterwards. visit help center for details. rate limits: 10/s burst, 150/m steady. needs `profiles:write` scope.

Action Parameters

data__id

string

data__relationships__profiles__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Query campaign values

SLUG: KLAVIYO_QUERY_CAMPAIGN_VALUES

Returns the requested campaign analytics values data<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `2/m`<br />daily: `225/d` **scopes:** `campaigns:read`

Action Parameters

data__attributes__conversion__metric__id

string

data__attributes__filter

string

data__attributes__statistics

array

data__attributes__timeframe

object

data__type

string

page_cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Query flow series

SLUG: KLAVIYO_QUERY_FLOW_SERIES

Returns the requested flow analytics series data<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `2/m`<br />daily: `225/d` **scopes:** `flows:read`

Action Parameters

data__attributes__conversion__metric__id

string

data__attributes__filter

string

data__attributes__interval

string

data__attributes__statistics

array

data__attributes__timeframe

object

data__type

string

page_cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Query flow values

SLUG: KLAVIYO_QUERY_FLOW_VALUES

Returns the requested flow analytics values data<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `2/m`<br />daily: `225/d` **scopes:** `flows:read`

Action Parameters

data__attributes__conversion__metric__id

string

data__attributes__filter

string

data__attributes__statistics

array

data__attributes__timeframe

object

data__type

string

page_cursor

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Query metric aggregates

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

Action Parameters

data__attributes__by

array

data__attributes__filter

array

data__attributes__interval

stringDefaults to day

data__attributes__measurements

array

data__attributes__metric__id

string

data__attributes__page__cursor

string

data__attributes__page__size

integerDefaults to 500

data__attributes__return__fields

array

data__attributes__sort

string

data__attributes__timezone

stringDefaults to UTC

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Remove Profile from List

SLUG: KLAVIYO_REMOVE_PROFILE_FROM_LIST

Remove profiles from a klaviyo list by profile ids or email addresses. this action removes profiles from a marketing list without affecting their overall consent status. use the unsubscribe profiles action for complete unsubscribing. you can remove up to 1000 profiles per call. rate limits: 10/s burst, 150/m steady. required scopes: `lists:write` and `profiles:write`. preconditions: - either profile ids or emails must be provided (not both) - maximum 1000 profiles per call - email addresses must be valid format - the list must exist and be accessible

Action Parameters

emails

array

list_id

stringRequired

profile_ids

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Request profile deletion

SLUG: KLAVIYO_REQUEST_PROFILE_DELETION

To delete a profile, use only one identifier: email, phone number, or id. requests are asynchronous and can be tracked. ensure legal compliance; refer to docs. rate limits: 3 per second, 60 per minute.

Action Parameters

data__attributes__profile__data__attributes__email

string

data__attributes__profile__data__attributes__phone__number

string

data__attributes__profile__data__id

string

data__attributes__profile__data__type

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Spawn bulk profile import job

SLUG: KLAVIYO_SPAWN_BULK_PROFILE_IMPORT_JOB

Initiate a job to create/update a batch of profiles, up to 10,000 with a max size of 5mb per request. rate limits: 10/s burst, 150/m steady. requires `lists:write` and `profiles:write` scopes. more info in the bulk profile import api guide.

Action Parameters

data__attributes__profiles__data

array

data__relationships__lists__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Spawn coupon code bulk create job

SLUG: KLAVIYO_SPAWN_COUPON_CODE_BULK_CREATE_JOB

Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. max number of jobs queued at once we allow for is 100.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `coupon-codes:write`

Action Parameters

data__attributes__coupon__codes__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Spawn create categories job

SLUG: KLAVIYO_SPAWN_CREATE_CATEGORIES_JOB

Create bulk job for up to 100 catalog categories with a 5mb size limit and a max of 500 concurrent jobs. rate limits: 75/s burst, 700/m steady. requires 'catalogs:write' scope.

Action Parameters

data__attributes__categories__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Spawn create items job

SLUG: KLAVIYO_SPAWN_CREATE_ITEMS_JOB

Create batches of up to 100 catalog items with a 5mb size limit using the bulk job, which allows 500 concurrent jobs. rate limits are 75/s burst and 700/m steady. requires `catalogs:write` scope.

Action Parameters

data__attributes__items__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Spawn create variants job

SLUG: KLAVIYO_SPAWN_CREATE_VARIANTS_JOB

Initiate a job to bulk create up to 100 catalog variants, with a 5mb payload size limit. a max of 500 jobs can run concurrently. rate limits are 75/s burst and 700/m steady. requires 'catalogs:write' scope.

Action Parameters

data__attributes__variants__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Spawn delete categories job

SLUG: KLAVIYO_SPAWN_DELETE_CATEGORIES_JOB

Delete multiple catalog categories in bulk, with a limit of 100 per request and a 5mb payload size. a maximum of 500 concurrent jobs permitted. rate limits are 75/s burst and 700/min steady. requires `catalogs:write` scope.

Action Parameters

data__attributes__categories__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Spawn delete items job

SLUG: KLAVIYO_SPAWN_DELETE_ITEMS_JOB

Delete batches of catalog items with a bulk job, max 100 items/request, 5mb size limit, and up to 500 concurrent jobs. rate limits are 75/s burst and 700/m steady. requires `catalogs:write` scope.

Action Parameters

data__attributes__items__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Spawn delete variants job

SLUG: KLAVIYO_SPAWN_DELETE_VARIANTS_JOB

Delete multiple catalog variants with a bulk job, max 100 per request, 5mb size limit. only 500 jobs can run concurrently. rate limits: 75/s burst, 700/m steady. requires `catalogs:write` scope.

Action Parameters

data__attributes__variants__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Spawn update categories job

SLUG: KLAVIYO_SPAWN_UPDATE_CATEGORIES_JOB

Create a job to bulk update up to 100 categories, with a 5mb size limit and a maximum of 500 concurrent jobs. burst rate limit is 75/s, steady is 700/m. requires `catalogs:write` scope.

Action Parameters

data__attributes__categories__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Spawn update items job

SLUG: KLAVIYO_SPAWN_UPDATE_ITEMS_JOB

You can bulk update up to 100 catalog items with a 5mb payload limit. a max of 500 jobs can run concurrently. rate limits are 75 requests/second and 700 requests/minute. required scope: `catalogs:write`.

Action Parameters

data__attributes__items__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Spawn update variants job

SLUG: KLAVIYO_SPAWN_UPDATE_VARIANTS_JOB

Create a job to bulk update up to 100 catalog variants with a 5mb payload limit. a max of 500 jobs may run concurrently. rate limits are 75/s burst and 700/m steady. requires `catalogs:write` scope.

Action Parameters

data__attributes__variants__data

array

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Suppress profiles

SLUG: KLAVIYO_SUPPRESS_PROFILES

Suppress profiles by email, segment, or list id to stop email marketing, regardless of consent. view guides for details. max 100 emails per request, with rate limits of 75/s and 700/m. scopes: profiles:write, subscriptions:write.

Action Parameters

data__attributes__profiles__data

array

data__relationships__list__data__id

string

data__relationships__list__data__type

string

data__relationships__segment__data__id

string

data__relationships__segment__data__type

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Unregister client push token

SLUG: 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.

Action Parameters

company_id

stringRequired

data__attributes__platform

string

data__attributes__profile__data__attributes____kx

string

data__attributes__profile__data__attributes__anonymous__id

string

data__attributes__profile__data__attributes__email

string

data__attributes__profile__data__attributes__external__id

string

data__attributes__profile__data__attributes__first__name

string

data__attributes__profile__data__attributes__image

string

data__attributes__profile__data__attributes__last__name

string

data__attributes__profile__data__attributes__location__address1

string

data__attributes__profile__data__attributes__location__address2

string

data__attributes__profile__data__attributes__location__city

string

data__attributes__profile__data__attributes__location__country

string

data__attributes__profile__data__attributes__location__ip

string

data__attributes__profile__data__attributes__location__latitude

string

data__attributes__profile__data__attributes__location__longitude

string

data__attributes__profile__data__attributes__location__region

string

data__attributes__profile__data__attributes__location__timezone

string

data__attributes__profile__data__attributes__location__zip

string

data__attributes__profile__data__attributes__organization

string

data__attributes__profile__data__attributes__phone__number

string

data__attributes__profile__data__attributes__title

string

data__attributes__profile__data__id

string

data__attributes__profile__data__meta__patch__properties__unset

array

data__attributes__profile__data__type

string

data__attributes__token

string

data__attributes__vendor

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Unsubscribe profiles

SLUG: KLAVIYO_UNSUBSCRIBE_PROFILES

Opt-out profiles from email or sms marketing. unsubscribe up to 100 profiles at a time with burst (75/s) and steady (700/m) rate limits. use different method to remove without affecting subscriptions. more on consent and removal in the provided links.

Action Parameters

data__attributes__profiles__data

array

data__relationships__list__data__id

string

data__relationships__list__data__type

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Unsuppress profiles

SLUG: KLAVIYO_UNSUPPRESS_PROFILES

Remove 'user suppressed' blocks on profiles manually via email, segment, or list id. does not affect unsubscribes or other suppressions. limits: 100 emails per request, 75/s burst, 700/m steady. scope: 'subscriptions:write'.

Action Parameters

data__attributes__profiles__data

array

data__relationships__list__data__id

string

data__relationships__list__data__type

string

data__relationships__segment__data__id

string

data__relationships__segment__data__type

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update campaign message

SLUG: KLAVIYO_UPDATE_CAMPAIGN_MESSAGE

Update a campaign message<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:write`

Action Parameters

data__attributes__content

object

data__attributes__label

string

data__attributes__render__options__add__info__link

booleanDefaults to True

data__attributes__render__options__add__opt__out__language

boolean

data__attributes__render__options__add__org__prefix

booleanDefaults to True

data__attributes__render__options__shorten__links

booleanDefaults to True

data__id

string

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update campaign send job

SLUG: KLAVIYO_UPDATE_CAMPAIGN_SEND_JOB

Permanently cancel the campaign, setting the status to canceled or revert the campaign, setting the status back to draft<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `campaigns:write`

Action Parameters

data__attributes__action

string

data__id

string

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update catalog category

SLUG: KLAVIYO_UPDATE_CATALOG_CATEGORY

Update a catalog category with the given category id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

data__attributes__name

string

data__id

string

data__relationships__items__data

array

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update catalog category relationships items

SLUG: KLAVIYO_UPDATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMS

Update item relationships for the given category id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update catalog item

SLUG: KLAVIYO_UPDATE_CATALOG_ITEM

Update a catalog item with the given item id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

data__attributes__description

string

data__attributes__image__full__url

string

data__attributes__image__thumbnail__url

string

data__attributes__images

array

data__attributes__price

integer

data__attributes__published

boolean

data__attributes__title

string

data__attributes__url

string

data__id

string

data__relationships__categories__data

array

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update catalog item relationships categories

SLUG: KLAVIYO_UPDATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIES

Update catalog category relationships for the given item id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

data

arrayRequired

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update catalog variant

SLUG: KLAVIYO_UPDATE_CATALOG_VARIANT

Update a catalog item variant with the given variant id.<br /><br />*rate limits*:<br />burst: `75/s`<br />steady: `700/m` **scopes:** `catalogs:write`

Action Parameters

data__attributes__description

string

data__attributes__image__full__url

string

data__attributes__image__thumbnail__url

string

data__attributes__images

array

data__attributes__inventory__policy

integer

data__attributes__inventory__quantity

integer

data__attributes__price

integer

data__attributes__published

boolean

data__attributes__sku

string

data__attributes__title

string

data__attributes__url

string

data__id

string

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update coupon

SLUG: KLAVIYO_UPDATE_COUPON

*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `coupons:write`

Action Parameters

data__attributes__description

string

data__id

string

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update coupon code

SLUG: KLAVIYO_UPDATE_COUPON_CODE

Updates a coupon code specified by the given identifier synchronously. we allow updating the 'status' and 'expires at' of coupon codes.<br /><br />*rate limits*:<br />burst: `350/s`<br />steady: `3500/m` **scopes:** `coupon-codes:write`

Action Parameters

data__attributes__expires__at

string

data__attributes__status

string

data__id

string

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update flow status

SLUG: KLAVIYO_UPDATE_FLOW_STATUS

Update the status of a flow with the given flow id, and all actions in that flow.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `flows:write`

Action Parameters

data__attributes__status

string

data__id

string

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update image

SLUG: KLAVIYO_UPDATE_IMAGE

Update the image with the given image id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `images:write`

Action Parameters

data__attributes__hidden

boolean

data__attributes__name

string

data__id

string

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update list

SLUG: KLAVIYO_UPDATE_LIST

Update the name of a list with the given list id.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `lists:write`

Action Parameters

data__attributes__name

string

data__id

string

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update profile

SLUG: 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`.

Action Parameters

data__attributes__anonymous__id

string

data__attributes__email

string

data__attributes__external__id

string

data__attributes__first__name

string

data__attributes__image

string

data__attributes__last__name

string

data__attributes__location__address1

string

data__attributes__location__address2

string

data__attributes__location__city

string

data__attributes__location__country

string

data__attributes__location__ip

string

data__attributes__location__latitude

string

data__attributes__location__longitude

string

data__attributes__location__region

string

data__attributes__location__timezone

string

data__attributes__location__zip

string

data__attributes__organization

string

data__attributes__phone__number

string

data__attributes__title

string

data__id

string

data__meta__patch__properties__unset

array

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update segment

SLUG: KLAVIYO_UPDATE_SEGMENT

Update a segment with the given segment id.<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `15/m`<br />daily: `100/d` **scopes:** `segments:write`

Action Parameters

data__attributes__definition__condition__groups

array

data__attributes__is__starred

boolean

data__attributes__name

string

data__id

string

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update tag

SLUG: KLAVIYO_UPDATE_TAG

Update the tag with the given tag id. only a tag's `name` can be changed. a tag cannot be moved from one tag group to another.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `tags:read` `tags:write`

Action Parameters

data__attributes__name

string

data__id

string

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update template

SLUG: KLAVIYO_UPDATE_TEMPLATE

Update a template with the given template id. does not currently update drag & drop templates.<br /><br />*rate limits*:<br />burst: `10/s`<br />steady: `150/m` **scopes:** `templates:write`

Action Parameters

data__attributes__html

string

data__attributes__name

string

data__attributes__text

string

data__id

string

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update webhook

SLUG: KLAVIYO_UPDATE_WEBHOOK

Update the webhook with the given id.<br /><br />*rate limits*:<br />burst: `1/s`<br />steady: `15/m` **scopes:** `webhooks:write`

Action Parameters

data__attributes__description

string

data__attributes__enabled

boolean

data__attributes__endpoint__url

string

data__attributes__name

string

data__attributes__secret__key

string

data__id

string

data__relationships__webhook__topics__data

array

data__type

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Upload image from file

SLUG: 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.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `100/m`<br />daily: `100/d` **scopes:** `images:write`

Action Parameters

file

object

hidden

boolean

name

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Upload image from url

SLUG: 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.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `100/m`<br />daily: `100/d` **scopes:** `images:write`

Action Parameters

data__attributes__hidden

boolean

data__attributes__import__from__url

string

data__attributes__name

string

data__type

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Overview

SLUG

Description

Authentication Details

OAuth2

API Key

Tools

Add Profile to List

Create Campaign Recipient Estimation Job

Create event

Create list

Create or Update Profile

Create profile

Get Campaign

Get Campaigns

Get events

Get Lists

Get Profiles

Update Campaign

Assign campaign message template

Bulk create client events

Bulk create events

Create back in stock subscription

Create campaign

Create campaign clone

Create campaign send job

Create catalog category

Create catalog category relationships items

Create catalog item

Create catalog item relationships categories

Create catalog variant

Create client back in stock subscription

Create client event

Create client subscription

Create coupon

Create coupon code

Create or update client profile

Create or update client push token

Create or update push token

Create segment

Create tag

Create tag group

Create tag relationships campaigns

Create tag relationships flows

Create tag relationships lists

Create tag relationships segments

Create template

Create template clone

Create template render

Create webhook

Delete campaign

Delete catalog category

Delete catalog category relationships items

Delete catalog item

Delete catalog item relationships categories

Delete catalog variant

Delete coupon

Delete coupon code

Delete flow

Delete list

Delete segment

Delete tag

Delete tag group

Delete tag relationships campaigns

Delete tag relationships flows

Delete tag relationships lists

Delete tag relationships segments

Delete template

Delete webhook

Get account

Get accounts

Get bulk profile import job

Get bulk profile import jobs

Get bulk profile import job errors

Get bulk profile import job lists

Get bulk profile import job profiles

Get bulk profile import job relationships lists

Get bulk profile import job relationships profiles

Get campaign campaign messages

Get campaign message