Klaviyo

Returns the requested campaign analytics values data *Rate limits*: Burst: `1/s` Steady: `2/m` Daily: `225/d` **Scopes:** `campaigns:read`

Untrusted display-only summary

Returns time-series analytics data for flows, enabling performance tracking over time intervals. Use this to analyze flow metrics like open rates, click rates, conversions, and delivery statistics. Rate limits: Burst 1/s, Steady 2/m, Daily 225/d. Scopes: flows:read

Untrusted display-only summary

Returns the requested flow analytics values data *Rate limits*: Burst: `1/s` Steady: `2/m` Daily: `225/d` **Scopes:** `flows:read`

Untrusted display-only summary

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

Untrusted display-only summary

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. R…

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max 1000 coupon codes per job. Max 100 jobs queued at once. Rate limits: Burst 75/s, Steady 700/m. Scopes: coupon-codes:write. Returns a job ID that can be used to query the job status via the get_coupon_code_bulk_create_job endpoint.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

Tool to unsubscribe one or more profiles from a Klaviyo list. Use when you need to bulk unsubscribe up to 100 profiles from email or SMS marketing for a specific list.

Untrusted display-only summary

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

Untrusted display-only summary

Tool to unsuppress one or more profiles from email marketing by email address. Use when you need to remove USER_SUPPRESSED status from profiles. This only removes suppressions with reason USER_SUPPRESSED; profiles with HARD_BOUNCE or INVALID_EMAIL suppressions remain unchanged. Returns a job object that can be monitor…

Untrusted display-only summary

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

Untrusted display-only summary

Update a campaign message *Rate limits*: Burst: `10/s` Steady: `150/m` **Scopes:** `campaigns:write`

Untrusted display-only summary

Update a catalog category with the given category ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write`

Untrusted display-only summary

Tool to update item relationships for a catalog category. Replaces all existing item relationships with the provided list. Use when you need to associate catalog items with a category or remove existing associations. Pass an empty data array to remove all item relationships from the category. Rate limits: 75/s burst,…

Untrusted display-only summary

Update item relationships for the given category ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write`

Untrusted display-only summary

Update a catalog item with the given item ID. *Rate limits*: Burst: `75/s` Steady: `700/m` **Scopes:** `catalogs:write`

Untrusted display-only summary