Verify a newsletter subscription - Spree Commerce documentation

POST

api

store

newsletter_subscribers

verify

Spree SDK

import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const subscriber = await client.newsletterSubscribers.verify({
  token: 'abc123def456',
})

{
  "id": "sub_UkLWZg9DAJ",
  "email": "pending@example.com",
  "created_at": "2026-06-16T10:27:36.816Z",
  "updated_at": "2026-06-16T10:27:36.824Z",
  "verified": true,
  "verified_at": "2026-06-16T10:27:36Z",
  "customer_id": null
}

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Headers

x-spree-api-key

string

required

Body

application/json

token

string

required

Verification token from the confirmation email

Example:

"abc123def456"

Response

subscription verified

string

required

string

required

created_at

string

required

updated_at

string

required

verified

boolean

required

verified_at

string | null

required

customer_id

string | null

required

Subscribe to the newsletter

List store policies

⌘I

Spree SDK

import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const subscriber = await client.newsletterSubscribers.verify({
  token: 'abc123def456',
})

{
  "id": "sub_UkLWZg9DAJ",
  "email": "pending@example.com",
  "created_at": "2026-06-16T10:27:36.816Z",
  "updated_at": "2026-06-16T10:27:36.824Z",
  "verified": true,
  "verified_at": "2026-06-16T10:27:36Z",
  "customer_id": null
}