Subscribe
Adds an email (optionally name, phone) to the store’s subscriber list.
Authorization
clientKey The store's API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
In: header
Header Parameters
Your store API key (Dashboard → Settings → API keys). pk_live_… public keys are for browser code and only work from an origin on the key's allowlist; sk_live_… private keys are for servers and native apps and need no Origin.
Your own correlation id (8–128 chars, ^[A-Za-z0-9_.:-]+$). Echoed back on the response and on every log line of the request; one is generated when you omit it.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/store/subscribe" \ -H "X-Client-Key: {{clientKey}}" \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected]", "name": "Adaeze Okafor", "phone": "+2348031234567" }'{ "status": "success", "message": "You're subscribed. Watch your inbox for updates."}