Skip to main content
POST
Spree SDK

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Headers

x-spree-api-key
string
required
Authorization
string

Optional Bearer JWT — when present, links the subscription to that customer

Body

application/json
email
string<email>
required
Example:

"subscriber@example.com"

redirect_url
string<uri>

The storefront URL the verification token is appended to. Left out of the webhook payload unless it matches one of the store's allowed origins.

Example:

"https://your-store.com/newsletter/confirm"

Response

auto-verified when JWT matches subscribed email

id
string
required
email
string
required
created_at
string
required
updated_at
string
required
verified
boolean
required
verified_at
string | null
required
customer_id
string | null
required