Subscribe a profile to back-in-stock alerts
https://email.growthdept.ai/api/back-in-stock-subscriptionsFinds or creates the profile by email, phone number, external id or id and subscribes it to the variant on the channels given. A repeat request for the same variant adds channels to the active subscription.
The request body can be up to 5 MB.
Rate limits
Scopes
catalogs:writeprofiles:write
Operation id
create_back_in_stock_subscription The same operation as in Klaviyo's API. OpenAPI document
Body
Send application/vnd.api+json or application/json.
object
dataobjectrequired
data: 3 fields
typestringrequired
back-in-stock-subscriptionattributesobjectrequired
attributes: 2 fields
channelsarray of stringsrequired
profileobject
profile: 1 field
dataobjectrequired
data: 3 fields
typestringrequired
profileidstring
attributesobjectrequired
attributes: 3 fields
emailstringcan be null
phone_numberstringcan be null
external_idstringcan be null
relationshipsobjectrequired
relationships: 1 field
variantobjectrequired
variant: 1 field
dataobjectrequired
data: 2 fields
typestringrequired
catalog-variantidstringrequired
Edit the example. The code samples use what you type here.
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
202Success
No body.
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject