Quickstart

Copy your API key, make your first request, and add your first sign-up.

1. Copy your key

   In Notifylyst, open Settings → API key. The first time you open it, a key is created and shown once — copy it now. It starts with nl_live_.

   Lost it? Press Regenerate key. The new key replaces the old one, which stops working straight away.

2. Check the key

   curl "https://cb-notifylyst.cblyst.com/api/v1/me" \
     -H "X-API-Key: nl_live_YOUR_KEY"
   

   {
     "shop": "your-store.myshopify.com",
     "api_version": "v1",
     "time_zone": "Asia/Kolkata",
     "plan": "Growth",
     "channels": { "email": true, "sms": false, "webpush": true },
     "rate_limit_per_minute": 20
   }
   

   A 401 means the key is wrong or revoked; a 403 means your plan does not include REST API.

3. Add a sign-up

   Use a variant id from your Shopify admin (the number at the end of the variant’s URL).

   curl -X POST "https://cb-notifylyst.cblyst.com/api/v1/subscribers" \
     -H "X-API-Key: nl_live_YOUR_KEY" \
     -H "Content-Type: application/json" \
     -d '{ "email": "[e-mail]", "variant_id": "44012345678901" }'
   

   You get 201 and the new sign-up. It now waits for that variant’s restock like any sign-up from your storefront. Nothing is sent when you add it.

4. List what is waiting

   curl "https://cb-notifylyst.cblyst.com/api/v1/subscribers?status=waiting&limit=10" \
     -H "X-API-Key: nl_live_YOUR_KEY"
   

​

Next

• Moving a list from another app? Use bulk sign-ups.
• Want to react to new sign-ups? Set up webhooks.