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

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.

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

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

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

Returns the ID of the related campaign

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

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

Get all forms in an account.

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

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

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

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

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

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

Update a campaign message

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

Update a catalog category with the given category ID.

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

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. Important: The data__id in the request body must match the id path parameter. Returns HTTP 204 No Content on success. Rate limits: Burst: 3/s | Steady: 60/m Scopes: tags:read tags:write

Creates a non-reusable version of the template and assigns it to the message.

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

Bulk create events for multiple profiles in a single request. Accepts up to 1,000 events with a 5MB max payload. Each event requires a profile identifier (email, phone_number, or external_id) and a metric name. Events are processed asynchronously; a 202 response indicates acceptance, not completion. Rate limits: 10/s burst, 150/min steady.

Cancel or revert a campaign send job. Use 'cancel' to permanently stop a campaign (status becomes CANCELED), or 'revert' to return it to DRAFT for editing. This action modifies a campaign send job that is currently queued or sending. The cancel action is irreversible and sets the status to CANCELED. The revert action returns the campaign to DRAFT status, allowing further modifications. Rate limits: 10/s burst, 150/m steady. Required scope: campaigns:write. Preconditions: - Valid API key with campaigns:write scope - Campaign send job ID must exist and be accessible - Campaign must be in a state that allows cancellation (queued or sending)

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.

Creates a campaign given a set of parameters, then returns it.

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

Clones an existing campaign, returning a new campaign based on the original with a new ID and name.

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

Trigger a campaign to send asynchronously

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

Create a new catalog category.

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

Create a new item relationship for the given category ID.

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

Create a new catalog item.

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

Create a new catalog category relationship for the given item ID.

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

Create a new variant for a related catalog item.

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

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.

Create a client-side event in Klaviyo to track user interactions. This action uses the company_id in the request body instead of as a query parameter. Use when tracking events from publicly-browseable, client-side environments with a public API key.

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

Creates a new coupon.

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

Synchronously creates a coupon code for the given coupon.

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

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.

Create a new list.

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

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.

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.

Create or update a push token for mobile push notifications. This server-side endpoint is used for migrating push tokens from other platforms to Klaviyo. For creating tokens from mobile devices, use Klaviyo's mobile SDKs instead. Prerequisites: Push notifications must be enabled for the Klaviyo account. Required fields: - data__type: Must be 'push-token' - data__attributes__token: The push token from APNS or FCM - data__attributes__platform: 'ios' or 'android' - data__attributes__vendor: 'apns' (iOS) or 'fcm' (Android) - data__attributes__profile__data__type: Must be 'profile' - At least one profile identifier (email, phone_number, external_id, anonymous_id, or profile id) Rate limits: 75/s burst, 700/m steady. Max payload: 100KB. Requires scopes: profiles:write, push-tokens:write

Create a new profile.

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

Create a segment.

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

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

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.

Associate a tag with other resources (flows, lists, segments, or campaigns) in Klaviyo. Use when you need to link a tag to one or more resources for organizational purposes. Note: A resource can have up to 100 tags associated with it. Rate limits: 3/s burst, 60/m steady. Required scopes vary by resource type: tags:write plus the appropriate write scope (flows:write, lists:write, segments:write, or campaigns:write).

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.

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.

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.

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

Delete a campaign with the given campaign ID.

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

Delete a catalog category using the given category ID.

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

Delete item relationships for the given category ID.

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

Delete a catalog item with the given item ID.

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

Delete catalog category relationships for the given item ID.

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

Delete a catalog item variant with the given variant ID.

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

Delete the coupon with the given coupon ID.

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

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

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

Delete a flow with the given flow ID.

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

Delete a list with the given list ID.

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

Delete a segment with the given segment ID.

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

Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.

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

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.

Remove a tag's association with other resources like flows, campaigns, lists, or segments. Use when you need to untag resources without deleting the tag itself.

Permanently delete a template from your Klaviyo account using its unique template ID. This action is destructive and cannot be undone. Rate limits: Burst 10/s, Steady 150/m. Requires 'templates:write' scope.

Permanently delete a webhook subscription from your Klaviyo account. This action removes the webhook configuration, stopping all future event notifications to the webhook's endpoint URL. This operation is irreversible. Requirements: - Advanced KDP (Klaviyo Data Platform) must be enabled on your account - API key must have webhooks:write scope Rate limits: Burst: 1/s, Steady: 15/m Returns: HTTP 204 No Content on successful deletion (empty response body).

Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.

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

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.

Tool to get a coupon code bulk create job with the given job ID. Use when you need to check the status of a previously initiated bulk coupon code creation job. Rate limits: 75/s burst, 700/m steady. Required scope: coupon-codes:read.

Get a catalog item bulk delete job with the given job ID. Use this to check the status and progress of a bulk delete operation for catalog items. Rate limits: 350/s burst, 3500/m steady. Required scope: catalogs:read. Preconditions: - Valid API key with catalogs:read scope - Job ID must exist and be accessible

Get a bulk profile import job with the given job ID.

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

Get import errors for the bulk profile import job with the given ID.

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

Get list for the bulk profile import job with the given ID.

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

Get profiles for the bulk profile import job with the given ID.

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

Get list relationship for the bulk profile import job with the given ID.

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

Get profile relationships for the bulk profile import job with the given ID.

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

Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.

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

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.

Retrieve a catalog category bulk update job by its ID from Klaviyo. This action fetches the status and details of a bulk update job for catalog categories, including progress metrics (total, completed, failed counts) and optionally the related category resources. Use this to track the progress of bulk category update operations. Rate limits: 350/s burst, 3500/m steady. Required scope: catalogs:read. Preconditions: - Valid API key with catalogs:read scope - Job ID must exist and be accessible

Tool to retrieve a catalog variant bulk update job by its ID. Use when you need to check the status, progress, or results of a bulk update operation on catalog variants.

Return all messages that belong to the given campaign.

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

Returns a specific message based on a required id.

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

Return the related campaign

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

Returns the ID of the related template

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

Return the related template

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

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.

Retrieve the status of a recipient estimation job triggered with the Create Campaign Recipient Estimation Job endpoint.

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

Returns the IDs of all messages associated with the given campaign.

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

Returns the IDs of all tags associated with the given campaign.

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

Get a campaign send job

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

Return all tags that belong to the given campaign.

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

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.

Get a catalog category with the given category ID.

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

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.

Get all items in the given category ID. Returns a maximum of 100 items per request.

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

Get a specific catalog item with the given item ID.

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

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.

Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.

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

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.

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.

Get a catalog item variant with the given variant ID.

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

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.

Get a specific coupon with the given coupon ID.

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

Returns a Coupon Code specified by the given identifier.

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

Get a coupon code bulk create job with the given job ID.

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

Get all coupon code bulk create jobs. Returns a maximum of 100 jobs per request.

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

Gets a list of coupon code relationships associated with the given coupon id

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

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

Gets a list of coupon codes associated with the given coupon id

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

Get the coupon associated with a given coupon code ID.

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

Tool to get the coupon relationship associated with a given coupon code ID. Use when you need to find which coupon is associated with a specific coupon code. Rate limits: Burst: 75/s, Steady: 700/m Required scope: coupons:read

Retrieves the coupon code relationships (resource identifiers) for a given coupon. Returns a list of coupon code IDs associated with the specified coupon, along with pagination links for navigating large result sets. Rate limits: Burst: 75/s, Steady: 700/m Required scopes: coupons:read

Get all coupons in an account. To learn more, see our