Skip to main content
POST
/
api
/
public
/
newsletter
/
subscribe
{
  "WasSuccessful": true
}

​
Subscribe to Newsletter

Registers an email address for the location’s newsletter. Can be called by authenticated customers or public visitors providing an email address.

​
Authentication

No authentication required for public subscription.

​
Request Body

​
Email
string
required
Email address to subscribe.

​
Response

​
WasSuccessful
boolean
required
true if the subscription was created or already existed.

​
Examples

​
Subscribe

POST /api/public/newsletter/subscribe
Content-Type: application/json

{
  "Email": "visitor@example.com"
}

{
  "WasSuccessful": true
}

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const result = await httpClient.post(endpoints.newsletter.subscribe().url, {
  Email: 'visitor@example.com',
})