Create campaign send job
Trigger a campaign to send asynchronously<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:write`
Create catalog category
Create a new catalog category.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Create catalog category relationships items
Create a new item relationship for the given category id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Create catalog item
Create a new catalog item.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Create catalog item relationships categories
Create a new catalog category relationship for the given item id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Create catalog variant
Create a new variant for a related catalog item.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Create client back in stock subscription
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…
Create client event
Create client-side events to track profiles using a public api key, not for updating identifiers (server-side only). rate limits: 350/s, 3500/m. use `events:write` scope.
Create client subscription
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 'sub…
Create coupon
Creates a new coupon.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `coupons:write`
Create coupon code
Synchronously creates a coupon code for the given coupon.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `coupon-codes:write`
Create event
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:w…
Create list
Create a new list.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m`<br>daily: `100/d` **scopes:** `lists:write`
Create or update client profile
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 w…
Create or update client push token
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 pos…
Create or Update Profile
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 …
Create or update push token
Migrate or create push tokens with klaviyo's endpoint, utilizing their mobile sdks for ios & android. rate limits: 75/s burst, 700/m steady. requires profiles:write and push-toke…
Create profile
Create a new profile.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `profiles:write`
Create segment
Create a segment.<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `15/m`<br>daily: `100/d` **scopes:** `segments:write`
Create tag
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 …
Create tag group
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 limit…
Create tag relationships campaigns
Summary: link a tag to campaigns, ensuring a limit of 100 tags per campaign. campaign ids should be sent via request body. rate limit: 3/s, 60/m. required scopes: campaigns:write…
Create tag relationships flows
Assign tags to flows using their ids in the request body, ensuring a flow is not linked to over 100 tags. rate limits are 3/s burst and 60/m steady. required scopes: `flows:write…
Create tag relationships lists
Summary: a tag can be added to one or more lists, with a max of 100 tags per list. use the request body to link tag and list ids. tag: #apiusagelimits scopes: lists:write, tags:w…
Create tag relationships segments
Summary: set tag associations with segments using the request body, limited to one tag per segment and up to 100 tags per segment. rate limits are three requests per second and s…
Create template
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 1…
Create template clone
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:w…
Create template render
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 webhook
Create a new webhook<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `15/m` **scopes:** `webhooks:write`
Delete campaign
Delete a campaign with the given campaign id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:write`
Delete catalog category
Delete a catalog category using the given category id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Delete catalog category relationships items
Delete item relationships for the given category id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Delete catalog item
Delete a catalog item with the given item id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Delete catalog item relationships categories
Delete catalog category relationships for the given item id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Delete catalog variant
Delete a catalog item variant with the given variant id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Delete coupon
Delete the coupon with the given coupon id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `coupons:write`
Delete coupon code
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<br><br>*rate limits*:<br>bur…
Delete flow
Delete a flow with the given flow id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `flows:write`
Delete list
Delete a list with the given list id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `lists:write`
Delete segment
Delete a segment with the given segment id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `segments:write`
Delete tag
Delete the tag with the given tag id. any associations between the tag and other resources will also be removed.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:…
Delete tag group
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:rea…
Delete tag relationships campaigns
Disconnect a tag from campaigns using the campaign id(s) in the request body. rate limits: 3 requests/second, 60 requests/minute. required scopes: campaigns:write, tags:write.
Delete tag relationships flows
Remove a tag's association with one or more flows. use the request body to pass in the id(s) of the flows(s) whose association with the tag will be removed.<br><br>*rate limits*:…
Delete tag relationships lists
Remove a tag's association with one or more lists. use the request body to pass in the id(s) of the list(s) whose association with the tag will be removed.<br><br>*rate limits*:<…
Delete tag relationships segments
Use the request body to de-associate a tag from specified segment ids. rate limits are 3 requests/sec and 60 requests/min. required scopes are 'segments:write' and 'tags:write'.
Delete template
Delete a template with the given template id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `templates:write`
Delete webhook
Delete a webhook with the given id.<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `15/m` **scopes:** `webhooks:write`
Get account
Retrieve a single account object by its account id. you can only request the account by which the private api key was generated.<br><br>*rate limits*:<br>burst: `1/s`<br>steady: …
Get accounts
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/m…
Get bulk profile import job
Get a bulk profile import job with the given job id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `lists:read` `profiles:read`
Get bulk profile import job errors
Get import errors for the bulk profile import job with the given id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `profiles:read`
Get bulk profile import job lists
Get list for the bulk profile import job with the given id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `lists:read`
Get bulk profile import job profiles
Get profiles for the bulk profile import job with the given id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `profiles:read`
Get bulk profile import job relationships lists
Get list relationship for the bulk profile import job with the given id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `lists:read`
Get bulk profile import job relationships profiles
Get profile relationships for the bulk profile import job with the given id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `profiles:read`
Get bulk profile import jobs
Get all bulk profile import jobs. returns a maximum of 100 jobs per request.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `lists:read` `profiles:read`
Get Campaign
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…
Get campaign campaign messages
Return all messages that belong to the given campaign.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read`
Get campaign message
Returns a specific message based on a required id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read`
Get campaign message campaign
Return the related campaign<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read`
Get campaign message relationships campaign
Returns the id of the related campaign<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read`
Get campaign message relationships template
Returns the id of the related template<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read` `templates:read`
Get campaign message template
Return the related template<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read` `templates:read`
Get campaign recipient estimation
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`.
Get campaign recipient estimation job
Retrieve the status of a recipient estimation job triggered with the `create campaign recipient estimation job` endpoint.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m…
Get campaign relationships campaign messages
Returns the ids of all messages associated with the given campaign.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read`
Get campaign relationships tags
Returns the ids of all tags associated with the given campaign.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `campaigns:read` `tags:read`
Get Campaigns
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) …
Get campaign send job
Get a campaign send job<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:read`
Get campaign tags
Return all tags that belong to the given campaign.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `campaigns:read` `tags:read`
Get catalog categories
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. req…
Get catalog category
Get a catalog category with the given category id.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get catalog category items
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…
Get catalog category relationships items
Get all items in the given category id. returns a maximum of 100 items per request.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get catalog item
Get a specific catalog item with the given item id.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get catalog item categories
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:…
Get catalog item relationships categories
Get all catalog categories that a particular item is in. returns a maximum of 100 categories per request.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** …
Get catalog items
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`.
Get catalog item variants
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 catalog variant
Get a catalog item variant with the given variant id.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get catalog variants
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…
Get coupon
Get a specific coupon with the given coupon id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `coupons:read`
Get coupon code
Returns a coupon code specified by the given identifier.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `coupon-codes:read`
Get coupon code bulk create job
Get a coupon code bulk create job with the given job id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `coupon-codes:read`
Get coupon code bulk create jobs
Get all coupon code bulk create jobs. returns a maximum of 100 jobs per request.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `coupon-codes:read`
Get coupon code relationships coupon
Gets a list of coupon code relationships associated with the given coupon id<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `coupon-codes:read`
Get coupon codes
Obtains coupon codes using necessary coupon or profile filters. rate limits: 350/s, 3500/m. requires 'coupon-codes:read' scope.
Get coupon codes for coupon
Gets a list of coupon codes associated with the given coupon id<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `coupon-codes:read`
Get coupon for coupon code
Get the coupon associated with a given coupon code id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `coupons:read`
Get coupon relationships coupon codes
Gets the coupon relationship associated with the given coupon code id<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `coupons:read`
Get coupons
Get all coupons in an account. to learn more, see our [coupons api guide](https://developers.klaviyo.com/en/docs/use klaviyos coupons api).<br><br>*rate limits*:<br>burst: `75/s`…
Get create categories job
Get a catalog category bulk create job with the given job id. an `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*rate limits…
Get create categories jobs
Get all catalog category bulk create jobs. returns a maximum of 100 jobs per request.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get create items job
Get a catalog item bulk create job with the given job id. an `include` parameter can be provided to get the following related resource data: `items`.<br><br>*rate limits*:<br>bur…
Get create items jobs
Get all catalog item bulk create jobs. returns a maximum of 100 jobs per request.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get create variants job
Get a catalog variant bulk create job with the given job id. an `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*rate limits*:<…
Get create variants jobs
Get all catalog variant bulk create jobs. returns a maximum of 100 jobs per request.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get delete categories job
Get a catalog category bulk delete job with the given job id.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get delete categories jobs
Get all catalog category bulk delete jobs. returns a maximum of 100 jobs per request.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get delete items job
Get a catalog item bulk delete job with the given job id.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get delete items jobs
Get all catalog item bulk delete jobs. returns a maximum of 100 jobs per request.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get delete variants job
Get a catalog variant bulk delete job with the given job id.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get delete variants jobs
Get all catalog variant bulk delete jobs. returns a maximum of 100 jobs per request.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get event
Get an event with the given event id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `events:read`
Get event metric
Get the metric for an event with the given event id.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `events:read` `metrics:read`
Get event profile
Get the profile associated with an event with the given event id.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `events:read` `profiles:read`
Get event relationships metric
Get a list of related metrics for an event<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `events:read` `metrics:read`
Get event relationships profile
Get profile [relationships](https://developers.klaviyo.com/en/reference/api overview#relationships) for an event with the given event id.<br><br>*rate limits*:<br>burst: `350/s`<…
Get events
Get all events in an account requests can be sorted by the following fields: `datetime`, `timestamp` returns a maximum of 200 events per page.<br><br>*rate limits*:<br>burst: `35…
Get flow
Get a flow with the given flow id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `flows:read`
Get flow action
Get a flow action from a flow with the given flow action id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `flows:read`
Get flow action for message
Get the flow action for a flow message with the given message id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `flows:read`
Get flow action messages
Retrieve up to 50 flow messages per request by action id, sortable by various fields, with ascending/descending options, and paginated using `page[size]` and `page[number]`. rate…
Get flow action relationships flow
Get the flow associated with the given action id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `flows:read`
Get flow action relationships messages
Retrieves up to 50 flow message relationships per request for a specified flow action id, with cursor pagination. rate limits: 3/s burst, 60/min steady. requires `flows:read` sco…
Get flow flow actions
Get all flow actions associated with the given flow id. returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*rate limits*:<br>b…
Get flow for flow action
Get the flow associated with the given action id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `flows:read`
Get flow message
Get the flow message of a flow with the given message id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `flows:read`
Get flow message relationships action
Get the [relationship](https://developers.klaviyo.com/en/reference/api overview#relationships) for a flow message's flow action, given the flow id.<br><br>*rate limits*:<br>burst…
Get flow message relationships template
Returns the id of the related template<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `templates:read`
Get flow message template
Return the related template<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `templates:read`
Get flow relationships flow actions
Retrieve all flow action relationships for a specific flow id, sortable by `id`, `status`, `created`, `updated`. refine with filters, max 50 per page, paginated by `page[size]` a…
Get flow relationships tags
Return the tag ids of all tags associated with the given flow.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `flows:read` `tags:read`
Get flows
Get all flows in an account. returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/…
Get flow tags
Return all tags associated with the given flow id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `flows:read` `tags:read`
Get form
Get the form with the given id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `forms:read`
Get form for form version
Get the form associated with the given form version.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `forms:read`
Get form id for form version
Get the id of the form associated with the given form version.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `forms:read`
Get forms
Get all forms in an account.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `forms:read`
Get form version
Get the form version with the given id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `forms:read`
Get image
Get the image with the given image id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `images:read`
Get images
Get all images in an account.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `images:read`
Get list
Api allows 75 req/sec and 700 req/min, but with 'profile count' param, it's 1 req/sec and 15 req/min. 'lists:read' scope needed. see developer guide for details.
Get list profiles
Retrieve profiles in a list by id, filterable by email/phone/push token/join date, sortable by join date. regular rate limit: 75/s, 700/m; with predictive analytics: 10/s, 150/m.…
Get list relationships profiles
Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api overview#relationships) for a list with the given list id.<br><br>*rate limits*:<br>burst: …
Get list relationships tags
Returns the tag ids of all tags associated with the given list.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `lists:read` `tags:read`
Get Lists
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 at…
Get list tags
Return all tags associated with the given list id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `lists:read` `tags:read`
Get metric
Get a metric with the given metric id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `metrics:read`
Get metrics
Get all metrics in an account. requests can be filtered by the following fields: integration `name`, integration `category` returns a maximum of 200 results per page.<br><br>*rat…
Get profile
Get the profile with the given profile id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `profiles:read`
Get profile lists
Get list memberships for a profile with the given profile id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `lists:read` `profiles:read`
Get profile relationships lists
Get list memberships for a profile with the given profile id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `lists:read` `profiles:read`
Get profile relationships segments
Get segment membership relationships for a profile with the given profile id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `profiles:read` `segments:read`
Get Profiles
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, an…
Get profile segments
Get segment memberships for a profile with the given profile id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `profiles:read` `segments:read`
Get segment
Fetch a segment by id with default rates of 75/s and 700/m, or with `additional-fields` at 1/s and 15/m. for details, visit the provided guide. required scope: `segments:read`.
Get segment profiles
Retrieve profiles in a segment by id, filtering by email, phone, token, or join date, and sorting by join date. rate limit: 75/s burst, 700/m steady. requires profiles:read and s…
Get segment relationships profiles
Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api overview#relationships) for the given segment id.<br><br>*rate limits*:<br>burst: `75/s…
Get segment relationships tags
If `related resource` is `tags`, returns the tag ids of all tags associated with the given segment id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `segmen…
Get segments
Fetch segments from an account with filters like `name`, `created`, and `updated`. max 10 results/page. rate limits are 75/s burst, 700/m steady. requires `segments:read` scope.
Get segment tags
Return all tags associated with the given segment id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `segments:read` `tags:read`
Get tag
Retrieve the tag with the given tag id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `tags:read`
Get tag group
Retrieve the tag group with the given tag group id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `tags:read`
Get tag group relationships tags
Returns the tag ids of all tags inside the given tag group.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `tags:read`
Get tag groups
Retrieve up to 25 tag groups per account, sortable/filterable by specific attributes. default group included. supports cursor pagination and adheres to rate limits of 3 requests …
Get tag group tags
Return the tags for a given tag group id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `tags:read`
Get tag relationships campaigns
Returns the ids of all campaigns associated with the given tag.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `campaigns:read` `tags:read`
Get tag relationships flows
Returns the ids of all flows associated with the given tag.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `flows:read` `tags:read`
Get tag relationships lists
Returns the ids of all lists associated with the given tag.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `lists:read` `tags:read`
Get tag relationships segments
Returns the ids of all segments associated with the given tag.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `segments:read` `tags:read`
Get tag relationships tag group
Returns the id of the tag group related to the given tag.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `tags:read`
Get tags
Retrieve up to 50 account tags at once, filterable/sortable by name or id, with cursor pagination. rate limits: 3/s burst, 60/m steady. requires `tags:read` scope.
Get tag tag group
Returns the tag group resource for a given tag id.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `tags:read`
Get template
Get a template with the given template id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `templates:read`
Get templates
Retrieve account templates with sorting options (`id`, `name`, `created`, `updated`). limit of 10 results per page, rate limits at 10/s burst and 150/m steady. requires `template…
Get update categories job
Get a catalog category bulk update job with the given job id. an `include` parameter can be provided to get the following related resource data: `categories`.<br><br>*rate limits…
Get update categories jobs
Get all catalog category bulk update jobs. returns a maximum of 100 jobs per request.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get update items job
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`.<br><br>*rate limits*:<br>bur…
Get update items jobs
Get all catalog item bulk update jobs. returns a maximum of 100 jobs per request.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get update variants job
Get a catalog variate bulk update job with the given job id. an `include` parameter can be provided to get the following related resource data: `variants`.<br><br>*rate limits*:<…
Get update variants jobs
Get all catalog variant bulk update jobs. returns a maximum of 100 jobs per request.<br><br>*rate limits*:<br>burst: `350/s`<br>steady: `3500/m` **scopes:** `catalogs:read`
Get version ids for form
Get the ids of the form versions for the given form.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `forms:read`
Get versions for form
Get the form versions for the given form.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `forms:read`
Get webhook
Get the webhook with the given id.<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `15/m` **scopes:** `webhooks:read`
Get webhooks
Get all webhooks in an account.<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `15/m` **scopes:** `webhooks:read`
Get webhook topic
Get the webhook topic with the given id.<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `15/m` **scopes:** `webhooks:read`
Get webhook topics
Get all webhook topics in a klaviyo account.<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `15/m` **scopes:** `webhooks:read`
Merge profiles
Queue a task to merge one source profile into a destination profile using their ids. deletes the source afterwards. visit help center for details. rate limits: 10/s burst, 150/m …
Query campaign values
Returns the requested campaign analytics values data<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `2/m`<br>daily: `225/d` **scopes:** `campaigns:read`
Query flow series
Returns the requested flow analytics series data<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `2/m`<br>daily: `225/d` **scopes:** `flows:read`
Query flow values
Returns the requested flow analytics values data<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `2/m`<br>daily: `225/d` **scopes:** `flows:read`
Query metric aggregates
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 …
Remove Profile from List
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 …
Request profile deletion
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…
Spawn bulk profile import job
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:…
Spawn coupon code bulk create job
Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. max number of jobs queued at once we allow for is 100.<br><br>*rate limits*:<br>burst: `75/s`<br>stead…
Spawn create categories job
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.
Spawn create items job
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 `catal…
Spawn create variants job
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. requ…
Spawn delete categories job
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…
Spawn delete items job
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 `cata…
Spawn delete variants job
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 `catalo…
Spawn update categories job
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`…
Spawn update items job
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…
Spawn update variants job
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 `ca…
Subscribe profiles
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 …
Suppress profiles
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 …
Unregister client push token
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.
Unsubscribe profiles
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 af…
Unsuppress profiles
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 burs…
Update Campaign
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…
Update campaign message
Update a campaign message<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `campaigns:write`
Update campaign send job
Permanently cancel the campaign, setting the status to canceled or revert the campaign, setting the status back to draft<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m`…
Update catalog category
Update a catalog category with the given category id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Update catalog category relationships items
Update item relationships for the given category id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Update catalog item
Update a catalog item with the given item id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Update catalog item relationships categories
Update catalog category relationships for the given item id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Update catalog variant
Update a catalog item variant with the given variant id.<br><br>*rate limits*:<br>burst: `75/s`<br>steady: `700/m` **scopes:** `catalogs:write`
Update coupon
*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `coupons:write`
Update coupon code
Updates a coupon code specified by the given identifier synchronously. we allow updating the 'status' and 'expires at' of coupon codes.<br><br>*rate limits*:<br>burst: `350/s`<br…
Update flow status
Update the status of a flow with the given flow id, and all actions in that flow.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `60/m` **scopes:** `flows:write`
Update image
Update the image with the given image id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `images:write`
Update list
Update the name of a list with the given list id.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `lists:write`
Update profile
Update profiles with the provided id. setting fields to `null` clears them; omitting fields retains existing data. rate limits: 75/s burst, 700/m steady. required scope: `profile…
Update segment
Update a segment with the given segment id.<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `15/m`<br>daily: `100/d` **scopes:** `segments:write`
Update tag
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.<br><br>*rate limits*:<br>burst: `3/s`<br>steady: `6…
Update tag group
Update the tag group with the given tag group id. only a tag group's `name` can be changed. a tag group's `exclusive` or `default` value cannot be changed.<br><br>*rate limits*:<…
Update template
Update a template with the given template id. does not currently update drag & drop templates.<br><br>*rate limits*:<br>burst: `10/s`<br>steady: `150/m` **scopes:** `templates:wr…
Update webhook
Update the webhook with the given id.<br><br>*rate limits*:<br>burst: `1/s`<br>steady: `15/m` **scopes:** `webhooks:write`
Upload image from file
Upload an image from a file. if you want to import an image from an existing url or a data uri, use the upload image from url endpoint instead.<br><br>*rate limits*:<br>burst: `3…
Upload image from url
Import an image from a url or data uri. if you want to upload an image from a file, use the upload image from file endpoint instead.<br><br>*rate limits*:<br>burst: `3/s`<br>stea…