Events

Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)

Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)

Primary key that uniquely identifies this list. Generated by Klaviyo.

Lists

Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)

A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.

URL pointing to the location of a profile image

Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)

Name of the company or organization within the company for whom the individual works

Individual's phone number in E.164 format

An object containing key/value pairs for any custom properties assigned to this profile

Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)

Primary key that uniquely identifies this profile. Generated by Klaviyo.

Profiles

Segments

Klaviyo

Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.

You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API. *Rate limits*: Burst: `1/s` Steady: `15/m`

**Scopes:**
`accounts:read`

Get Accounts

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`

Get Account

Returns some or all campaigns based on filters.

A channel filter is required to list campaigns. Please provide either:
`?filter=equals(messages.channel,'email')` to list email campaigns, or
`?filter=equals(messages.channel,'sms')` to list SMS campaigns.
`?filter=equals(messages.channel,'mobile_push')` to list mobile push campaigns. *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`

Get Campaigns

Creates a campaign given a set of parameters, then returns it. *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:write`

Create Campaign

Returns a specific campaign based on a required id. *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`

Get Campaign

Update a campaign with the given campaign ID. *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:write`

Update Campaign

Delete a campaign with the given campaign ID. *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:write`

Delete Campaign

Returns a specific message based on a required id. *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`

Get Campaign Message

Update a campaign message *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:write`

Update Campaign Message

Get a campaign send job *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`

Get 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`

Cancel Campaign Send

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`

Get Campaign Recipient Estimation Job

Get the estimated recipient count for a campaign with the provided campaign ID.
You can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint. *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`

Get Campaign Recipient Estimation

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`

Create Campaign Clone

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`

Assign Template to Campaign Message

Trigger a campaign to send asynchronously *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:write`

Send Campaign

Trigger an asynchronous job to update the estimated number of recipients
for the given campaign ID. Use the `Get Campaign Recipient Estimation
Job` endpoint to retrieve the status of this estimation job. Use the
`Get Campaign Recipient Estimation` endpoint to retrieve the estimated
recipient count for a given campaign. *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:write`

Refresh Campaign Recipient Estimation

Return the related campaign *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`

Get Campaign for Campaign Message

Returns the ID of the related campaign *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`

Get Campaign ID for Campaign Message

Return the related template *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`
`templates:read`

Get Template for Campaign Message

Returns the ID of the related template *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`
`templates:read`

Get Template ID for Campaign Message

Return the related image for a given campaign message *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`
`images:read`

Get Image for Campaign Message

Returns the ID of the related image *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`
`images:read`

Get Image ID for Campaign Message

Update a campaign message image *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:write`
`images:read`

Update Image for Campaign Message

Return all tags that belong to the given campaign. *Rate limits*: Burst: `3/s` Steady: `60/m`

**Scopes:**
`campaigns:read`
`tags:read`

Get Tags for Campaign

Returns the IDs of all tags associated with the given campaign. *Rate limits*: Burst: `3/s` Steady: `60/m`

**Scopes:**
`campaigns:read`
`tags:read`

Get Tag IDs for Campaign

Return all messages that belong to the given campaign. *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`

Get Messages for Campaign

Returns the IDs of all messages associated with the given campaign. *Rate limits*: Burst: `10/s` Steady: `150/m`

**Scopes:**
`campaigns:read`

Get Message IDs for Campaign

Get all catalog items in an account.

Catalog items can be sorted by the following fields, in ascending and descending order:
`created`

Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.

Returns a maximum of 100 items per request. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:read`

Get Catalog Items

Create a new catalog item. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Create Catalog Item

Get a specific catalog item with the given item ID. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:read`

Get Catalog Item

Update a catalog item with the given item ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Update Catalog Item

Delete a catalog item with the given item ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Delete Catalog Item

Get all variants in an account.

Variants can be sorted by the following fields, in ascending and descending order:
`created`

Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.

Returns a maximum of 100 variants per request. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:read`

Get Catalog Variants

Create a new variant for a related catalog item. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Create Catalog Variant

Get a catalog item variant with the given variant ID. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:read`

Get Catalog Variant

Update a catalog item variant with the given variant ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Update Catalog Variant

Delete a catalog item variant with the given variant ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Delete Catalog Variant

Get all catalog categories in an account.

Catalog categories can be sorted by the following fields, in ascending and descending order:
`created`

Currently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.

Returns a maximum of 100 categories per request. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:read`

Get Catalog Categories

Create a new catalog category. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Create Catalog Category

Get a catalog category with the given category ID. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:read`

Get Catalog Category

Update a catalog category with the given category ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Update Catalog Category

Delete a catalog category using the given category ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Delete Catalog Category

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`

Get Bulk Create Catalog Items Jobs

Create a catalog item bulk create job to create a batch of catalog items.

Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.
The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Bulk Create Catalog Items

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`

Get Bulk Create Catalog Items Job

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`

Get Bulk Update Catalog Items Jobs

Create a catalog item bulk update job to update a batch of catalog items.

Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.
The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Bulk Update Catalog Items

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`

Get Bulk Update Catalog Items Job

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`

Get Bulk Delete Catalog Items Jobs

Create a catalog item bulk delete job to delete a batch of catalog items.

Accepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.
The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Bulk Delete Catalog Items

Get a catalog item bulk delete job with the given job ID. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:read`

Get Bulk Delete Catalog Items Job

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`

Get Bulk Create Variants Jobs

Create a catalog variant bulk create job to create a batch of catalog variants.

Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB.
The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Bulk Create Catalog Variants

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`

Get Bulk Create Variants Job

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`

Get Bulk Update Variants Jobs

Create a catalog variant bulk update job to update a batch of catalog variants.

Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB.
The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Bulk Update Catalog Variants

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`

Get Bulk Update Variants Job

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`

Get Bulk Delete Variants Jobs

Create a catalog variant bulk delete job to delete a batch of catalog variants.

Accepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB.
The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Bulk Delete Catalog Variants

Get a catalog variant bulk delete job with the given job ID. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:read`

Get Bulk Delete Variants Job

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`

Get Bulk Create Categories Jobs

Create a catalog category bulk create job to create a batch of catalog categories.

Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB.
The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Bulk Create Catalog Categories

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`

Get Bulk Create Categories Job

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`

Get Bulk Update Categories Jobs

Create a catalog category bulk update job to update a batch of catalog categories.

Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB.
The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Bulk Update Catalog Categories

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`

Get Bulk Update Categories Job

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`

Get Bulk Delete Categories Jobs

Create a catalog category bulk delete job to delete a batch of catalog categories.

Accepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB.
The maximum number of jobs in progress at one time is 500. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Bulk Delete Catalog Categories

Get a catalog category bulk delete job with the given job ID. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:read`

Get Bulk Delete Categories Job

Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details.

This endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription). *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:write`
`profiles:write`

Create Back In Stock Subscription

Get all items in a category with the given category ID.

Items can be sorted by the following fields, in ascending and descending order:
`created`

Returns a maximum of 100 items per request. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:read`

Get Items for Catalog Category

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`

Get Item IDs for Catalog Category

Create a new item relationship for the given category ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Add Items to Catalog Category

Update item relationships for the given category ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Update Items for Catalog Category

Delete item relationships for the given category ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Remove Items from Catalog Category

Get all variants related to the given item ID.

Variants can be sorted by the following fields, in ascending and descending order:
`created`

Returns a maximum of 100 variants per request. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:read`

Get Variants for Catalog Item

Get Variant IDs for Catalog Item

Get all catalog categories that an item with the given item ID is in.

Catalog categories can be sorted by the following fields, in ascending and descending order:
`created`

Returns a maximum of 100 categories per request. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`catalogs:read`

Get Categories for Catalog Item

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`

Get Category IDs for Catalog Item

Create a new catalog category relationship for the given item ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Add Categories to Catalog Item

Update catalog category relationships for the given item ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Update Categories for Catalog Item

Delete catalog category relationships for the given item ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`catalogs:write`

Remove Categories from Catalog Item

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`

Get Coupons

Creates a new coupon. *Rate limits*: Burst: `3/s` Steady: `60/m`

**Scopes:**
`coupons:write`

Create Coupon

Get a specific coupon with the given coupon ID. *Rate limits*: Burst: `75/s` Steady: `700/m`

**Scopes:**
`coupons:read`

Get Coupon

*Rate limits*: Burst: `3/s` Steady: `60/m`

**Scopes:**
`coupons:write`

Update Coupon

Delete the coupon with the given coupon ID. *Rate limits*: Burst: `3/s` Steady: `60/m`

**Scopes:**
`coupons:write`

Delete Coupon

Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles.

A coupon/coupons or a profile/profiles must be provided as required filter params. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`coupon-codes:read`

Get Coupon Codes

Synchronously creates a coupon code for the given coupon. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`coupon-codes:write`

Create Coupon Code

Returns a Coupon Code specified by the given identifier. *Rate limits*: Burst: `350/s` Steady: `3500/m`

**Scopes:**
`coupon-codes:read`

Get 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`

Update 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 API Integration Profile

Build every single integration your customers need with AI