Skip to main content
POST
Create a subscription

Headers

market-context-value
string

The market context value (e.g. 'IE')

Example:

"IE"

market-context-type
string

The market context type (e.g. 'country')

Example:

"country"

Body

application/json
contact
string
required

The contact information for the subscription (phone or email)

Example:

"customer@example.com"

productId
string
required

The Shopify product ID

Example:

"123456799"

variantId
string
required

The Shopify variant ID. Required — subscriptions are variant-level only.

Example:

"456789123"

type
enum<string>
required

The type of subscription

Available options:
back_in_stock
Example:

"back_in_stock"

channel
enum<string>
required

The channel for the subscription

Available options:
email,
sms
Example:

"email"

marketContextType
enum<string>

The market context type for the subscription

Available options:
country
Example:

"country"

marketContextValue
string

The market context value for the subscription (e.g. 'IE')

Example:

"IE"

Response

The subscription has been successfully created.

data
object
required

Response data