Tools

Klaviyo

Learn how to use Klaviyo with Composio

Overview

Enum

KLAVIYO

Description

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

Authentication Details

api_key
stringRequired
client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to accounts:read campaigns:read campaigns:write conversations:read conversations:write catalogs:read catalogs:write coupons:read coupons:write coupon-codes:read coupon-codes:write data-privacy:read data-privacy:write events:read events:write flows:read flows:write images:read images:write lists:read lists:write metrics:read metrics:write profiles:read profiles:write push-tokens:read push-tokens:write segments:read segments:write subscriptions:read subscriptions:write tags:read tags:write templates:read templates:write

Actions

Delete a list with the given list id.rate limits:burst: 10/ssteady: 150/m scopes: lists:write

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

Get the form associated with the given form version.rate limits:burst: 3/ssteady: 60/m scopes: forms:read

Action Parameters

id
stringRequired
fields__form
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__tag
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

fields__catalog__item__bulk__update__job
array
filter
string
page__cursor
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__metric
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

To list campaigns, use a channel filter (email or sms). rate limits apply: 10/s (burst), 150/m (steady). required scope: campaigns:read.

Action Parameters

filter
stringRequired
fields__campaign__message
array
fields__campaign
array
fields__tag
array
include
array
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

fields__template
array
filter
string
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

Returns the requested flow analytics values datarate limits:burst: 1/ssteady: 2/mdaily: 225/d scopes: flows:read

Action Parameters

page_cursor
string
data__type
string
data__attributes__statistics
array
data__attributes__timeframe
object
data__attributes__conversion__metric__id
string
data__attributes__filter
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

fields__catalog__category__bulk__delete__job
array
filter
string
page__cursor
string

Action Response

data
object
successful
boolean
error

Returns the requested flow analytics series datarate limits:burst: 1/ssteady: 2/mdaily: 225/d scopes: flows:read

Action Parameters

page_cursor
string
data__type
string
data__attributes__statistics
array
data__attributes__timeframe
object
data__attributes__interval
string
data__attributes__conversion__metric__id
string
data__attributes__filter
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__catalog__category
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

fields__coupon__code
array
fields__coupon
array
filter
string
include
array
page__cursor
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__title
string
data__attributes__price
integer
data__attributes__description
string
data__attributes__url
string
data__attributes__image__full__url
string
data__attributes__image__thumbnail__url
string
data__attributes__images
array
data__attributes__published
boolean
data__relationships__categories__data
array

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

fields__catalog__category
array
filter
string
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

rate limits:burst: 3/ssteady: 60/m scopes: coupons:write

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__description
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__name
string
data__relationships__items__data
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

company_id
stringRequired
data__type
string
data__attributes__channels
array
data__attributes__profile__data__type
string
data__attributes__profile__data__id
string
data__attributes__profile__data__attributes__email
string
data__attributes__profile__data__attributes__phone__number
string
data__attributes__profile__data__attributes__external__id
string
data__attributes__profile__data__attributes__anonymous__id
string
data__relationships__variant__data__type
string
data__relationships__variant__data__id
string

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

data__type
string
data__attributes__name
string
data__attributes__import__from__url
string
data__attributes__hidden
boolean

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Update a campaign with the given campaign id.rate limits:burst: 10/ssteady: 150/m scopes: campaigns:write

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__name
string
data__attributes__audiences__included
array
data__attributes__audiences__excluded
array
data__attributes__send__options
object
data__attributes__tracking__options
object
data__attributes__send__strategy__method
string
data__attributes__send__strategy__options__static__datetime
string
data__attributes__send__strategy__options__static__is__local
boolean
data__attributes__send__strategy__options__static__send__past__recipients__immediately
boolean
data__attributes__send__strategy__options__throttled__datetime
string
data__attributes__send__strategy__options__throttled__throttle__percentage
integer
data__attributes__send__strategy__options__sto__date
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

data__type
string
data__attributes__profiles__data
array
data__relationships__list__data__type
string
data__relationships__list__data__id
string
data__relationships__segment__data__type
string
data__relationships__segment__data__id
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__variants__data
array

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

id
stringRequired
fields__account
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

fields__catalog__item__bulk__delete__job
array
filter
string
page__cursor
string

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__name
string
data__attributes__return__fields
array

Action Response

data
object
successful
boolean
error

Get a list of related metrics for an eventrate limits:burst: 350/ssteady: 3500/m scopes: events:read metrics:read

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Return the related campaignrate limits:burst: 10/ssteady: 150/m scopes: campaigns:read

Action Parameters

id
stringRequired
fields__campaign
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

job_id
stringRequired
fields__coupon__code__bulk__create__job
array
fields__coupon__code
array
include
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

company_id
stringRequired
data__type
string
data__id
string
data__attributes__email
string
data__attributes__phone__number
string
data__attributes__external__id
string
data__attributes__anonymous__id
string
data__attributes____kx
string
data__attributes__first__name
string
data__attributes__last__name
string
data__attributes__organization
string
data__attributes__title
string
data__attributes__image
string
data__attributes__location__address1
string
data__attributes__location__address2
string
data__attributes__location__city
string
data__attributes__location__country
string
data__attributes__location__latitude
string
data__attributes__location__longitude
string
data__attributes__location__region
string
data__attributes__location__zip
string
data__attributes__location__timezone
string
data__attributes__location__ip
string
data__meta__patch__properties__unset
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

fields__catalog__variant
array
filter
string
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

Create a new profile.rate limits:burst: 75/ssteady: 700/m scopes: profiles:write

Action Parameters

data__type
string
data__attributes__email
string
data__attributes__phone__number
string
data__attributes__external__id
string
data__attributes__first__name
string
data__attributes__last__name
string
data__attributes__organization
string
data__attributes__title
string
data__attributes__image
string
data__attributes__location__address1
string
data__attributes__location__address2
string
data__attributes__location__city
string
data__attributes__location__country
string
data__attributes__location__latitude
string
data__attributes__location__longitude
string
data__attributes__location__region
string
data__attributes__location__zip
string
data__attributes__location__timezone
string
data__attributes__location__ip
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__time
string
data__attributes__value
integer
data__attributes__value__currency
string
data__attributes__unique__id
string
data__attributes__metric__data__type
string
data__attributes__metric__data__attributes__name
string
data__attributes__metric__data__attributes__service
string
data__attributes__profile__data__type
string
data__attributes__profile__data__id
string
data__attributes__profile__data__attributes__email
string
data__attributes__profile__data__attributes__phone__number
string
data__attributes__profile__data__attributes__external__id
string
data__attributes__profile__data__attributes__anonymous__id
string
data__attributes__profile__data__attributes____kx
string
data__attributes__profile__data__attributes__first__name
string
data__attributes__profile__data__attributes__last__name
string
data__attributes__profile__data__attributes__organization
string
data__attributes__profile__data__attributes__title
string
data__attributes__profile__data__attributes__image
string
data__attributes__profile__data__attributes__location__address1
string
data__attributes__profile__data__attributes__location__address2
string
data__attributes__profile__data__attributes__location__city
string
data__attributes__profile__data__attributes__location__country
string
data__attributes__profile__data__attributes__location__latitude
string
data__attributes__profile__data__attributes__location__longitude
string
data__attributes__profile__data__attributes__location__region
string
data__attributes__profile__data__attributes__location__zip
string
data__attributes__profile__data__attributes__location__timezone
string
data__attributes__profile__data__attributes__location__ip
string
data__attributes__profile__data__attributes__meta__patch__properties__unset
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
additional__fields__list
array
fields__list
array
fields__tag
array
include
array

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

file
object
name
string
hidden
boolean

Action Response

data
object
successful
boolean
error

Create a segment.rate limits:burst: 1/ssteady: 15/mdaily: 100/d scopes: segments:write

Action Parameters

data__type
string
data__attributes__name
string
data__attributes__definition__condition__groups
array
data__attributes__is__starred
boolean

Action Response

data
object
successful
boolean
error

Delete a campaign with the given campaign id.rate limits:burst: 10/ssteady: 150/m scopes: campaigns:write

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

fields__catalog__variant__bulk__create__job
array
filter
string
page__cursor
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Get a metric with the given metric id.rate limits:burst: 10/ssteady: 150/m scopes: metrics:read

Action Parameters

id
stringRequired
fields__metric
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
filter
string
page__cursor
string
page__size
integerDefaults to 50
sort
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__profile__data__type
string
data__attributes__profile__data__id
string
data__attributes__profile__data__attributes__email
string
data__attributes__profile__data__attributes__phone__number
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__segment
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

fields__catalog__category__bulk__update__job
array
filter
string
page__cursor
string

Action Response

data
object
successful
boolean
error

Create a new catalog item.rate limits:burst: 75/ssteady: 700/m scopes: catalogs:write

Action Parameters

data__type
string
data__attributes__external__id
string
data__attributes__integration__type
stringDefaults to $custom
data__attributes__title
string
data__attributes__price
integer
data__attributes__catalog__type
stringDefaults to $default
data__attributes__description
string
data__attributes__url
string
data__attributes__image__full__url
string
data__attributes__image__thumbnail__url
string
data__attributes__images
array
data__attributes__published
booleanDefaults to True
data__relationships__categories__data
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

data__type
string
data__id
string
data__relationships__template__data__type
string
data__relationships__template__data__id
string

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

job_id
stringRequired
fields__catalog__variant__bulk__create__job
array
fields__catalog__variant
array
include
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__name
string
data__attributes__exclusive
boolean

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

fields__metric
array
filter
string
page__cursor
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
additional__fields__profile
array
fields__profile
array
filter
string
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
fields__catalog__variant
array
filter
string
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

Get a flow with the given flow id.rate limits:burst: 3/ssteady: 60/m scopes: flows:read

Action Parameters

id
stringRequired
fields__flow__action
array
fields__flow
array
fields__tag
array
include
array

Action Response

data
object
successful
boolean
error

Create a new catalog category.rate limits:burst: 75/ssteady: 700/m scopes: catalogs:write

Action Parameters

data__type
string
data__attributes__external__id
string
data__attributes__name
string
data__attributes__integration__type
stringDefaults to $custom
data__attributes__catalog__type
stringDefaults to $default
data__relationships__items__data
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

fields__catalog__variant__bulk__update__job
array
filter
string
page__cursor
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
additional__fields__segment
array
fields__segment
array
fields__tag
array
include
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

id
stringRequired
filter
string
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
filter
string
page__size
integerDefaults to 50
sort
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__name
string

Action Response

data
object
successful
boolean
error

Gets the coupon relationship associated with the given coupon code idrate limits:burst: 75/ssteady: 700/m scopes: coupons:read

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__channels
array
data__attributes__profile__data__type
string
data__attributes__profile__data__id
string
data__attributes__profile__data__attributes__email
string
data__attributes__profile__data__attributes__phone__number
string
data__attributes__profile__data__attributes__external__id
string
data__attributes__profile__data__attributes__anonymous__id
string
data__relationships__variant__data__type
string
data__relationships__variant__data__id
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
additional__fields__profile
array
fields__profile
array
page__cursor
string
page__size
integerDefaults to 20

Action Response

data
object
successful
boolean
error

Retrieve the tag group with the given tag group id.rate limits:burst: 3/ssteady: 60/m scopes: tags:read

Action Parameters

id
stringRequired
fields__tag__group
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__coupon
array

Action Response

data
object
successful
boolean
error

Creates a new coupon.rate limits:burst: 3/ssteady: 60/m scopes: coupons:write

Action Parameters

data__type
string
data__attributes__external__id
string
data__attributes__description
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Update the webhook with the given id.rate limits:burst: 1/ssteady: 15/m scopes: webhooks:write

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__name
string
data__attributes__description
string
data__attributes__endpoint__url
string
data__attributes__secret__key
string
data__attributes__enabled
boolean
data__relationships__webhook__topics__data
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

additional__fields__profile
array
fields__profile
array
filter
string
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
object
successful
boolean
error

Delete a template with the given template id.rate limits:burst: 10/ssteady: 150/m scopes: templates:write

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__name
string
data__attributes__editor__type
string
data__attributes__html
string
data__attributes__text
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__tag
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__items__data
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__items__data
array

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Gets a list of coupon code relationships associated with the given coupon idrate limits:burst: 75/ssteady: 700/m scopes: coupon-codes:read

Action Parameters

id
stringRequired
page__cursor
string

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

id
stringRequired
fields__campaign__recipient__estimation__job
array

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

data__type
string
data__attributes__metric__id
string
data__attributes__page__cursor
string
data__attributes__measurements
array
data__attributes__interval
stringDefaults to day
data__attributes__page__size
integerDefaults to 500
data__attributes__by
array
data__attributes__return__fields
array
data__attributes__filter
array
data__attributes__timezone
stringDefaults to UTC
data__attributes__sort
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

fields__event
array
fields__metric
array
fields__profile
array
filter
string
include
array
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
fields__campaign__recipient__estimation
array

Action Response

data
object
successful
boolean
error

Gets a list of coupon codes associated with the given coupon idrate limits:burst: 75/ssteady: 700/m scopes: coupon-codes:read

Action Parameters

id
stringRequired
fields__coupon__code
array
filter
string
page__cursor
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__id
string
data__attributes__name
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__list
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__id
string

Action Response

data
object
successful
boolean
error

Get the form version with the given id.rate limits:burst: 3/ssteady: 60/m scopes: forms:read

Action Parameters

id
stringRequired
fields__form__version
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__flow
array

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

fields__profile__bulk__import__job
array
filter
string
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

data__type
string
data__attributes__unique__code
string
data__attributes__expires__at
string
data__relationships__coupon__data__type
string
data__relationships__coupon__data__id
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

fields__tag__group
array
fields__tag
array
filter
string
include
array
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

company_id
stringRequired
data__type
string
data__attributes__profile__data__type
string
data__attributes__profile__data__id
string
data__attributes__profile__data__attributes__email
string
data__attributes__profile__data__attributes__phone__number
string
data__attributes__profile__data__attributes__external__id
string
data__attributes__profile__data__attributes__anonymous__id
string
data__attributes__profile__data__attributes____kx
string
data__attributes__profile__data__attributes__first__name
string
data__attributes__profile__data__attributes__last__name
string
data__attributes__profile__data__attributes__organization
string
data__attributes__profile__data__attributes__title
string
data__attributes__profile__data__attributes__image
string
data__attributes__profile__data__attributes__location__address1
string
data__attributes__profile__data__attributes__location__address2
string
data__attributes__profile__data__attributes__location__city
string
data__attributes__profile__data__attributes__location__country
string
data__attributes__profile__data__attributes__location__latitude
string
data__attributes__profile__data__attributes__location__longitude
string
data__attributes__profile__data__attributes__location__region
string
data__attributes__profile__data__attributes__location__zip
string
data__attributes__profile__data__attributes__location__timezone
string
data__attributes__profile__data__attributes__location__ip
string
data__attributes__profile__data__meta__patch__properties__unset
array
data__attributes__events__data
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__title
string
data__attributes__description
string
data__attributes__sku
string
data__attributes__inventory__policy
integer
data__attributes__inventory__quantity
integer
data__attributes__price
integer
data__attributes__url
string
data__attributes__image__full__url
string
data__attributes__image__thumbnail__url
string
data__attributes__images
array
data__attributes__published
boolean

Action Response

data
object
successful
boolean
error

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

Action Parameters

job_id
stringRequired
fields__catalog__category__bulk__delete__job
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__import__error
array
page__cursor
string
page__size
integerDefaults to 20

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
fields__catalog__category
array
filter
string
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
page__cursor
string
page__size
integerDefaults to 20

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

job_id
stringRequired
fields__catalog__category__bulk__create__job
array
fields__catalog__category
array
include
array

Action Response

data
object
successful
boolean
error

Returns the requested campaign analytics values datarate limits:burst: 1/ssteady: 2/mdaily: 225/d scopes: campaigns:read

Action Parameters

page_cursor
string
data__type
string
data__attributes__statistics
array
data__attributes__timeframe
object
data__attributes__conversion__metric__id
string
data__attributes__filter
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__email
string
data__attributes__phone__number
string
data__attributes__external__id
string
data__attributes__anonymous__id
string
data__attributes__first__name
string
data__attributes__last__name
string
data__attributes__organization
string
data__attributes__title
string
data__attributes__image
string
data__attributes__location__address1
string
data__attributes__location__address2
string
data__attributes__location__city
string
data__attributes__location__country
string
data__attributes__location__latitude
string
data__attributes__location__longitude
string
data__attributes__location__region
string
data__attributes__location__zip
string
data__attributes__location__timezone
string
data__attributes__location__ip
string
data__meta__patch__properties__unset
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

fields__tag__group
array
filter
string
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

fields__coupon__code__bulk__create__job
array
filter
string
page__cursor
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__variants__data
array

Action Response

data
object
successful
boolean
error

Get all forms in an account.rate limits:burst: 3/ssteady: 60/m scopes: forms:read

Action Parameters

fields__form
array
filter
string
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
additional__fields__profile
array
fields__profile
array
filter
string
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

company_id
stringRequired
data__type
string
data__attributes__token
string
data__attributes__platform
string
data__attributes__enablement__status
stringDefaults to AUTHORIZED
data__attributes__vendor
string
data__attributes__background
stringDefaults to AVAILABLE
data__attributes__device__metadata__device__id
string
data__attributes__device__metadata__klaviyo__sdk
string
data__attributes__device__metadata__sdk__version
string
data__attributes__device__metadata__device__model
string
data__attributes__device__metadata__os__name
string
data__attributes__device__metadata__os__version
string
data__attributes__device__metadata__manufacturer
string
data__attributes__device__metadata__app__name
string
data__attributes__device__metadata__app__version
string
data__attributes__device__metadata__app__build
string
data__attributes__device__metadata__app__id
string
data__attributes__device__metadata__environment
string
data__attributes__profile__data__type
string
data__attributes__profile__data__id
string
data__attributes__profile__data__attributes__phone__number
string
data__attributes__profile__data__attributes__external__id
string
data__attributes__profile__data__attributes__anonymous__id
string
data__attributes__profile__data__attributes____kx
string
data__attributes__profile__data__attributes__first__name
string
data__attributes__profile__data__attributes__last__name
string
data__attributes__profile__data__attributes__organization
string
data__attributes__profile__data__attributes__title
string
data__attributes__profile__data__attributes__image
string
data__attributes__profile__data__attributes__location__address1
string
data__attributes__profile__data__attributes__location__address2
string
data__attributes__profile__data__attributes__location__city
string
data__attributes__profile__data__attributes__location__country
string
data__attributes__profile__data__attributes__location__latitude
string
data__attributes__profile__data__attributes__location__longitude
string
data__attributes__profile__data__attributes__location__region
string
data__attributes__profile__data__attributes__location__zip
string
data__attributes__profile__data__attributes__location__timezone
string
data__attributes__profile__data__attributes__location__ip
string
data__attributes__profile__data__attributes__meta__patch__properties__unset
array
data__attributes__profile__data__attributes__email
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__tag
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__campaign__message
array
fields__campaign
array
fields__template
array
include
array

Action Response

data
object
successful
boolean
error

Delete a segment with the given segment id.rate limits:burst: 3/ssteady: 60/m scopes: segments:write

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

fields__catalog__category__bulk__create__job
array
filter
string
page__cursor
string

Action Response

data
object
successful
boolean
error

Return the related templaterate limits:burst: 10/ssteady: 150/m scopes: campaigns:read templates:read

Action Parameters

id
stringRequired
fields__template
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

data__type
string
data__attributes__external__id
string
data__attributes__catalog__type
stringDefaults to $default
data__attributes__integration__type
stringDefaults to $custom
data__attributes__title
string
data__attributes__description
string
data__attributes__sku
string
data__attributes__inventory__policy
integer
data__attributes__inventory__quantity
integer
data__attributes__price
integer
data__attributes__url
string
data__attributes__image__full__url
string
data__attributes__image__thumbnail__url
string
data__attributes__images
array
data__attributes__published
booleanDefaults to True
data__relationships__item__data__type
string
data__relationships__item__data__id
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

fields__coupon
array
page__cursor
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__id
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

job_id
stringRequired
fields__catalog__item__bulk__delete__job
array

Action Response

data
object
successful
boolean
error

Create a new webhookrate limits:burst: 1/ssteady: 15/m scopes: webhooks:write

Action Parameters

data__type
string
data__attributes__name
string
data__attributes__description
string
data__attributes__endpoint__url
string
data__attributes__secret__key
string
data__relationships__webhook__topics__data
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__profiles__data
array
data__relationships__list__data__type
string
data__relationships__list__data__id
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

data__type
string
data__attributes__name
string
data__relationships__tag__group__data__type
string
data__relationships__tag__group__data__id
string

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

id
stringRequired
page__cursor
string

Action Response

data
object
successful
boolean
error

Get all images in an account.rate limits:burst: 10/ssteady: 150/m scopes: images:read

Action Parameters

fields__image
array
filter
string
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
fields__flow__message
array
filter
string
page__size
integerDefaults to 50
sort
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

fields__catalog__variant__bulk__delete__job
array
filter
string
page__cursor
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__profiles__data
array
data__relationships__list__data__type
string
data__relationships__list__data__id
string
data__relationships__segment__data__type
string
data__relationships__segment__data__id
string

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

job_id
stringRequired
fields__catalog__item__bulk__create__job
array
fields__catalog__item
array
include
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__categories__data
array

Action Response

data
object
successful
boolean
error

Delete a flow with the given flow id.rate limits:burst: 3/ssteady: 60/m scopes: flows:write

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__status
string

Action Response

data
object
successful
boolean
error

Get the image with the given image id.rate limits:burst: 10/ssteady: 150/m scopes: images:read

Action Parameters

id
stringRequired
fields__image
array

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

job_id
stringRequired
fields__catalog__item__bulk__update__job
array
fields__catalog__item
array
include
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__events__bulk__create__data
array

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

job_id
stringRequired
fields__catalog__category__bulk__update__job
array
fields__catalog__category
array
include
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

fields__list
array
fields__tag
array
filter
string
include
array
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__flow__action
array
fields__flow__message
array
fields__template
array
include
array

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

id
stringRequired
page__cursor
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__list
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

Action Response

data
object
successful
boolean
error

Returns a specific campaign based on a required id.rate limits:burst: 10/ssteady: 150/m scopes: campaigns:read

Action Parameters

id
stringRequired
fields__campaign__message
array
fields__campaign
array
fields__tag
array
include
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__catalog__item
array
fields__catalog__variant
array
include
array

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__name
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__tag
array

Action Response

data
object
successful
boolean
error

Get the webhook with the given id.rate limits:burst: 1/ssteady: 15/m scopes: webhooks:read

Action Parameters

id
stringRequired
fields__webhook
array
include
array

Action Response

data
object
successful
boolean
error

Return the related templaterate limits:burst: 3/ssteady: 60/m scopes: templates:read

Action Parameters

id
stringRequired
fields__template
array

Action Response

data
object
successful
boolean
error

Get the form versions for the given form.rate limits:burst: 3/ssteady: 60/m scopes: forms:read

Action Parameters

id
stringRequired
fields__form__version
array
filter
string
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Create a new list.rate limits:burst: 10/ssteady: 150/mdaily: 100/d scopes: lists:write

Action Parameters

data__type
string
data__attributes__name
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__campaign__message
array
fields__campaign
array
fields__template
array
include
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

fields__account
array

Action Response

data
object
successful
boolean
error

Delete a webhook with the given id.rate limits:burst: 1/ssteady: 15/m scopes: webhooks:write

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

Delete the coupon with the given coupon id.rate limits:burst: 3/ssteady: 60/m scopes: coupons:write

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

company_id
stringRequired
data__type
string
data__attributes__time
string
data__attributes__value
integer
data__attributes__value__currency
string
data__attributes__unique__id
string
data__attributes__metric__data__type
string
data__attributes__metric__data__attributes__name
string
data__attributes__metric__data__attributes__service
string
data__attributes__profile__data__type
string
data__attributes__profile__data__id
string
data__attributes__profile__data__attributes__email
string
data__attributes__profile__data__attributes__phone__number
string
data__attributes__profile__data__attributes__external__id
string
data__attributes__profile__data__attributes__anonymous__id
string
data__attributes__profile__data__attributes____kx
string
data__attributes__profile__data__attributes__first__name
string
data__attributes__profile__data__attributes__last__name
string
data__attributes__profile__data__attributes__organization
string
data__attributes__profile__data__attributes__title
string
data__attributes__profile__data__attributes__image
string
data__attributes__profile__data__attributes__location__address1
string
data__attributes__profile__data__attributes__location__address2
string
data__attributes__profile__data__attributes__location__city
string
data__attributes__profile__data__attributes__location__country
string
data__attributes__profile__data__attributes__location__latitude
string
data__attributes__profile__data__attributes__location__longitude
string
data__attributes__profile__data__attributes__location__region
string
data__attributes__profile__data__attributes__location__zip
string
data__attributes__profile__data__attributes__location__timezone
string
data__attributes__profile__data__attributes__location__ip
string
data__attributes__profile__data__attributes__meta__patch__properties__unset
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

company_id
stringRequired
data__type
string
data__attributes__token
string
data__attributes__platform
string
data__attributes__vendor
string
data__attributes__profile__data__type
string
data__attributes__profile__data__id
string
data__attributes__profile__data__attributes__email
string
data__attributes__profile__data__attributes__phone__number
string
data__attributes__profile__data__attributes__external__id
string
data__attributes__profile__data__attributes__anonymous__id
string
data__attributes__profile__data__attributes____kx
string
data__attributes__profile__data__attributes__first__name
string
data__attributes__profile__data__attributes__last__name
string
data__attributes__profile__data__attributes__organization
string
data__attributes__profile__data__attributes__title
string
data__attributes__profile__data__attributes__image
string
data__attributes__profile__data__attributes__location__address1
string
data__attributes__profile__data__attributes__location__address2
string
data__attributes__profile__data__attributes__location__city
string
data__attributes__profile__data__attributes__location__country
string
data__attributes__profile__data__attributes__location__latitude
string
data__attributes__profile__data__attributes__location__longitude
string
data__attributes__profile__data__attributes__location__region
string
data__attributes__profile__data__attributes__location__zip
string
data__attributes__profile__data__attributes__location__timezone
string
data__attributes__profile__data__attributes__location__ip
string
data__attributes__profile__data__meta__patch__properties__unset
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__coupon
array

Action Response

data
object
successful
boolean
error

Get all webhooks in an account.rate limits:burst: 1/ssteady: 15/m scopes: webhooks:read

Action Parameters

fields__webhook
array
include
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

data__type
string
data__attributes__name
string
data__attributes__audiences__included
array
data__attributes__audiences__excluded
array
data__attributes__send__strategy__method
string
data__attributes__send__strategy__options__static__datetime
string
data__attributes__send__strategy__options__static__is__local
boolean
data__attributes__send__strategy__options__static__send__past__recipients__immediately
boolean
data__attributes__send__strategy__options__throttled__datetime
string
data__attributes__send__strategy__options__throttled__throttle__percentage
integer
data__attributes__send__strategy__options__sto__date
string
data__attributes__send__options
object
data__attributes__tracking__options
object
data__attributes__campaign__messages__data
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__profiles__data
array
data__relationships__lists__data
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
fields__catalog__item
array
fields__catalog__variant
array
filter
string
include
array
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

fields__catalog__item
array
fields__catalog__variant
array
filter
string
include
array
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

Update a campaign messagerate limits:burst: 10/ssteady: 150/m scopes: campaigns:write

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__label
string
data__attributes__content
object
data__attributes__render__options__shorten__links
booleanDefaults to True
data__attributes__render__options__add__org__prefix
booleanDefaults to True
data__attributes__render__options__add__info__link
booleanDefaults to True
data__attributes__render__options__add__opt__out__language
boolean

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

fields__flow__action
array
fields__flow
array
fields__tag
array
filter
string
include
array
page__cursor
string
page__size
integerDefaults to 50
sort
string

Action Response

data
object
successful
boolean
error

Trigger a campaign to send asynchronouslyrate limits:burst: 10/ssteady: 150/m scopes: campaigns:write

Action Parameters

data__type
string
data__id
string

Action Response

data
object
successful
boolean
error

Get an event with the given event id.rate limits:burst: 10/ssteady: 150/m scopes: events:read

Action Parameters

id
stringRequired
fields__event
array
fields__metric
array
fields__profile
array
include
array

Action Response

data
object
successful
boolean
error

Update a segment with the given segment id.rate limits:burst: 1/ssteady: 15/mdaily: 100/d scopes: segments:write

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__definition__condition__groups
array
data__attributes__name
string
data__attributes__is__starred
boolean

Action Response

data
object
successful
boolean
error

Retrieve the tag with the given tag id.rate limits:burst: 3/ssteady: 60/m scopes: tags:read

Action Parameters

id
stringRequired
fields__tag__group
array
fields__tag
array
include
array

Action Response

data
object
successful
boolean
error

Get the form with the given id.rate limits:burst: 3/ssteady: 60/m scopes: forms:read

Action Parameters

id
stringRequired
fields__form__version
array
fields__form
array
include
array

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

data__type
string
data__attributes__coupon__codes__data
array

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__status
string
data__attributes__expires__at
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__catalog__variant
array

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

job_id
stringRequired
fields__catalog__variant__bulk__update__job
array
fields__catalog__variant
array
include
array

Action Response

data
object
successful
boolean
error

Returns the id of the related templaterate limits:burst: 3/ssteady: 60/m scopes: templates:read

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

fields__catalog__item__bulk__create__job
array
filter
string
page__cursor
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
additional__fields__profile
array
fields__profile
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

Get a campaign send jobrate limits:burst: 10/ssteady: 150/m scopes: campaigns:read

Action Parameters

id
stringRequired
fields__campaign__send__job
array

Action Response

data
object
successful
boolean
error

Returns the id of the related campaignrate limits:burst: 10/ssteady: 150/m scopes: campaigns:read

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

fields__segment
array
fields__tag
array
filter
string
include
array
page__cursor
string
sort
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__id
string
data__attributes__email
string
data__attributes__phone__number
string
data__attributes__external__id
string
data__attributes__anonymous__id
string
data__attributes____kx
string
data__attributes__first__name
string
data__attributes__last__name
string
data__attributes__organization
string
data__attributes__title
string
data__attributes__image
string
data__attributes__location__address1
string
data__attributes__location__address2
string
data__attributes__location__city
string
data__attributes__location__country
string
data__attributes__location__latitude
string
data__attributes__location__longitude
string
data__attributes__location__region
string
data__attributes__location__zip
string
data__attributes__location__timezone
string
data__attributes__location__ip
string
data__meta__patch__properties__unset
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__flow__action
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__custom__source
string
data__attributes__profiles__data
array
data__attributes__historical__import
boolean
data__relationships__list__data__type
string
data__relationships__list__data__id
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__items__data
array

Action Response

data
object
successful
boolean
error

Get a template with the given template id.rate limits:burst: 10/ssteady: 150/m scopes: templates:read

Action Parameters

id
stringRequired
fields__template
array

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__action
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__tag
array

Action Response

data
object
successful
boolean
error

Get the profile with the given profile id.rate limits:burst: 75/ssteady: 700/m scopes: profiles:read

Action Parameters

id
stringRequired
additional__fields__profile
array
fields__list
array
fields__profile
array
fields__segment
array
include
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__name
string
data__attributes__html
string
data__attributes__text
string

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

data__type
string
data__id
string
data__attributes__new__name
string

Action Response

data
object
successful
boolean
error

Update the image with the given image id.rate limits:burst: 10/ssteady: 150/m scopes: images:write

Action Parameters

id
stringRequired
data__type
string
data__id
string
data__attributes__name
string
data__attributes__hidden
boolean

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

id
stringRequired
filter
string
page__cursor
string
page__size
integerDefaults to 20
sort
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__variants__data
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__categories__data
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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:write

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

job_id
stringRequired
fields__catalog__variant__bulk__delete__job
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
data
arrayRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__categories__data
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

job_id
stringRequired
fields__list
array
fields__profile__bulk__import__job
array
include
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

company_id
stringRequired
data__type
string
data__attributes__custom__source
string
data__attributes__profile__data__type
string
data__attributes__profile__data__id
string
data__attributes__profile__data__attributes__email
string
data__attributes__profile__data__attributes__phone__number
string
data__attributes__profile__data__attributes__external__id
string
data__attributes__profile__data__attributes__anonymous__id
string
data__attributes__profile__data__attributes____kx
string
data__attributes__profile__data__attributes__first__name
string
data__attributes__profile__data__attributes__last__name
string
data__attributes__profile__data__attributes__organization
string
data__attributes__profile__data__attributes__title
string
data__attributes__profile__data__attributes__image
string
data__attributes__profile__data__attributes__location__address1
string
data__attributes__profile__data__attributes__location__address2
string
data__attributes__profile__data__attributes__location__city
string
data__attributes__profile__data__attributes__location__country
string
data__attributes__profile__data__attributes__location__latitude
string
data__attributes__profile__data__attributes__location__longitude
string
data__attributes__profile__data__attributes__location__region
string
data__attributes__profile__data__attributes__location__zip
string
data__attributes__profile__data__attributes__location__timezone
string
data__attributes__profile__data__attributes__location__ip
string
data__attributes__profile__data__meta__patch__properties__unset
array
data__relationships__list__data__type
string
data__relationships__list__data__id
string

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__attributes__token
string
data__attributes__platform
string
data__attributes__enablement__status
stringDefaults to AUTHORIZED
data__attributes__vendor
string
data__attributes__background
stringDefaults to AVAILABLE
data__attributes__device__metadata__device__id
string
data__attributes__device__metadata__klaviyo__sdk
string
data__attributes__device__metadata__sdk__version
string
data__attributes__device__metadata__device__model
string
data__attributes__device__metadata__os__name
string
data__attributes__device__metadata__os__version
string
data__attributes__device__metadata__manufacturer
string
data__attributes__device__metadata__app__name
string
data__attributes__device__metadata__app__version
string
data__attributes__device__metadata__app__build
string
data__attributes__device__metadata__app__id
string
data__attributes__device__metadata__environment
string
data__attributes__profile__data__type
string
data__attributes__profile__data__id
string
data__attributes__profile__data__attributes__phone__number
string
data__attributes__profile__data__attributes__external__id
string
data__attributes__profile__data__attributes__anonymous__id
string
data__attributes__profile__data__attributes____kx
string
data__attributes__profile__data__attributes__first__name
string
data__attributes__profile__data__attributes__last__name
string
data__attributes__profile__data__attributes__organization
string
data__attributes__profile__data__attributes__title
string
data__attributes__profile__data__attributes__image
string
data__attributes__profile__data__attributes__location__address1
string
data__attributes__profile__data__attributes__location__address2
string
data__attributes__profile__data__attributes__location__city
string
data__attributes__profile__data__attributes__location__country
string
data__attributes__profile__data__attributes__location__latitude
string
data__attributes__profile__data__attributes__location__longitude
string
data__attributes__profile__data__attributes__location__region
string
data__attributes__profile__data__attributes__location__zip
string
data__attributes__profile__data__attributes__location__timezone
string
data__attributes__profile__data__attributes__location__ip
string
data__attributes__profile__data__attributes__meta__patch__properties__unset
array
data__attributes__profile__data__attributes__email
string

Action Response

data
object
successful
boolean
error

Returns the id of the related templaterate limits:burst: 10/ssteady: 150/m scopes: campaigns:read templates:read

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__coupon__code
array
fields__coupon
array
include
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__flow__action
array
fields__flow__message
array
fields__flow
array
include
array

Action Response

data
object
successful
boolean
error

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.

Action Parameters

data__type
string
data__id
string
data__relationships__profiles__data
array

Action Response

data
object
successful
boolean
error

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:read

Action Parameters

id
stringRequired
fields__flow__action
array
filter
string
page__cursor
string
page__size
integerDefaults to 50
sort
string

Action Response

data
object
successful
boolean
error

Get the webhook topic with the given id.rate limits:burst: 1/ssteady: 15/m scopes: webhooks:read

Action Parameters

id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

id
stringRequired
fields__tag__group
array

Action Response

data
object
successful
boolean
error