Skip to main content
POST
/
v1
/
public
/
newsletter
/
subscribe
Subscribe to newsletter
curl --request POST \
  --url https://{operatorDomain}/v1/public/newsletter/subscribe \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "consent": true,
  "locale": "<string>"
}
'
{
  "ok": true,
  "status": "pending_double_opt_in"
}

Body

application/json
email
string<email>
required
locale
string | null

Response

200 - application/json

Subscription acknowledgement

ok
boolean
status
string
Example:

"pending_double_opt_in"