Subscribe to Newsletter

Subscribes the current user or email address to the location newsletter.

POST /api/public/newsletter/subscribe

Subscribe to Newsletter

cURL

curl --request POST \
  --url https://spaces.nexudus.com/api/public/newsletter/subscribe \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Email": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/public/newsletter/subscribe"

payload = { "Email": "<string>" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Email: '<string>'})
};

fetch('https://spaces.nexudus.com/api/public/newsletter/subscribe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "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": "[e-mail]"
}

{
  "WasSuccessful": true
}

TypeScript Integration

import endpoints from '@/api/endpoints'

const result = await httpClient.post(endpoints.newsletter.subscribe().url, {
  Email: '[e-mail]',
})