Klaviyo

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

Untrusted display-only summary

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`

Untrusted display-only summary

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.

Untrusted display-only summary

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…

Untrusted display-only summary

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…

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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`

Untrusted display-only summary

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, an…

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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 lim…

Untrusted display-only summary

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 field…

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary