Skip to content

Newsletter signup

POST
/api/v1/business/website/subscribe/

Subscribe an email to the store newsletter. Idempotent — an already subscribed email returns the same success response, and a previously unsubscribed email is re-activated.

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)

Request Body

application/json
JSON
{
  
"email": "string"
}

Responses

Subscribed.

application/json
JSON
"string"

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

© Periscale