Beyond-Bot.ai + klaviyo

Klaviyo is a data-driven email and SMS marketing platform that allows e-commerce brands to deliver targeted messages, track conversions, and scale customer relationships

What You Can Do with this Integration

Automate Data Entry

Automatically sync new contacts or deals from Beyond-Bot.ai to klaviyo.

Enrich Customer Profiles

Use Beyond-Bot.ai to find and add new information to your records in klaviyo.

Trigger Workflows

Start automated workflows in klaviyo based on conversations with your virtual expert.

Available Actions

Here are the specific actions your virtual expert can perform within klaviyo.

Klaviyo Add Profile To List

Add profiles to a klaviyo list by profile ids or email addresses. this action subscribes profiles to a marketing list, which is ideal for giving marketing consent. you can add up to 1000 profiles per call using either their klaviyo profile ids or email addresses. rate limits: 10/s burst, 150/m steady. required scopes: `lists:write` and `profiles:write`. preconditions: - either profile ids or emails must be provided (not both) - maximum 1000 profiles per call - email addresses must be valid format - the list must exist and be accessible

Klaviyo Create Campaign Recipient Estimation Job

Start an asynchronous task to estimate the number of recipients for a campaign. this action creates a background job that calculates how many profiles would receive the campaign based on its current audience settings. use the job id returned to track progress with the 'get campaign recipient estimation job' action, and get the final count via 'get campaign recipient estimation' action. rate limits: 10/s burst, 150/m steady. required scope: `campaigns:write`. preconditions: - valid api key with campaigns:write scope - campaign id must exist and be accessible - campaign must have audience settings configured

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

Klaviyo Create List

Create a new list. *rate limits*: burst: `10/s` steady: `150/m` daily: `100/d` **scopes:** `lists:write`

Klaviyo 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 other identifiers). returns 201 for creation, 200 for update. empty fields are cleared with `null`; omitted fields remain unchanged. rate limits: 75/s burst, 700/m steady. required scope: `profiles:write`. preconditions: - at least one identifier (email, phone number, external id, or anonymous id) must be provided - email must be in valid format if provided - phone number must be in e.164 format if provided

Klaviyo Create Profile

Create a new profile. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `profiles:write`

Klaviyo 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, and optionally related messages and tags. rate limits: 10/s burst, 150/m steady. required scope: `campaigns:read`. preconditions: - valid api key with campaigns:read scope - campaign id must exist and be accessible

Klaviyo 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) to list campaigns. you can add additional filters for status, name, creation date, and other attributes. results are paginated with a default of 10 campaigns per page. rate limits: 10/s burst, 150/m steady. required scope: `campaigns:read`. preconditions: - valid api key with campaigns:read scope - channel must be specified (email or sms) - additional filter syntax must be valid if provided

Klaviyo 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/s` steady: `3500/m` **scopes:** `events:read`

Klaviyo 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 attributes. results are paginated with a default of 10 lists per page. rate limits: 75/s burst, 700/m steady. required scope: `lists:read`. preconditions: - valid api key with lists:read scope - filter syntax must be valid if provided

Klaviyo 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, and other attributes. results are paginated with a configurable page size. rate limits: 75/s burst, 700/m steady (lower with predictive analytics). required scope: `profiles:read`. preconditions: - valid api key with profiles:read scope - filter syntax must be valid if provided - page size must be between 1 and 100

Klaviyo 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 be updated; others remain unchanged. rate limits: 10/s burst, 150/m steady. required scope: `campaigns:write`. preconditions: - valid api key with campaigns:write scope - campaign id must exist and be accessible - campaign must be in a state that allows updates (usually draft status) - send strategy options must match the selected method

Klaviyo Assign Campaign Message Template

Creates a non-reusable version of the template and assigns it to the message. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

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

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

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

Klaviyo Create Campaign

Creates a campaign given a set of parameters, then returns it. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

Klaviyo 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/s` steady: `150/m` **scopes:** `campaigns:write`

Klaviyo Create Campaign Send Job

Trigger a campaign to send asynchronously *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

Klaviyo Create Catalog Category

Create a new catalog category. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Create Catalog Category Relationships Items

Create a new item relationship for the given category id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Create Catalog Item

Create a new catalog item. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Create Catalog Item Relationships Categories

Create a new catalog category relationship for the given item id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Create Catalog Variant

Create a new variant for a related catalog item. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

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

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

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

Klaviyo Create Coupon

Creates a new coupon. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `coupons:write`

Klaviyo Create Coupon Code

Synchronously creates a coupon code for the given coupon. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `coupon-codes:write`

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

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

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

Klaviyo Create Segment

Create a segment. *rate limits*: burst: `1/s` steady: `15/m` daily: `100/d` **scopes:** `segments:write`

Klaviyo 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

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

Klaviyo 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

Klaviyo 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 limits

Klaviyo 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

Klaviyo 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

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

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

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

Klaviyo Create Webhook

Create a new webhook *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:write`

Klaviyo Delete Campaign

Delete a campaign with the given campaign id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

Klaviyo Delete Catalog Category

Delete a catalog category using the given category id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Delete Catalog Category Relationships Items

Delete item relationships for the given category id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Delete Catalog Item

Delete a catalog item with the given item id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Delete Catalog Item Relationships Categories

Delete catalog category relationships for the given item id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Delete Catalog Variant

Delete a catalog item variant with the given variant id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Delete Coupon

Delete the coupon with the given coupon id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `coupons:write`

Klaviyo 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 *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `coupon-codes:write`

Klaviyo Delete Flow

Delete a flow with the given flow id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:write`

Klaviyo Delete List

Delete a list with the given list id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `lists:write`

Klaviyo Delete Segment

Delete a segment with the given segment id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `segments:write`

Klaviyo 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/s` steady: `60/m` **scopes:** `tags:read` `tags:write`

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

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

Klaviyo 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/s` steady: `60/m` **scopes:** `flows:write` `tags:write`

Klaviyo 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/s` steady: `60/m` **scopes:** `lists:write` `tags:write`

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

Klaviyo Delete Template

Delete a template with the given template id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `templates:write`

Klaviyo Delete Webhook

Delete a webhook with the given id. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:write`

Klaviyo 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/s` steady: `15/m` **scopes:** `accounts:read`

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

Klaviyo Get Bulk Profile Import Job

Get a bulk profile import job with the given job id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `lists:read` `profiles:read`

Klaviyo Get Bulk Profile Import Jobs

Get all bulk profile import jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `lists:read` `profiles:read`

Klaviyo Get Bulk Profile Import Job Errors

Get import errors for the bulk profile import job with the given id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `profiles:read`

Klaviyo Get Bulk Profile Import Job Lists

Get list for the bulk profile import job with the given id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `lists:read`

Klaviyo Get Bulk Profile Import Job Profiles

Get profiles for the bulk profile import job with the given id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `profiles:read`

Klaviyo Get Bulk Profile Import Job Relationships Lists

Get list relationship for the bulk profile import job with the given id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `lists:read`

Klaviyo Get Bulk Profile Import Job Relationships Profiles

Get profile relationships for the bulk profile import job with the given id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `profiles:read`

Klaviyo Get Campaign Campaign Messages

Return all messages that belong to the given campaign. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Klaviyo Get Campaign Message

Returns a specific message based on a required id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Klaviyo Get Campaign Message Campaign

Return the related campaign *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Klaviyo Get Campaign Message Relationships Campaign

Returns the id of the related campaign *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Klaviyo Get Campaign Message Relationships Template

Returns the id of the related template *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read` `templates:read`

Klaviyo Get Campaign Message Template

Return the related template *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read` `templates:read`

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

Klaviyo 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/s` steady: `150/m` **scopes:** `campaigns:read`

Klaviyo Get Campaign Relationships Campaign Messages

Returns the ids of all messages associated with the given campaign. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Klaviyo Get Campaign Relationships Tags

Returns the ids of all tags associated with the given campaign. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `campaigns:read` `tags:read`

Klaviyo Get Campaign Send Job

Get a campaign send job *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Klaviyo Get Campaign Tags

Return all tags that belong to the given campaign. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `campaigns:read` `tags:read`

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

Klaviyo Get Catalog Category

Get a catalog category with the given category id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

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

Klaviyo 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/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Catalog Item

Get a specific catalog item with the given item id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

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

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

Klaviyo 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/s` steady: `3500/m` **scopes:** `catalogs:read`

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

Klaviyo Get Catalog Variant

Get a catalog item variant with the given variant id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

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

Klaviyo Get Coupon

Get a specific coupon with the given coupon id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupons:read`

Klaviyo 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/s` steady: `700/m` **scopes:** `coupons:read`

Klaviyo Get Coupon Code

Returns a coupon code specified by the given identifier. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `coupon-codes:read`

Klaviyo Get Coupon Codes

Obtains coupon codes using necessary coupon or profile filters. rate limits: 350/s, 3500/m. requires 'coupon-codes:read' scope.

Klaviyo Get Coupon Codes For Coupon

Gets a list of coupon codes associated with the given coupon id *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupon-codes:read`

Klaviyo Get Coupon Code Bulk Create Job

Get a coupon code bulk create job with the given job id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupon-codes:read`

Klaviyo 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/s` steady: `700/m` **scopes:** `coupon-codes:read`

Klaviyo Get Coupon Code Relationships Coupon

Gets a list of coupon code relationships associated with the given coupon id *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupon-codes:read`

Klaviyo Get Coupon For Coupon Code

Get the coupon associated with a given coupon code id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupons:read`

Klaviyo Get Coupon Relationships Coupon Codes

Gets the coupon relationship associated with the given coupon code id *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupons:read`

Klaviyo 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/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Create Categories Jobs

Get all catalog category bulk create jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo 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/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Create Items Jobs

Get all catalog item bulk create jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo 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/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Create Variants Jobs

Get all catalog variant bulk create jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Delete Categories Job

Get a catalog category bulk delete job with the given job id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Delete Categories Jobs

Get all catalog category bulk delete jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Delete Items Job

Get a catalog item bulk delete job with the given job id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Delete Items Jobs

Get all catalog item bulk delete jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Delete Variants Job

Get a catalog variant bulk delete job with the given job id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Delete Variants Jobs

Get all catalog variant bulk delete jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Event

Get an event with the given event id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `events:read`

Klaviyo Get Event Metric

Get the metric for an event with the given event id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `events:read` `metrics:read`

Klaviyo Get Event Profile

Get the profile associated with an event with the given event id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `events:read` `profiles:read`

Klaviyo Get Event Relationships Metric

Get a list of related metrics for an event *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `events:read` `metrics:read`

Klaviyo 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/s` steady: `3500/m` **scopes:** `events:read` `profiles:read`

Klaviyo Get Flow

Get a flow with the given flow id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Klaviyo 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/s` steady: `60/m` **scopes:** `flows:read`

Klaviyo Get Flow Action

Get a flow action from a flow with the given flow action id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Klaviyo Get Flow Action For Message

Get the flow action for a flow message with the given message id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

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

Klaviyo Get Flow Action Relationships Flow

Get the flow associated with the given action id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

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

Klaviyo 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/s` steady: `60/m` **scopes:** `flows:read`

Klaviyo Get Flow For Flow Action

Get the flow associated with the given action id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Klaviyo Get Flow Message

Get the flow message of a flow with the given message id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Klaviyo 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/s` steady: `60/m` **scopes:** `flows:read`

Klaviyo Get Flow Message Relationships Template

Returns the id of the related template *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `templates:read`

Klaviyo Get Flow Message Template

Return the related template *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `templates:read`

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

Klaviyo Get Flow Relationships Tags

Return the tag ids of all tags associated with the given flow. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read` `tags:read`

Klaviyo Get Flow Tags

Return all tags associated with the given flow id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read` `tags:read`

Klaviyo Get Form

Get the form with the given id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Klaviyo Get Forms

Get all forms in an account. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Klaviyo Get Form For Form Version

Get the form associated with the given form version. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Klaviyo Get Form Id For Form Version

Get the id of the form associated with the given form version. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Klaviyo Get Form Version

Get the form version with the given id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Klaviyo Get Image

Get the image with the given image id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `images:read`

Klaviyo Get Images

Get all images in an account. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `images:read`

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

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

Klaviyo 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/s` steady: `700/m` **scopes:** `lists:read` `profiles:read`

Klaviyo Get List Relationships Tags

Returns the tag ids of all tags associated with the given list. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `lists:read` `tags:read`

Klaviyo Get List Tags

Return all tags associated with the given list id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `lists:read` `tags:read`

Klaviyo Get Metric

Get a metric with the given metric id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `metrics:read`

Klaviyo 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/s` steady: `150/m` **scopes:** `metrics:read`

Klaviyo Get Profile

Get the profile with the given profile id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `profiles:read`

Klaviyo Get Profile Lists

Get list memberships for a profile with the given profile id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `lists:read` `profiles:read`

Klaviyo Get Profile Relationships Lists

Get list memberships for a profile with the given profile id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `lists:read` `profiles:read`

Klaviyo Get Profile Relationships Segments

Get segment membership relationships for a profile with the given profile id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `profiles:read` `segments:read`

Klaviyo Get Profile Segments

Get segment memberships for a profile with the given profile id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `profiles:read` `segments:read`

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

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

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

Klaviyo 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/s` steady: `700/m` **scopes:** `profiles:read` `segments:read`

Klaviyo Get Segment Relationships Tags

If `related resource` is `tags`, returns the tag ids of all tags associated with the given segment id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `segments:read` `tags:read`

Klaviyo Get Segment Tags

Return all tags associated with the given segment id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `segments:read` `tags:read`

Klaviyo Get Tag

Retrieve the tag with the given tag id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read`

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

Klaviyo Get Tag Group

Retrieve the tag group with the given tag group id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read`

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

Klaviyo Get Tag Group Relationships Tags

Returns the tag ids of all tags inside the given tag group. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read`

Klaviyo Get Tag Group Tags

Return the tags for a given tag group id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read`

Klaviyo Get Tag Relationships Campaigns

Returns the ids of all campaigns associated with the given tag. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `campaigns:read` `tags:read`

Klaviyo Get Tag Relationships Flows

Returns the ids of all flows associated with the given tag. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read` `tags:read`

Klaviyo Get Tag Relationships Lists

Returns the ids of all lists associated with the given tag. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `lists:read` `tags:read`

Klaviyo Get Tag Relationships Segments

Returns the ids of all segments associated with the given tag. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `segments:read` `tags:read`

Klaviyo Get Tag Relationships Tag Group

Returns the id of the tag group related to the given tag. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read`

Klaviyo Get Tag Tag Group

Returns the tag group resource for a given tag id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read`

Klaviyo Get Template

Get a template with the given template id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `templates:read`

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

Klaviyo 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/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Update Categories Jobs

Get all catalog category bulk update jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo 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/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Update Items Jobs

Get all catalog item bulk update jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo 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/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Update Variants Jobs

Get all catalog variant bulk update jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Klaviyo Get Versions For Form

Get the form versions for the given form. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Klaviyo Get Version Ids For Form

Get the ids of the form versions for the given form. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Klaviyo Get Webhook

Get the webhook with the given id. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:read`

Klaviyo Get Webhooks

Get all webhooks in an account. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:read`

Klaviyo Get Webhook Topic

Get the webhook topic with the given id. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:read`

Klaviyo Get Webhook Topics

Get all webhook topics in a klaviyo account. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:read`

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

Klaviyo Query Campaign Values

Returns the requested campaign analytics values data *rate limits*: burst: `1/s` steady: `2/m` daily: `225/d` **scopes:** `campaigns:read`

Klaviyo Query Flow Series

Returns the requested flow analytics series data *rate limits*: burst: `1/s` steady: `2/m` daily: `225/d` **scopes:** `flows:read`

Klaviyo Query Flow Values

Returns the requested flow analytics values data *rate limits*: burst: `1/s` steady: `2/m` daily: `225/d` **scopes:** `flows:read`

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

Klaviyo 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 unsubscribe profiles action for complete unsubscribing. you can remove up to 1000 profiles per call. rate limits: 10/s burst, 150/m steady. required scopes: `lists:write` and `profiles:write`. preconditions: - either profile ids or emails must be provided (not both) - maximum 1000 profiles per call - email addresses must be valid format - the list must exist and be accessible

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

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

Klaviyo 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/s` steady: `700/m` **scopes:** `coupon-codes:write`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Klaviyo Update Campaign Message

Update a campaign message *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

Klaviyo Update Campaign Send Job

Permanently cancel the campaign, setting the status to canceled or revert the campaign, setting the status back to draft *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

Klaviyo Update Catalog Category

Update a catalog category with the given category id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Update Catalog Category Relationships Items

Update item relationships for the given category id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Update Catalog Item

Update a catalog item with the given item id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Update Catalog Item Relationships Categories

Update catalog category relationships for the given item id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Update Catalog Variant

Update a catalog item variant with the given variant id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Klaviyo Update Coupon

*rate limits*: burst: `3/s` steady: `60/m` **scopes:** `coupons:write`

Klaviyo 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/s` steady: `3500/m` **scopes:** `coupon-codes:write`

Klaviyo Update Flow Status

Update the status of a flow with the given flow id, and all actions in that flow. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:write`

Klaviyo Update Image

Update the image with the given image id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `images:write`

Klaviyo Update List

Update the name of a list with the given list id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `lists:write`

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

Klaviyo Update Segment

Update a segment with the given segment id. *rate limits*: burst: `1/s` steady: `15/m` daily: `100/d` **scopes:** `segments:write`

Klaviyo 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/s` steady: `60/m` **scopes:** `tags:read` `tags:write`

Klaviyo 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/s` steady: `60/m` **scopes:** `tags:read` `tags:write`

Klaviyo Update Template

Update a template with the given template id. does not currently update drag & drop templates. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `templates:write`

Klaviyo Update Webhook

Update the webhook with the given id. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:write`

Klaviyo 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/s` steady: `100/m` daily: `100/d` **scopes:** `images:write`

Klaviyo 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/s` steady: `100/m` daily: `100/d` **scopes:** `images:write`