Create Client Back In Stock Subscription

POST {{baseUrl}}/client/back-in-stock-subscriptions/?company_id={{companyId}}

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 and requires a public API key (site ID). Never use a private API key with our client-side endpoints.

To create back in stock subscriptions from server-side applications, please use POST /api/back-in-stock-subscriptions.

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

Scopes: catalogs:write profiles:write

Request Params

Request Body

{"data"=>{"type"=>"back-in-stock-subscription", "attributes"=>{"channels"=>["EMAIL", "PUSH"], "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