Assign campaign message template
Assign campaign message template
Creates a non-reusable version of the template and assigns it to the message.rate limits:burst:
10/ssteady: 150/m scopes: campaigns:writeBulk create events
Bulk create events
This api endpoint creates or updates profiles by batching up to 1,000 events, with a 5mb payload limit. minimum required: a profile id and metric name. it has rate limits of 10 events per second burst and 150 events per minute. scope is
events:write.Bulk create client events
Bulk create client events
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.
Create campaign clone
Create campaign clone
Clones an existing campaign, returning a new campaign based on the original with a new id and name.rate limits:burst:
10/ssteady: 150/m scopes: campaigns:writeCreate campaign send job
Create campaign send job
Trigger a campaign to send asynchronouslyrate limits:burst:
10/ssteady: 150/m scopes: campaigns:writeCreate back in stock subscription
Create back in stock subscription
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.
Create tag relationships flows
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 and tags:write. tag: flow-tag association limitsCreate campaign recipient estimation job
Create campaign recipient estimation job
Start an async task to update campaign recipient estimates. track it using the
get campaign recipient estimation job and get the final count via get campaign recipient estimation. rate limits are 10/s burst, 150/m steady with campaigns:write scope.Create tag group
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 limits: 3/s burst, 60/m steady. scopes needed: tags:read, tags:write.
Create catalog category
Create catalog category
Create a new catalog category.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeCreate template render
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 tag relationships campaigns
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, tags:write. tag: #campaigntagginglimits
Delete catalog category
Delete catalog category
Delete a catalog category using the given category id.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeCreate campaign
Create campaign
Creates a campaign given a set of parameters, then returns it.rate limits:burst:
10/ssteady: 150/m scopes: campaigns:writeDelete campaign
Delete campaign
Delete a campaign with the given campaign id.rate limits:burst:
10/ssteady: 150/m scopes: campaigns:writeCreate coupon
Create coupon
Creates a new coupon.rate limits:burst:
3/ssteady: 60/m scopes: coupons:writeCreate catalog category relationships items
Create catalog category relationships items
Create a new item relationship for the given category id.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeDelete catalog item relationships categories
Delete catalog item relationships categories
Delete catalog category relationships for the given item id.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeCreate webhook
Create webhook
Create a new webhookrate limits:burst:
1/ssteady: 15/m scopes: webhooks:writeDelete catalog category relationships items
Delete catalog category relationships items
Delete item relationships for the given category id.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeCreate catalog item
Create catalog item
Create a new catalog item.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeDelete catalog variant
Delete catalog variant
Delete a catalog item variant with the given variant id.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeDelete coupon
Delete coupon
Delete the coupon with the given coupon id.rate limits:burst:
3/ssteady: 60/m scopes: coupons:writeDelete catalog item
Delete catalog item
Delete a catalog item with the given item id.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeDelete flow
Delete flow
Delete a flow with the given flow id.rate limits:burst:
3/ssteady: 60/m scopes: flows:writeDelete coupon code
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 raisedrate limits:burst:
350/ssteady: 3500/m scopes: coupon-codes:writeDelete list
Delete list
Delete a list with the given list id.rate limits:burst:
10/ssteady: 150/m scopes: lists:writeCreate catalog item relationships categories
Create catalog item relationships categories
Create a new catalog category relationship for the given item id.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeCreate template clone
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:write scope.Create tag relationships lists
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:write
Delete tag relationships flows
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.rate limits:burst:
3/ssteady: 60/m scopes: flows:write tags:writeDelete segment
Delete segment
Delete a segment with the given segment id.rate limits:burst:
3/ssteady: 60/m scopes: segments:writeDelete tag relationships campaigns
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
Delete tag
Delete the tag with the given tag id. any associations between the tag and other resources will also be removed.rate limits:burst:
3/ssteady: 60/m scopes: tags:read tags:writeDelete tag group
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:read and tags:write permissions.
Delete tag relationships lists
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.rate limits:burst:
3/ssteady: 60/m scopes: lists:write tags:writeDelete template
Delete template
Delete a template with the given template id.rate limits:burst:
10/ssteady: 150/m scopes: templates:writeCreate coupon code
Create coupon code
Synchronously creates a coupon code for the given coupon.rate limits:burst:
350/ssteady: 3500/m scopes: coupon-codes:writeDelete tag relationships segments
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’.
Create tag relationships segments
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 sixty per minute. tags: segments:write, tags:write
Delete webhook
Delete webhook
Delete a webhook with the given id.rate limits:burst:
1/ssteady: 15/m scopes: webhooks:writeGet account
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.rate limits:burst:
1/ssteady: 15/m scopes: accounts:readGet bulk profile import job
Get bulk profile import job
Get a bulk profile import job with the given job id.rate limits:burst:
10/ssteady: 150/m scopes: lists:read profiles:readGet accounts
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/minute. scope required:
accounts:read.Create catalog variant
Create catalog variant
Create a new variant for a related catalog item.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeCreate template
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 150 per minute. requires ‘templates:write’ scope.
Add profile to list
Add profile to list
Use the subscribe profiles endpoint to add profiles to a list by id, with a max of 1000 per call. ideal for giving marketing consent. rate limits: 10/s burst, 150/m steady. requires lists:write and profiles:write scopes.
Create list
Create list
Create a new list.rate limits:burst:
10/ssteady: 150/mdaily: 100/d scopes: lists:writeCreate or update push token
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-tokens:write scopes.
Create or update client profile
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 with ‘profiles:write’ access.
Create or update client push token
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 post endpoint. rate limits are 3/s burst, 150/m steady.
Create client back in stock subscription
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 and 3500 per minute. requires ‘catalogs:write’ and ‘profiles:write’ scopes.
Create tag
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 60/min steady. tag: #tagcreationlimitandrate
Create client event
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 profile
Create profile
Create a new profile.rate limits:burst:
75/ssteady: 700/m scopes: profiles:writeCreate segment
Create segment
Create a segment.rate limits:burst:
1/ssteady: 15/mdaily: 100/d scopes: segments:writeCreate or update profile
Create or update profile
Create/update a profile with given attributes. returns 201 for creation, 200 for update. empty fields are cleared with
null; omitted fields remain. rate limits: 75/s burst, 700/m steady. scope required: profiles:write.Create event
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:write.Create client subscription
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 ‘subscriptions:write’.
Get bulk profile import job profiles
Get bulk profile import job profiles
Get profiles for the bulk profile import job with the given id.rate limits:burst:
10/ssteady: 150/m scopes: profiles:readGet bulk profile import job relationships profiles
Get bulk profile import job relationships profiles
Get profile relationships for the bulk profile import job with the given id.rate limits:burst:
10/ssteady: 150/m scopes: profiles:readGet bulk profile import jobs
Get bulk profile import jobs
Get all bulk profile import jobs. returns a maximum of 100 jobs per request.rate limits:burst:
10/ssteady: 150/m scopes: lists:read profiles:readGet bulk profile import job lists
Get bulk profile import job lists
Get list for the bulk profile import job with the given id.rate limits:burst:
10/ssteady: 150/m scopes: lists:readGet bulk profile import job errors
Get bulk profile import job errors
Get import errors for the bulk profile import job with the given id.rate limits:burst:
10/ssteady: 150/m scopes: profiles:readGet catalog category
Get catalog category
Get a catalog category with the given category id.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet coupon
Get coupon
Get a specific coupon with the given coupon id.rate limits:burst:
75/ssteady: 700/m scopes: coupons:readGet campaign message template
Get campaign message template
Return the related templaterate limits:burst:
10/ssteady: 150/m scopes: campaigns:read templates:readGet delete items job
Get delete items job
Get a catalog item bulk delete job with the given job id.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet bulk profile import job relationships lists
Get bulk profile import job relationships lists
Get list relationship for the bulk profile import job with the given id.rate limits:burst:
10/ssteady: 150/m scopes: lists:readGet delete variants job
Get delete variants job
Get a catalog variant bulk delete job with the given job id.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet coupon relationships coupon codes
Get coupon relationships coupon codes
Gets the coupon relationship associated with the given coupon code idrate limits:burst:
75/ssteady: 700/m scopes: coupons:readGet campaign
Get campaign
Returns a specific campaign based on a required id.rate limits:burst:
10/ssteady: 150/m scopes: campaigns:readGet catalog categories
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. requires catalogs:read scope.Get campaign message relationships template
Get campaign message relationships template
Returns the id of the related templaterate limits:burst:
10/ssteady: 150/m scopes: campaigns:read templates:readGet delete variants jobs
Get delete variants jobs
Get all catalog variant bulk delete jobs. returns a maximum of 100 jobs per request.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet delete categories jobs
Get delete categories jobs
Get all catalog category bulk delete jobs. returns a maximum of 100 jobs per request.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet event
Get event
Get an event with the given event id.rate limits:burst:
10/ssteady: 150/m scopes: events:readGet flow flow actions
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.rate limits:burst:
3/ssteady: 60/m scopes: flows:readGet flow action relationships messages
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 scope.Get create categories job
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.rate limits:burst: 350/ssteady: 3500/m scopes: catalogs:readGet catalog category items
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’ scope.
Get flow
Get flow
Get a flow with the given flow id.rate limits:burst:
3/ssteady: 60/m scopes: flows:readGet coupons
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).rate limits:burst:
75/ssteady: 700/m scopes: coupons:readGet flow for flow action
Get flow for flow action
Get the flow associated with the given action id.rate limits:burst:
3/ssteady: 60/m scopes: flows:readGet flows
Get flows
Get all flows in an account. returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.rate limits:burst:
3/ssteady: 60/m scopes: flows:readGet flow message relationships action
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.rate limits:burst:
3/ssteady: 60/m scopes: flows:readGet catalog category relationships items
Get catalog category relationships items
Get all items in the given category id. returns a maximum of 100 items per request.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet flow message
Get flow message
Get the flow message of a flow with the given message id.rate limits:burst:
3/ssteady: 60/m scopes: flows:readGet campaign recipient estimation
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 flow message template
Get flow message template
Return the related templaterate limits:burst:
3/ssteady: 60/m scopes: templates:readGet flow message relationships template
Get flow message relationships template
Returns the id of the related templaterate limits:burst:
3/ssteady: 60/m scopes: templates:readGet create categories jobs
Get create categories jobs
Get all catalog category bulk create jobs. returns a maximum of 100 jobs per request.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet events
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.rate limits:burst: 350/ssteady: 3500/m scopes: events:readGet campaign recipient estimation job
Get campaign recipient estimation job
Retrieve the status of a recipient estimation job triggered with the
create campaign recipient estimation job endpoint.rate limits:burst: 10/ssteady: 150/m scopes: campaigns:readGet flow relationships flow actions
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] and page[number]. rate limits: burst 3/s, steady 60/m. scope: flows:read.Get flow tags
Get flow tags
Get catalog item
Get catalog item
Get a specific catalog item with the given item id.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet flow relationships tags
Get flow relationships tags
Get event metric
Get event metric
Get the metric for an event with the given event id.rate limits:burst:
350/ssteady: 3500/m scopes: events:read metrics:readGet form
Get form
Get the form with the given id.rate limits:burst:
3/ssteady: 60/m scopes: forms:readGet coupon code
Get coupon code
Returns a coupon code specified by the given identifier.rate limits:burst:
350/ssteady: 3500/m scopes: coupon-codes:readGet create items job
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.rate limits:burst: 350/ssteady: 3500/m scopes: catalogs:readGet forms
Get forms
Get all forms in an account.rate limits:burst:
3/ssteady: 60/m scopes: forms:readGet campaign relationships campaign messages
Get campaign relationships campaign messages
Returns the ids of all messages associated with the given campaign.rate limits:burst:
10/ssteady: 150/m scopes: campaigns:readGet delete items jobs
Get delete items jobs
Get all catalog item bulk delete jobs. returns a maximum of 100 jobs per request.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet event profile
Get event profile
Get the profile associated with an event with the given event id.rate limits:burst:
350/ssteady: 3500/m scopes: events:read profiles:readGet form version
Get form version
Get the form version with the given id.rate limits:burst:
3/ssteady: 60/m scopes: forms:readGet form for form version
Get form for form version
Get the form associated with the given form version.rate limits:burst:
3/ssteady: 60/m scopes: forms:readGet form id for form version
Get form id for form version
Get the id of the form associated with the given form version.rate limits:burst:
3/ssteady: 60/m scopes: forms:readGet catalog items
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 create items jobs
Get create items jobs
Get all catalog item bulk create jobs. returns a maximum of 100 jobs per request.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet list
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 images
Get images
Get all images in an account.rate limits:burst:
10/ssteady: 150/m scopes: images:readGet lists
Get lists
Retrieve a filtered selection of account lists by fields like
id, name, created, and updated. limited to 10 results per page with burst rate limits of 75 requests/second and a steady rate of 700 requests/minute. requires lists:read scope.Get flow action
Get flow action
Get a flow action from a flow with the given flow action id.rate limits:burst:
3/ssteady: 60/m scopes: flows:readGet event relationships metric
Get event relationships metric
Get a list of related metrics for an eventrate limits:burst:
350/ssteady: 3500/m scopes: events:read metrics:readGet campaign relationships tags
Get campaign relationships tags
Get campaigns
Get campaigns
To list campaigns, use a channel filter (
email or sms). rate limits apply: 10/s (burst), 150/m (steady). required scope: campaigns:read.Get list relationships tags
Get list relationships tags
Get list tags
Get list tags
Get event relationships profile
Get event relationships profile
Get profile [relationships](https://developers.klaviyo.com/en/reference/api overview#relationships) for an event with the given event id.rate limits:burst:
350/ssteady: 3500/m scopes: events:read profiles:readGet list profiles
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. details at klaviyo guide. scopes required: lists:read, profiles:read.
Get create variants job
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.rate limits:burst: 350/ssteady: 3500/m scopes: catalogs:readGet campaign send job
Get campaign send job
Get a campaign send jobrate limits:burst:
10/ssteady: 150/m scopes: campaigns:readGet flow action for message
Get flow action for message
Get the flow action for a flow message with the given message id.rate limits:burst:
3/ssteady: 60/m scopes: flows:readGet metric
Get metric
Get a metric with the given metric id.rate limits:burst:
10/ssteady: 150/m scopes: metrics:readGet list relationships profiles
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.rate limits:burst:
75/ssteady: 700/m scopes: lists:read profiles:readGet create variants jobs
Get create variants jobs
Get all catalog variant bulk create jobs. returns a maximum of 100 jobs per request.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet metrics
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.rate limits:burst: 10/ssteady: 150/m scopes: metrics:readGet profile relationships lists
Get profile relationships lists
Get list memberships for a profile with the given profile id.rate limits:burst:
3/ssteady: 60/m scopes: lists:read profiles:readGet profile lists
Get profile lists
Get list memberships for a profile with the given profile id.rate limits:burst:
3/ssteady: 60/m scopes: lists:read profiles:readGet image
Get image
Get the image with the given image id.rate limits:burst:
10/ssteady: 150/m scopes: images:readGet profile
Get profile
Get the profile with the given profile id.rate limits:burst:
75/ssteady: 700/m scopes: profiles:readGet profiles
Get profiles
Retrieve account profiles, sort by various fields. rate limits: 75/s burst, 700/m steady; lower with
predictive analytics. details at developers.klaviyo.com. requires profiles:read scope.Get segments
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 delete categories job
Get delete categories job
Get a catalog category bulk delete job with the given job id.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet profile relationships segments
Get profile relationships segments
Get segment membership relationships for a profile with the given profile id.rate limits:burst:
3/ssteady: 60/m scopes: profiles:read segments:readGet segment
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 catalog item categories
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:read’ scope.
Get profile segments
Get profile segments
Get segment memberships for a profile with the given profile id.rate limits:burst:
3/ssteady: 60/m scopes: profiles:read segments:readGet flow action messages
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 limits: 3/s burst, 60/m steady. scope required: flows:read.Get segment profiles
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 segments:read scopes.
Get coupon code relationships coupon
Get coupon code relationships coupon
Gets a list of coupon code relationships associated with the given coupon idrate limits:burst:
75/ssteady: 700/m scopes: coupon-codes:readGet segment relationships profiles
Get segment relationships profiles
Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api overview#relationships) for the given segment id.rate limits:burst:
75/ssteady: 700/m scopes: profiles:read segments:readGet flow action relationships flow
Get flow action relationships flow
Get the flow associated with the given action id.rate limits:burst:
3/ssteady: 60/m scopes: flows:readGet catalog variant
Get catalog variant
Get a catalog item variant with the given variant id.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet coupon for coupon code
Get coupon for coupon code
Get the coupon associated with a given coupon code id.rate limits:burst:
75/ssteady: 700/m scopes: coupons:readGet catalog item relationships categories
Get catalog item relationships categories
Get all catalog categories that a particular item is in. returns a maximum of 100 categories per request.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet coupon code bulk create jobs
Get coupon code bulk create jobs
Get all coupon code bulk create jobs. returns a maximum of 100 jobs per request.rate limits:burst:
75/ssteady: 700/m scopes: coupon-codes:readGet campaign message campaign
Get campaign message campaign
Return the related campaignrate limits:burst:
10/ssteady: 150/m scopes: campaigns:readGet campaign message
Get campaign message
Returns a specific message based on a required id.rate limits:burst:
10/ssteady: 150/m scopes: campaigns:readGet campaign campaign messages
Get campaign campaign messages
Return all messages that belong to the given campaign.rate limits:burst:
10/ssteady: 150/m scopes: campaigns:readGet catalog item variants
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 campaign message relationships campaign
Get campaign message relationships campaign
Returns the id of the related campaignrate limits:burst:
10/ssteady: 150/m scopes: campaigns:readGet catalog variants
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/m steady. requires catalogs:read scope.Get campaign tags
Get campaign tags
Get coupon code bulk create job
Get coupon code bulk create job
Get a coupon code bulk create job with the given job id.rate limits:burst:
75/ssteady: 700/m scopes: coupon-codes:readGet coupon codes
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
Get coupon codes for coupon
Gets a list of coupon codes associated with the given coupon idrate limits:burst:
75/ssteady: 700/m scopes: coupon-codes:readGet segment relationships tags
Get segment relationships tags
Spawn bulk profile import job
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:write scopes. more info in the bulk profile import api guide.Get tag relationships lists
Get tag relationships lists
Returns the ids of all lists associated with the given tag.rate limits:burst:
3/ssteady: 60/m scopes: lists:read tags:readSpawn update items job
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 scope:
catalogs:write.Suppress profiles
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 700/m. scopes: profiles:write, subscriptions:write.
Get webhooks
Get webhooks
Get all webhooks in an account.rate limits:burst:
1/ssteady: 15/m scopes: webhooks:readGet tag
Get tag
Retrieve the tag with the given tag id.rate limits:burst:
3/ssteady: 60/m scopes: tags:readGet tag tag group
Get tag tag group
Returns the tag group resource for a given tag id.rate limits:burst:
3/ssteady: 60/m scopes: tags:readGet tag group relationships tags
Get tag group relationships tags
Subscribe profiles
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 ‘lists:write’, ‘profiles:write’, ‘subscriptions:write’ permissions.
Update catalog category relationships items
Update catalog category relationships items
Update item relationships for the given category id.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeSpawn update variants job
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
catalogs:write scope.Get segment tags
Get segment tags
Get tag group tags
Get tag group tags
Get webhook
Get webhook
Get the webhook with the given id.rate limits:burst:
1/ssteady: 15/m scopes: webhooks:readUpdate catalog category
Update catalog category
Update a catalog category with the given category id.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeRequest profile deletion
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 second, 60 per minute.
Get tag relationships segments
Get tag relationships segments
Returns the ids of all segments associated with the given tag.rate limits:burst:
3/ssteady: 60/m scopes: segments:read tags:readUpdate catalog item relationships categories
Update catalog item relationships categories
Update catalog category relationships for the given item id.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeUpdate catalog item
Update catalog item
Update a catalog item with the given item id.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeGet webhook topic
Get webhook topic
Get the webhook topic with the given id.rate limits:burst:
1/ssteady: 15/m scopes: webhooks:readGet tag relationships tag group
Get tag relationships tag group
Returns the id of the tag group related to the given tag.rate limits:burst:
3/ssteady: 60/m scopes: tags:readUpdate coupon
Update coupon
rate limits:burst:
3/ssteady: 60/m scopes: coupons:writeGet template
Get template
Get a template with the given template id.rate limits:burst:
10/ssteady: 150/m scopes: templates:readUpdate tag group
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.rate limits:burst: 3/ssteady: 60/m scopes: tags:read tags:writeGet templates
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 templates:read scope.Update tag
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.rate limits:burst: 3/ssteady: 60/m scopes: tags:read tags:writeUnregister client push token
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.
Update segment
Update segment
Update a segment with the given segment id.rate limits:burst:
1/ssteady: 15/mdaily: 100/d scopes: segments:writeUpdate catalog variant
Update catalog variant
Update a catalog item variant with the given variant id.rate limits:burst:
75/ssteady: 700/m scopes: catalogs:writeUpdate coupon code
Update coupon code
Updates a coupon code specified by the given identifier synchronously. we allow updating the ‘status’ and ‘expires at’ of coupon codes.rate limits:burst:
350/ssteady: 3500/m scopes: coupon-codes:writeGet webhook topics
Get webhook topics
Get all webhook topics in a klaviyo account.rate limits:burst:
1/ssteady: 15/m scopes: webhooks:readUnsubscribe profiles
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 affecting subscriptions. more on consent and removal in the provided links.
Update template
Update template
Update a template with the given template id. does not currently update drag & drop templates.rate limits:burst:
10/ssteady: 150/m scopes: templates:writeUpload image from file
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.rate limits:burst:
3/ssteady: 100/mdaily: 100/d scopes: images:writeUpdate webhook
Update webhook
Update the webhook with the given id.rate limits:burst:
1/ssteady: 15/m scopes: webhooks:writeGet update categories job
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.rate limits:burst: 350/ssteady: 3500/m scopes: catalogs:readUpload image from url
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.rate limits:burst:
3/ssteady: 100/mdaily: 100/d scopes: images:writeGet tag groups
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 per second and 60 per minute. requires
tags:read scope.Unsuppress profiles
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 burst, 700/m steady. scope: ‘subscriptions:write’.
Update flow status
Update flow status
Update the status of a flow with the given flow id, and all actions in that flow.rate limits:burst:
3/ssteady: 60/m scopes: flows:writeMerge profiles
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 steady. needs
profiles:write scope.Get update categories jobs
Get update categories jobs
Get all catalog category bulk update jobs. returns a maximum of 100 jobs per request.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readGet tag group
Get tag group
Retrieve the tag group with the given tag group id.rate limits:burst:
3/ssteady: 60/m scopes: tags:readQuery campaign values
Query campaign values
Returns the requested campaign analytics values datarate limits:burst:
1/ssteady: 2/mdaily: 225/d scopes: campaigns:readUpdate image
Update image
Update the image with the given image id.rate limits:burst:
10/ssteady: 150/m scopes: images:writeUpdate campaign
Update campaign
Update a campaign with the given campaign id.rate limits:burst:
10/ssteady: 150/m scopes: campaigns:writeSpawn coupon code bulk create job
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.rate limits:burst:
75/ssteady: 700/m scopes: coupon-codes:writeGet update items job
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.rate limits:burst: 350/ssteady: 3500/m scopes: catalogs:readGet tags
Get tags
Update list
Update list
Update the name of a list with the given list id.rate limits:burst:
10/ssteady: 150/m scopes: lists:writeUpdate campaign message
Update campaign message
Update a campaign messagerate limits:burst:
10/ssteady: 150/m scopes: campaigns:writeQuery flow series
Query flow series
Returns the requested flow analytics series datarate limits:burst:
1/ssteady: 2/mdaily: 225/d scopes: flows:readGet update items jobs
Get update items jobs
Get all catalog item bulk update jobs. returns a maximum of 100 jobs per request.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readUpdate profile
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: profiles:write.Spawn create categories job
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.
Get update variants job
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.rate limits:burst: 350/ssteady: 3500/m scopes: catalogs:readUpdate campaign send job
Update campaign send job
Permanently cancel the campaign, setting the status to canceled or revert the campaign, setting the status back to draftrate limits:burst:
10/ssteady: 150/m scopes: campaigns:writeGet tag relationships campaigns
Get tag relationships campaigns
Returns the ids of all campaigns associated with the given tag.rate limits:burst:
3/ssteady: 60/m scopes: campaigns:read tags:readGet version ids for form
Get version ids for form
Get the ids of the form versions for the given form.rate limits:burst:
3/ssteady: 60/m scopes: forms:readGet versions for form
Get versions for form
Get the form versions for the given form.rate limits:burst:
3/ssteady: 60/m scopes: forms:readSpawn delete items job
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
catalogs:write scope.Query flow values
Query flow values
Returns the requested flow analytics values datarate limits:burst:
1/ssteady: 2/mdaily: 225/d scopes: flows:readSpawn delete categories job
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/min steady. requires
catalogs:write scope.Spawn create items job
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
catalogs:write scope.Spawn create variants job
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. requires ‘catalogs:write’ scope.
Get update variants jobs
Get update variants jobs
Get all catalog variant bulk update jobs. returns a maximum of 100 jobs per request.rate limits:burst:
350/ssteady: 3500/m scopes: catalogs:readSpawn update categories job
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 scope.Spawn delete variants job
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
catalogs:write scope.Get tag relationships flows
Get tag relationships flows
Returns the ids of all flows associated with the given tag.rate limits:burst:
3/ssteady: 60/m scopes: flows:read tags:readRemove profile from list
Remove profile from list
Delete profiles from a marketing list using its id without affecting overall consent. use unsubscribe profiles for complete unsubscribing. limit: 1000 profiles per call, 10 calls/s, 150 calls/m. required scopes:
lists:write, profiles:write.Query metric aggregates
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 rate limits (3 requests per second, 60 per minute) under ‘metrics:read’.