Action

Description

Required scopes

Get Accounts

Retrieve all Klaviyo accounts associated with the current API key. Always returns exactly one account object per key.

Get Account

Retrieve detailed configuration for a specific Klaviyo account by its unique account ID.

List Campaigns

List email, SMS, or push campaigns with required channel filter and optional sorting and pagination.

Get Campaign

Retrieve complete details for a single campaign by its unique ID, including status, audiences, send strategy, and tracki...

Create Campaign

Create a new email, SMS, or mobile push campaign as a draft. Requires specifying the channel, audiences, and at least on...

Update Campaign

Update campaign properties such as name, target audiences, send strategy, or tracking options before the campaign is sen...

Delete Campaign

Permanently delete a campaign by ID. This action cannot be undone. Only Draft campaigns can be deleted.

Clone Campaign

Duplicate an existing campaign to create a new Draft campaign, optionally giving it a new name.

Get Campaign Recipient Estimation

Get the current estimated number of recipients for a campaign based on its configured audiences.

Refresh Campaign Recipient Estimation

Trigger an asynchronous job that (re)computes the estimated recipient count for a campaign, so get\_campaign\_recipient\_es...

Get Campaign Recipient Estimation Job

Check the status of an estimation job previously triggered by refresh\_campaign\_recipient\_estimation.

Get Tags For Campaign

Retrieve all tags associated with a specific campaign for organizational and filtering purposes.

Get Messages For Campaign

Retrieve all campaign messages (email, SMS, or push variants) that belong to a specific campaign.

Get Campaign Message

Retrieve full details for a specific campaign message by its unique ID, including channel-specific content and render op...

Update Campaign Message

Update the content and settings of a campaign message, including channel-specific fields such as subject, body, sender i...

Assign Template To Campaign Message

Assign an email template to a campaign message, creating a non-reusable snapshot of the template's HTML for that message...

Send Campaign

Trigger a campaign to send immediately (or at its configured scheduled time) by creating an asynchronous send job. Campa...

Cancel Campaign Send

Cancel an in-progress campaign send job or revert a scheduled campaign back to Draft status. Campaign must be in Schedul...

List Catalog Items

List all product catalog items in the account with filtering by title, category, or IDs, sorting by creation date, and c...

Create Catalog Item

Create a new product catalog item with title, description, URL, price, and images, optionally assigning it to one or mor...

Get Catalog Item

Retrieve the full details of a specific catalog item by its compound ID, with optional variant inclusion and sparse fiel...

Update Catalog Item

Update an existing catalog item's title, description, URL, price, images, or published status using PATCH semantics - on...

Delete Catalog Item

Permanently delete a catalog item by its compound ID, removing it from all recommendation feeds and product blocks.

Bulk Create Catalog Items

Submit an asynchronous bulk job to create up to 100 catalog items in a single request, returning a job ID to poll for co...

Bulk Update Catalog Items

Submit an asynchronous bulk job to update up to 100 existing catalog items in a single request, returning a job ID to po...

Bulk Delete Catalog Items

Submit an asynchronous bulk job to permanently delete up to 100 catalog items in a single request, returning a job ID to...

List Catalog Categories

List all product catalog categories in the account with filtering by name or item membership, sorting by creation date,...

Create Catalog Category

Create a new product catalog category with an external ID and display name, optionally assigning catalog items to it at...

Get Catalog Category

Retrieve the full details of a specific catalog category by its compound ID, including its name and external ID.

Update Catalog Category

Update an existing catalog category's name or item associations using PATCH semantics - only supplied fields are changed...

Delete Catalog Category

Permanently delete a catalog category by its compound ID, removing the category grouping without deleting the items it c...

Bulk Create Catalog Categories

Submit an asynchronous bulk job to create up to 100 catalog categories in a single request, returning a job ID to poll f...

Bulk Update Catalog Categories

Submit an asynchronous bulk job to update up to 100 existing catalog categories in a single request, returning a job ID...

Bulk Delete Catalog Categories

Submit an asynchronous bulk job to permanently delete up to 100 catalog categories in a single request, returning a job...

List Catalog Variants

List all product catalog variants in the account with filtering by item, SKU, title, or published status, sorting by cre...

Create Catalog Variant

Create a new catalog variant (size, color, or style variation) for an existing catalog item, with SKU, inventory, price,...

Get Catalog Variant

Retrieve the full details of a specific catalog variant by its compound ID, including SKU, inventory quantity, price, an...

Update Catalog Variant

Update an existing catalog variant's SKU, price, inventory quantity, title, images, or published status using PATCH sema...

Delete Catalog Variant

Permanently delete a catalog variant by its compound ID, removing it from recommendation feeds and back-in-stock subscri...

Bulk Create Catalog Variants

Submit an asynchronous bulk job to create up to 100 catalog variants in a single request, each linked to an existing par...

Bulk Update Catalog Variants

Submit an asynchronous bulk job to update up to 100 existing catalog variants in a single request, returning a job ID to...

Bulk Delete Catalog Variants

Submit an asynchronous bulk job to permanently delete up to 100 catalog variants in a single request, returning a job ID...

Get Items For Catalog Category

List all catalog items that belong to a specific catalog category, with sparse fieldsets, optional variant inclusion, fi...

Add Items To Catalog Category

Additively associate one or more catalog items with a specific category without replacing existing item memberships.

Remove Items From Catalog Category

Remove specific catalog items from a category's membership without affecting other items already in the category.

Add Categories To Catalog Item

Additively assign one or more catalog categories to a specific item without replacing its existing category memberships.

Remove Categories From Catalog Item

Remove specific category assignments from a catalog item without affecting the item's other category memberships.

Create Back In Stock Subscription

Subscribe an existing profile to back-in-stock notifications for a specific catalog variant via EMAIL, PUSH, or SMS chan...

Create Client Event

Track a client-side event from a browser or mobile app using the public API key. No server-side credentials required.

Create Client Profile

Create or update a Klaviyo profile from client-side code using the public API key. Safe for use in browser and mobile ap...

List Coupons

List all coupons in the account with optional sparse fieldsets and cursor-based pagination.

Create Coupon

Create a new coupon container with a unique external ID, matching your e-commerce platform's coupon identifier.

Get Coupon

Retrieve complete details for a specific coupon by its unique Klaviyo coupon ID.

Update Coupon

Update the description or monitor configuration of an existing coupon. The external\_id cannot be changed after creation....

Delete Coupon

Permanently delete a coupon and all its associated coupon codes. This action is irreversible. Note: Shopify-originated c...

List Coupon Codes

List coupon codes filtered by coupon ID or profile ID. A filter specifying coupon.id or profile.id is required.

Create Coupon Code

Create a single unique coupon code and associate it with an existing coupon. Use bulk\_create\_coupon\_codes for creating m...

Get Coupon Code

Retrieve full details for a specific coupon code by its unique ID, including its status, unique code value, and expirati...

Update Coupon Code

Update the status or expiration date of an existing coupon code. Useful for manually marking codes as used or extending...

Delete Coupon Code

Permanently delete a single coupon code by its ID. This action is irreversible.

Bulk Create Coupon Codes

Create up to 1000 coupon codes in a single bulk job, associating each with an existing coupon.

List Events

List Klaviyo events (customer activity records) with optional filtering by metric, profile, or date range.

Create Event

Track a server-side customer activity event for a profile, such as a purchase, page view, or custom business action.

Get Event

Retrieve complete details for a specific event by its unique ID, including all event properties and optional metric and...

Bulk Create Events

Efficiently ingest up to 1000 events in a single asynchronous bulk job, grouped by profile for high-volume tracking scen...

List Flows

List all Klaviyo automation flows with optional filtering by name, status, trigger type, and date, plus pagination and s...

Get Flow

Retrieve the full configuration of a specific Klaviyo flow by its unique ID, including trigger definition and optional f...

Get Flow Action

Retrieve detailed configuration for a single flow action step by its unique ID, including its type, branching links, and...

Get Flow Message

Retrieve the content and configuration of a specific flow message by its ID, including channel-specific content and temp...

List Flow Actions For Flow

List all action steps for a specific flow with pagination, filtering by action type or status, and sorting.

Get Tags For Flow

Retrieve all tags associated with a specific flow for organizational and categorization purposes.

Get Flow Action Messages

List all message variants associated with a specific flow action step, with pagination, filtering, and sorting options.

Create Flow

Create a new Klaviyo automation flow with a trigger, chained actions, and optional profile filters. Use this to programm...

Delete Flow

Permanently delete a flow and all its actions by flow ID. Use this to remove test flows or decommission automation workf...

Update Flow Action

Update a single action within a flow — change email subject lines, SMS body text, delay durations, split conditions, or...

List Forms

List all signup forms and pop-ups in the account with filtering, sorting, and cursor-based pagination up to 100 results...

Get Form

Retrieve the full configuration and version history for a specific Klaviyo form by its unique ID.

Create Form

Create a new Klaviyo form — popup, flyout, embed, banner, or full screen. Use this to programmatically deploy signup for...

Delete Form

Permanently delete a form by its ID. Use this to remove test forms or decommission form experiences. This action cannot...

List Images

List all images in the Klaviyo asset library with filtering by name, format, size, or visibility, plus sorting and pagin...

Upload Image From URL

Import an image into the Klaviyo asset library from a public URL or a base64-encoded data URI.

Get Image

Retrieve complete metadata for a specific image in the Klaviyo asset library by its unique ID.

Update Image

Update the name or visibility (hidden status) of an existing image in the Klaviyo asset library.

List Lists

List all subscriber lists in the account with filtering by name or timestamps, sorting, and cursor-based pagination up t...

Create List

Create a new subscriber list with a specified name and opt-in process (single or double opt-in) for managing profile sub...

Get List

Retrieve the full details of a specific subscriber list by its unique ID, with optional profile count, tags, and flow tr...

Update List

Update the name or opt-in process (single vs double opt-in) of an existing subscriber list using PATCH semantics.

Delete List

Permanently delete a subscriber list from the account - this removes the list definition but does not delete the profile...

Get Tags For List

Retrieve all tags that have been applied to a specific subscriber list, returning full tag objects including their names...

Get Profiles For List

Retrieve all profile members of a subscriber list with filtering, sorting by join date, and cursor-based pagination up t...

Add Profiles To List

Add one or more existing profiles to a subscriber list by their profile IDs, up to 1000 profiles per call.

Remove Profiles From List

Remove one or more profiles from a subscriber list by their profile IDs, up to 1000 per call, without affecting their su...

Get Flows Triggered By List

Retrieve all automation flows that use a specific subscriber list as their trigger, useful for understanding dependencie...

List Metrics

List all event metric types tracked in the Klaviyo account, including built-in and integration-specific metrics, up to 2...

Get Metric

Retrieve complete details for a specific event metric type by its unique ID, including integration source and optional f...

Query Metric Aggregates

Query aggregated event data for a metric over a date range, with grouping by time intervals, campaign, flow, channel, or...

Get Metric Property

Retrieve the definition and inferred data type of a specific metric property, with optional sample values for reference.

Get Flows Triggered By Metric

Retrieve all automation flows that use a specific metric as their entry trigger event.

List Custom Metrics

List all custom composite metrics in the account that combine multiple underlying metrics into a single unified reportin...

Create Custom Metric

Create a new custom composite metric that aggregates multiple base metrics into a single unified metric for attribution...

Get Custom Metric

Retrieve the full definition and composition details for a specific custom composite metric by its unique ID.

Update Custom Metric

Update the name or definition of an existing custom composite metric using PATCH semantics.

Delete Custom Metric

Permanently delete a custom composite metric from the account by its unique ID.

List Profiles

List all customer profiles in the account with rich filtering, sorting, subscription and predictive analytics data, up t...

Get Profile

Retrieve the complete data for a specific customer profile by its Klaviyo ID, including optional subscription consent, l...

Create Profile

Create a new customer profile with contact details, location, and custom properties; at least one of email, phone\_number...

Update Profile

Update an existing customer profile's contact details, location, or custom properties using PATCH semantics, with suppor...

Get Lists For Profile

Retrieve all subscriber lists that a specific profile is a member of, returning full list objects with name, opt-in proc...

Get Segments For Profile

Retrieve all dynamic and static segments that a specific profile currently qualifies for, returning full segment objects...

Merge Profiles

Permanently merge one or more source profiles into a destination profile, consolidating their event history, list member...

Bulk Import Profiles

Submit an asynchronous bulk import job to create or update up to 10,000 profiles in a single request, with optional list...

Get List For Bulk Import Profiles Job

Retrieve the subscriber list(s) that profiles were added to during a specific bulk profile import job, useful for verify...

Get Profiles For Bulk Import Profiles Job

Retrieve all profiles that were successfully created or updated by a completed bulk profile import job, with pagination...

Request Profile Deletion

Submit a GDPR/CCPA-compliant data deletion request for a profile identified by email, phone number, or Klaviyo profile I...

Query Campaign Values

Generate a campaign performance report with aggregate statistics (opens, clicks, revenue, conversions) for a given timef...

Query Flow Values

Generate a flow performance report with aggregate statistics (opens, clicks, revenue, conversions) broken down by flow,...

Query Flow Series

Generate a time-series flow performance report with statistics aggregated into daily, weekly, monthly, or hourly interva...

Query Segment Values

Generate a segment membership report showing how many profiles were added, removed, or are currently in a segment over a...

Query Segment Series

Generate a time-series segment membership report with statistics aggregated into daily, weekly, monthly, or hourly inter...

List Segments

List all segments in the account with filtering by name, status, or timestamps, sorting, and cursor-based pagination, in...

Create Segment

Create a new segment with complex condition groups

Get Segment

Retrieve the full details of a specific segment by its unique ID, including its condition definition, active status, and...

Update Segment

Update an existing segment with new properties or definition

Delete Segment

Permanently delete a segment from the account by its unique ID - this removes the segment definition but does not delete...

Get Tags For Segment

Retrieve all tags applied to a specific segment, returning full tag objects with their names for auditing and UI display...

Get Profiles For Segment

Retrieve all profiles currently matching a segment's conditions, with filtering by contact details or join date, sorting...

Get Flows Triggered By Segment

Retrieve all automation flows that use a specific segment as their trigger, useful for understanding dependencies before...

List Tags

List all tags in the account with cursor-based pagination, name filtering, and optional tag group inclusion, up to 50 re...

Create Tag

Create a new tag, optionally associating it with a specific tag group, or it defaults to the account's default tag group...

Get Tag

Retrieve complete details for a specific tag by its unique ID, including optional tag group relationship.

Update Tag

Update the name of an existing tag by its unique ID using PATCH semantics.

Delete Tag

Permanently delete a tag and automatically remove all its associations with campaigns, flows, lists, and segments.

Get Flow IDs For Tag

Retrieve the IDs of all automation flows that are associated with a specific tag.

Tag Flows

Apply a tag to one or more automation flows to organize and categorize them in the Klaviyo UI.

Get Campaign IDs For Tag

Retrieve the IDs of all campaigns that are associated with a specific tag.

Tag Campaigns

Apply a tag to one or more campaigns to organize and categorize them in the Klaviyo UI.

Get List IDs For Tag

Retrieve the IDs of all subscriber lists that are associated with a specific tag.

Tag Lists

Apply a tag to one or more subscriber lists to organize and categorize them in the Klaviyo UI.

Get Segment IDs For Tag

Retrieve the IDs of all segments that are associated with a specific tag.

Tag Segments

Apply a tag to one or more audience segments to organize and categorize them in the Klaviyo UI.

List Tag Groups

List all tag groups in the account with filtering by name, exclusivity, or default status, and cursor-based pagination u...

Create Tag Group

Create a new tag group to organize related tags under a shared category, with optional exclusivity enforcement across th...

Get Tag Group

Retrieve the full details of a specific tag group by its unique ID, including its name, exclusivity setting, and default...

Update Tag Group

Update the name of an existing tag group using PATCH semantics - only the name can be changed, not the exclusivity or de...

Delete Tag Group

Permanently delete a tag group and all of its tags and their resource associations - the account's default tag group can...

Get Tags For Tag Group

Retrieve all tags that belong to a specific tag group, returning the full tag objects including their names.

List Templates

List all email templates in the account with filtering by name or timestamps, sorting, and cursor-based pagination up to...

Create Template

Create a new email template with custom HTML content or a drag-and-drop structure, for use in campaigns and automated fl...

Get Template

Retrieve the full HTML content and metadata for a specific email template by its unique ID.

Update Template

Update the HTML content, plaintext version, AMP version, or name of an existing email template using PATCH semantics - n...

Delete Template

Permanently delete an email template from the account by its unique ID - this action cannot be undone.

Render Template

Render an email template with sample profile context data to preview the final HTML, plaintext, and AMP output before se...

Clone Template

Create a duplicate copy of an existing email template with an optional new name, useful for creating variations without...

List Universal Content

List all reusable universal content blocks in the account with filtering by name, content type, or timestamps, sorting,...

Create Universal Content

Create a new reusable universal content block (button, image, text, HTML, spacer, horizontal rule, or drop shadow) that...

Get Universal Content

Retrieve the full definition and metadata of a specific universal content block by its unique ID, including block type,...

Update Universal Content

Update the name or block definition of an existing universal content block using PATCH semantics - changes propagate to...

Delete Universal Content

Permanently delete a universal content block from the account - any templates that embed this block will lose the refere...

List Webhooks

List all webhook subscriptions configured in the account, with optional inclusion of their subscribed topic definitions.

Get Webhook

Retrieve the full configuration details of a specific webhook subscription by its unique ID, including endpoint URL, ena...

Create Webhook

Create a new webhook subscription with an HTTPS endpoint URL, signing secret, and one or more event topic subscriptions...

Update Webhook

Update a webhook's name, endpoint URL, signing secret, enabled status, or topic subscriptions using PATCH semantics - us...

Delete Webhook

Permanently delete a webhook subscription from the account, stopping all event notifications to that endpoint.

List Webhook Topics

Retrieve all available webhook event topics that can be subscribed to, returning topic IDs and descriptions for use when...

Get Webhook Topic

Retrieve the full details of a specific webhook topic by its ID, including the event schema, payload structure, and desc...