Subscribers

Let a storefront capture newsletter subscribers and process unsubscribe requests. Submissions are attributed to the project.

Feature requirement: the project must have the newsletter feature enabled, or these endpoints return 404.

POST/api/v1/storefront/projects/{project_slug}/subscribe

Public Subscribe

Parameters
Name	Type	In	Description
project_slug	string	path	Required.

Request body · SubscriberSubscribeCreate
Field	Type		Description
email	string<email>	required	—
name	string (nullable)	optional	—
source	string (nullable)	optional	—

Response 201 · SubscriberSubscribeRead
Field	Type		Description
id	string	required	—
project_id	string	required	—
email	string<email>	required	—
name	string (nullable)	optional	—
status	SubscriberStatus	required	Newsletter subscriber lifecycle.
source	string (nullable)	optional	—
subscribed_at	string<date-time> (nullable)	optional	—
unsubscribed_at	string<date-time> (nullable)	optional	—
created_at	string<date-time>	required	—
updated_at	string<date-time>	required	—
unsubscribe_token	string (nullable)	optional	—

Example request

curl -X POST "https://api.webtools.ng/api/v1/storefront/projects/your-project/subscribe" \
  -H "X-Project-Key: wt_pk_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "email": "…" }'

POST/api/v1/storefront/projects/unsubscribe

Public Unsubscribe

Request body · SubscriberUnsubscribeRequest
Field	Type		Description
token	string	required	—

Response 200 · UnsubscribeMessage
Field	Type		Description
message	string	required	—
subscriber_id	string (nullable)	optional	—

Example request

curl -X POST "https://api.webtools.ng/api/v1/storefront/projects/unsubscribe" \
  -H "X-Project-Key: wt_pk_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "token": "…" }'

← All resource groups