HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Create Client Back In Stock Subscription

Subscribe a profile to receive back in stock notifications. Check out our Back in Stock API guide for more details.

This endpoint is specifically designed to be called from publicly-browseable, client-side environments only. To create subscriptions from server-based applications, please use POST /api/back-in-stock-subscriptions.

Rate limits:
Burst: 350/s
Steady: 3500/m

Scopes:
catalogs:write
profiles:write

Query Params
string
required
Defaults to PUBLIC_API_KEY

Your Public API Key / Site ID. See this article for more details.

Body Params
object
required
string
required
object
required
array of strings
required
Defaults to EMAIL,SMS

The channel(s) through which the profile would like to receive the back in stock notification. This can be leveraged within a back in stock flow to notify the subscriber through their preferred channel(s).

channels*
object
required
object
required
string
required
string
Defaults to 01GDDKASAP8TKDDA2GRZDSVP4H

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

object
required
string
Defaults to sarah.mason@klaviyo-demo.com

Individual's email address

string
Defaults to +15005550006

Individual's phone number in E.164 format

string
Defaults to 63f64a2b-c6bf-40c7-b81f-bed08162edbe

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.

string
object
required
object
required
object
required
string
required
string
required
Defaults to $custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM

The catalog variant ID for which the profile is subscribing to back in stock notifications. This ID is made up of the integration type, catalog ID, and and the external ID of the variant like so: integrationType:::catalogId:::externalId. If the integration you are using is not set up for multi-catalog storage, the 'catalogId' will be $default. For Shopify $shopify:::$default:::33001893429341

Headers
string
required
Defaults to 2024-02-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses
202

Success

Language