Marketing & Social Media

Klaviyo

Learn how to use Klaviyo with Composio

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

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
generic_api_key
stringRequired

Connecting to Klaviyo

Create an auth config

Use the dashboard to create an auth config for the Klaviyo toolkit. This allows you to connect multiple Klaviyo accounts to Composio for agents to use.

1

Select App

Navigate to Klaviyo.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Klaviyo Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4klaviyo_auth_config_id = "ac_YOUR_KLAVIYO_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11    connection_request = composio.connected_accounts.initiate(
12        user_id=user_id,
13        auth_config_id=auth_config_id,
14    )
15
16    print(
17        f"Visit this URL to authenticate Klaviyo: {connection_request.redirect_url}"
18    )
19
20    # This will wait for the auth flow to be completed
21    connection_request.wait_for_connection(timeout=15)
22    return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, klaviyo_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4klaviyo_auth_config_id = "ac_YOUR_KLAVIYO_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": user_api_key}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Klaviyo for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, klaviyo_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Klaviyo toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["KLAVIYO"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Add Profile to List

Description

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

Tool Name: Create Campaign Recipient Estimation Job

Description

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

Tool Name: Create event

Description

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

Tool Name: Create list

Description

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

Tool Name: Create or Update Profile

Description

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
email
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

Tool Name: Create profile

Description

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

Tool Name: Get Campaign

Description

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

Tool Name: Get Campaigns

Description

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

Tool Name: Get events

Description

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

Tool Name: Get Lists

Description

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

Tool Name: Get Profiles

Description

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

Tool Name: Update Campaign

Description

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

Tool Name: Assign campaign message template

Description

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

Tool Name: Bulk create client events

Description

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

Tool Name: Bulk create events

Description

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

Tool Name: Create back in stock subscription

Description

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

Tool Name: Create campaign

Description

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

Tool Name: Create campaign clone

Description

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

Tool Name: Create campaign send job

Description

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

Tool Name: Create catalog category

Description

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

Tool Name: Create catalog category relationships items

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create catalog item

Description

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

Tool Name: Create catalog item relationships categories

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create catalog variant

Description

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

Tool Name: Create client back in stock subscription

Description

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

Tool Name: Create client event

Description

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

Tool Name: Create client subscription

Description

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

Tool Name: Create coupon

Description

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

Tool Name: Create coupon code

Description

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

Tool Name: Create or update client profile

Description

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

Tool Name: Create or update client push token

Description

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

Tool Name: Create or update push token

Description

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

Tool Name: Create segment

Description

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

Tool Name: Create tag

Description

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

Tool Name: Create tag group

Description

Create tag groups up to 50 per account, defaulting to non-exclusive unless specified. related resources can have multiple non-exclusive tags but only one if exclusive. rate limits: 3/s burst, 60/m steady. scopes needed: tags:read, tags:write.

Action Parameters

data__attributes__exclusive
boolean
data__attributes__name
string
data__type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create tag relationships campaigns

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create tag relationships flows

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create tag relationships lists

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create tag relationships segments

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create template

Description

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

Tool Name: Create template clone

Description

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

Tool Name: Create template render

Description

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

Tool Name: Create webhook

Description

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

Tool Name: Delete campaign

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete catalog category

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete catalog category relationships items

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete catalog item

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete catalog item relationships categories

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete catalog variant

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete coupon

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete coupon code

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete flow

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete list

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete segment

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete tag

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete tag group

Description

Delete a specified tag group and its contents; associated resource links will be removed. the default group is undeletable. rate limits: 3/s burst, 60/m steady. requires tags:read and tags:write permissions.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete tag relationships campaigns

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete tag relationships flows

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete tag relationships lists

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete tag relationships segments

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete template

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete webhook

Description

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

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get account

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get accounts

Description

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

Tool Name: Get bulk profile import job

Description

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

Tool Name: Get bulk profile import jobs

Description

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

Tool Name: Get bulk profile import job errors

Description

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
id
stringRequired
page__cursor
string
page__size
integerDefaults to 20

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get bulk profile import job lists

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get bulk profile import job profiles

Description

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
id
stringRequired
page__cursor
string
page__size
integerDefaults to 20

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get bulk profile import job relationships lists

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get bulk profile import job relationships profiles

Description

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

id
stringRequired
page__cursor
string
page__size
integerDefaults to 20

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign campaign messages

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign message

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign message campaign

Description

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

Action Parameters

fields__campaign
array
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign message relationships campaign

Description

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

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign message relationships template

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign message template

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign recipient estimation

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign recipient estimation job

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign relationships campaign messages

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign relationships tags

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign send job

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign tags

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get catalog categories

Description

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

Tool Name: Get catalog category

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get catalog category items

Description

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
id
stringRequired
include
array
page__cursor
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get catalog category relationships items

Description

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

id
stringRequired
page__cursor
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get catalog item

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get catalog items

Description

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

Tool Name: Get catalog item categories

Description

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
id
stringRequired
page__cursor
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get catalog item relationships categories

Description

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

id
stringRequired
page__cursor
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get catalog item variants

Description

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
id
stringRequired
page__cursor
string
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get catalog variant

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get catalog variants

Description

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

Tool Name: Get coupon

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get coupons

Description

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

Tool Name: Get coupon code

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get coupon codes

Description

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

Tool Name: Get coupon codes for coupon

Description

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
id
stringRequired
page__cursor
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get coupon code bulk create job

Description

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

Tool Name: Get coupon code bulk create jobs

Description

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

Tool Name: Get coupon code relationships coupon

Description

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

id
stringRequired
page__cursor
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get coupon for coupon code

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get coupon relationships coupon codes

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get create categories job

Description

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

Tool Name: Get create categories jobs

Description

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

Tool Name: Get create items job

Description

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

Tool Name: Get create items jobs

Description

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

Tool Name: Get create variants job

Description

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

Tool Name: Get create variants jobs

Description

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

Tool Name: Get delete categories job

Description

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

Tool Name: Get delete categories jobs

Description

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

Tool Name: Get delete items job

Description

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

Tool Name: Get delete items jobs

Description

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

Tool Name: Get delete variants job

Description

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

Tool Name: Get delete variants jobs

Description

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

Tool Name: Get event

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get event metric

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get event profile

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get event relationships metric

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get event relationships profile

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flows

Description

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

Tool Name: Get flow action

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow action for message

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow action messages

Description

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
id
stringRequired
page__size
integerDefaults to 50
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow action relationships flow

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow action relationships messages

Description

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
id
stringRequired
page__cursor
string
page__size
integerDefaults to 50
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow flow actions

Description

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
id
stringRequired
page__cursor
string
page__size
integerDefaults to 50
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow for flow action

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow message

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow message relationships action

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow message relationships template

Description

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

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow message template

Description

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

Action Parameters

fields__template
array
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow relationships flow actions

Description

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
id
stringRequired
page__size
integerDefaults to 50
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow relationships tags

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get flow tags

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get form

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get forms

Description

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

Tool Name: Get form for form version

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get form id for form version

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get form version

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get image

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get images

Description

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

Tool Name: Get list

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get list profiles

Description

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
id
stringRequired
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get list relationships profiles

Description

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
id
stringRequired
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get list relationships tags

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get list tags

Description

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

Action Parameters

fields__tag
array
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get metric

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get metrics

Description

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

Tool Name: Get profile

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get profile lists

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get profile relationships lists

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get profile relationships segments

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get profile segments

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get segment

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get segments

Description

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

Tool Name: Get segment profiles

Description

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
id
stringRequired
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get segment relationships profiles

Description

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
id
stringRequired
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get segment relationships tags

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get segment tags

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get tag

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get tags

Description

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

Tool Name: Get tag group

Description

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

Action Parameters

fields__tag__group
array
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get tag groups

Description

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

Tool Name: Get tag group relationships tags

Description

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

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get tag group tags

Description

Return the tags for a given tag group id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `tags:read`

Action Parameters

fields__tag
array
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get tag relationships campaigns

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get tag relationships flows

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get tag relationships lists

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get tag relationships segments

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get tag relationships tag group

Description

Returns the id of the tag group related to the given tag.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `tags:read`

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get tag tag group

Description

Returns the tag group resource for a given tag id.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `tags:read`

Action Parameters

fields__tag__group
array
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get template

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get templates

Description

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

Tool Name: Get update categories job

Description

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

Tool Name: Get update categories jobs

Description

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

Tool Name: Get update items job

Description

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

Tool Name: Get update items jobs

Description

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

Tool Name: Get update variants job

Description

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

Tool Name: Get update variants jobs

Description

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

Tool Name: Get versions for form

Description

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
id
stringRequired
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get version ids for form

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get webhook

Description

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
id
stringRequired
include
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get webhooks

Description

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

Tool Name: Get webhook topic

Description

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

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get webhook topics

Description

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

Tool Name: Merge profiles

Description

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

Tool Name: Query campaign values

Description

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

Tool Name: Query flow series

Description

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

Tool Name: Query flow values

Description

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

Tool Name: Query metric aggregates

Description

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

Tool Name: Remove Profile from List

Description

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

Tool Name: Request profile deletion

Description

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

Tool Name: Spawn bulk profile import job

Description

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

Tool Name: Spawn coupon code bulk create job

Description

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

Tool Name: Spawn create categories job

Description

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

Tool Name: Spawn create items job

Description

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

Tool Name: Spawn create variants job

Description

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

Tool Name: Spawn delete categories job

Description

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

Tool Name: Spawn delete items job

Description

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

Tool Name: Spawn delete variants job

Description

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

Tool Name: Spawn update categories job

Description

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

Tool Name: Spawn update items job

Description

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

Tool Name: Spawn update variants job

Description

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

Tool Name: Subscribe profiles

Description

The api supports double opt-in for marketing, with 'historical import' bypassing consent. it resets opt-outs for returning users. caps at 1000 profiles, 75/s, and 700/min. needs 'lists:write', 'profiles:write', 'subscriptions:write' permissions.

Action Parameters

data__attributes__custom__source
string
data__attributes__historical__import
boolean
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

Tool Name: Suppress profiles

Description

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

Tool Name: Unregister client push token

Description

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

Tool Name: Unsubscribe profiles

Description

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

Tool Name: Unsuppress profiles

Description

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

Tool Name: Update campaign message

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update campaign send job

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update catalog category

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update catalog category relationships items

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update catalog item

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update catalog item relationships categories

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update catalog variant

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update coupon

Description

*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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update coupon code

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update flow status

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update image

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update list

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update profile

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update segment

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update tag

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update tag group

Description

Update the tag group with the given tag group id. only a tag group's `name` can be changed. a tag group's `exclusive` or `default` value cannot be changed.<br /><br />*rate limits*:<br />burst: `3/s`<br />steady: `60/m` **scopes:** `tags:read` `tags:write`

Action Parameters

data__attributes__name
string
data__attributes__return__fields
array
data__id
string
data__type
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update template

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update webhook

Description

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
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Upload image from file

Description

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

Tool Name: Upload image from url

Description

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