Create Back In Stock Subscription

POST {{baseUrl}}/api/back-in-stock-subscriptions/

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 server-side applications. To create subscriptions from client-side contexts, use POST /client/back-in-stock-subscriptions.

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

Scopes: catalogs:write profiles:write

Request Body

{"data"=>{"type"=>"back-in-stock-subscription", "attributes"=>{"channels"=>["EMAIL", "SMS"], "profile"=>{"data"=>{"type"=>"profile", "attributes"=>{"email"=>"<string>", "phone_number"=>"<string>", "external_id"=>"<string>", "anonymous_id"=>"<string>"}, "id"=>"<string>"}}}, "relationships"=>{"variant"=>{"data"=>{"type"=>"catalog-variant", "id"=>"<string>"}}}}}

HEADERS