> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Klaviyo

## Overview

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (API Key) | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | End-user authorization guide | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ Read & write data
>
> | Tools | Status |
> | - | - |
> | Pre-built integrations | ✅ |
> | API unification | ✅ |
> | 2-way sync | ✅ |
> | Webhooks from Nango on data modifications | ✅ |
> | Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
> | Proxy requests | ✅ |

> [accordion] ✅ Observability & data quality
>
> | Tools | Status |
> | - | - |
> | HTTP request logging | ✅ |
> | End-to-end type safety | ✅ |
> | Data runtime validation | ✅ |
> | OpenTelemetry export | ✅ |
> | Slack alerts on errors | ✅ |
> | Integration status API | ✅ |

> [accordion] ✅ Customization
>
> | Tools | Status |
> | - | - |
> | Create or customize use-cases | ✅ |
> | Pre-configured pagination | 🚫 (time to contribute: \<48h) |
> | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
> | Per-customer configurations | ✅ |

### Others

| Function name | Description | Type |
| - | - | - |
| `add-profiles-to-list` | Add profiles to a list. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `assign-template-to-campaign-message` | Assign a reusable template's content to a campaign message. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `bulk-import-profiles` | Bulk-import profiles, optionally onto a list. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-campaign` | Create a draft email or SMS campaign | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-catalog-category` | Create a catalog category. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-catalog-item` | Create a catalog item (product). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-catalog-variant` | Create a variant of a catalog item. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-coupon-code` | Create a unique coupon code under a coupon | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-coupon` | Create a coupon. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-event` | Create an event | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-image` | Upload an image from a URL. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-list` | Create a list. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-profile` | Create a profile. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-segment` | Create a segment from a condition definition. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-tag-group` | Create a tag group. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-tag` | Create a tag. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-template` | Create an HTML email template. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-campaign` | Delete a campaign. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-catalog-category` | Delete a catalog category | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-catalog-item` | Delete a catalog item. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-catalog-variant` | Delete a catalog variant. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-coupon-code` | Delete a coupon code. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-coupon` | Delete a coupon. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-flow` | Delete a flow. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-list` | Delete a list. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-segment` | Delete a segment. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-tag-group` | Delete a tag group. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-tag` | Delete a tag. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-template` | Delete a template. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-campaign` | Retrieve a campaign. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-image` | Retrieve an image. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-list` | Retrieve a list. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-profile` | Retrieve a profile. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-segment` | Retrieve a segment. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-template` | Retrieve a template. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-campaigns` | List campaigns. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-catalog-categories` | List catalog categories. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-catalog-items` | List catalog items. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-catalog-variants` | List catalog item variants. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-coupon-codes` | List coupon codes. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-coupons` | List coupons. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-events` | List events. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-flows` | List flows. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-forms` | List forms. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-images` | List images. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-lists` | List lists. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-metrics` | List metrics. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-profiles` | List profiles. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-reviews` | List product reviews. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-segments` | List segments. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-tag-groups` | List tag groups. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-tags` | List tags. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-templates` | List templates. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-webhooks` | List webhook subscriptions. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `merge-profiles` | Merge one profile into another. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `query-campaign-values-report` | Query aggregate performance metrics for campaigns. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `query-metric-aggregates` | Query aggregated event data for a metric | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `remove-profiles-from-list` | Remove profiles from a list. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `request-profile-deletion` | Submit a GDPR/CCPA data-privacy deletion request for a profile. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `send-campaign` | Send a campaign immediately. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `subscribe-profiles` | Subscribe profiles to email/SMS marketing on a list. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `unsubscribe-profiles` | Unsubscribe profiles from email/SMS marketing on a list. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-campaign` | Update a campaign's name, audiences, or send strategy. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-flow-status` | Update a flow's status (draft/manual/live/archived). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-list` | Update a list. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-profile` | Update a profile | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-segment` | Update a segment's name or definition. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-tag` | Rename a tag. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-template` | Update a template. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `campaigns` | Sync campaigns. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `catalog-categories` | Sync catalog categories. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `catalog-items` | Sync catalog items (products) | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `coupon-codes` | Sync coupon codes. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `coupons` | Sync coupons. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `events` | Sync events. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `flows` | Sync flows. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `forms` | Sync forms. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `images` | Sync images. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `lists` | Sync lists. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `metrics` | Sync metrics. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `profiles` | Sync profiles. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `reviews` | Sync product reviews | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `segments` | Sync segments. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `tags` | Sync tags. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `templates` | Sync templates. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

## Access requirements

| Pre-Requisites | Status | Comment |
| - | - | - |
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ | |

## Setup guide

*No setup guide yet.*

> [!TIP]
>
> Need help getting started? Get help in the [community](https://nango.dev/slack).

> [!NOTE]
>
> Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/klaviyo.mdx)

## Useful links

* [How to generate private & public API keys in your Klaviyo account](https://developers.klaviyo.com/en/docs/authenticate_)
* [API docs](https://developers.klaviyo.com/en/reference)
* [API Key rate limiting](https://developers.klaviyo.com/en/docs/rate_limits_and_error_handling)
* [API Key auth related docs](https://developers.klaviyo.com/en/docs/authenticate_)
* [API Key scopes](https://developers.klaviyo.com/en/reference/api_overview#api-key-scopes)
* [How to generate an OAuth application](https://developers.klaviyo.com/en/docs/set_up_oauth#create-an-oauth-integration-in-klaviyo)
* [OAuth related docs](https://developers.klaviyo.com/en/docs/set_up_oauth#oauth-authorization-code-flow)
* [List of OAuth scopes](https://developers.klaviyo.com/en/docs/retrieve_api_credentials#scopes)

> [!NOTE]
>
> Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/klaviyo.mdx)

## API gotchas

* For `API_KEY` auth mode, `Klaviyo` uses Public and Private API Keys to access different endpoints. Endpoints that begin with `/api` need to be authenticated with the private API key, while endpoints that begin with `/client` need to be authenticated using the public API key.
* If you want to use a different API version than the default one set in Nango you can override the `revision` by adding in the necessary header. For more details check [Klaviyo API versioning](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy#api-versioning)
* Rate limiting in `klaviyo-oauth` is different from the [standard API rate limiting](https://developers.klaviyo.com/en/docs/rate_limits_and_error_handling). For more details check [klaviyo-oauth rate limits](https://developers.klaviyo.com/en/docs/set_up_oauth#rate-limits)

> [!NOTE]
>
> Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/klaviyo.mdx)

> [card] [Connect to Klaviyo](https://nango.dev/docs/integrations/all/klaviyo/connect)
>
> Guide to connect to Klaviyo using Nango Connect.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.