Newsletter

Request newsletter confirmation

Requests double opt-in confirmation for the submitted email and optional profile. The endpoint accepts anonymous requests. An optional Cognito JWT or Aura Historia access-token bearer credential may be supplied; an invalid supplied credential returns 401. For an authenticated user, omitted profile values can fall back to that user's stored profile, but the credential never proves ownership of the submitted mailbox and never skips confirmation, including when the submitted address exactly matches the caller's account email.

The body is limited to 8 KiB. Every result is Cache-Control: no-store. Empty 204 means the request was handled, including when rate suppression applies. It does not reveal account or pending-challenge state, confirm a subscription, or mean that email was delivered or Loops was called. Loops synchronization occurs asynchronously after confirmation.

put/api/v1/newsletter-subscriptions

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/newsletter-subscriptions
  • Auth: one of:
    • HTTP bearer
    • none

Request body

emailstring email required

Email address to subscribe to the newsletter

firstNamestring nullable

Optional first name to sync with the subscription

lastNamestring nullable

Optional last name to sync with the subscription

language'de' | 'en' | 'fr' | 'es' | 'it' | 'zh' | 'pt' | 'pl' | 'tr' | 'nl' | 'cs' | 'ja' | 'ru' | 'ar'

Supported language codes (ISO 639-1 canonical values):

  • de: German (includes de-DE, de-AT, de-CH, de-LU, de-LI)
  • en: English (includes en-US, en-GB, en-AU, en-CA, en-NZ, and backend-specific accepted alias en_IE)
  • fr: French (includes fr-FR, fr-CA, fr-BE, fr-CH, fr-LU)
  • es: Spanish (includes es-ES, es-MX, es-AR, es-CO, es-CL, es-PE, es-VE)
  • it: Italian (includes it-IT, it-CH)
  • zh: Chinese (Simplified) (includes zh-CN, zh-Hans)
  • pt: Portuguese (includes pt-PT, pt-BR)
  • pl: Polish (includes pl-PL)
  • tr: Turkish (includes tr-TR)
  • nl: Dutch (includes nl-NL, nl-BE)
  • cs: Czech (includes cs-CZ)
  • ja: Japanese (includes ja-JP)
  • ru: Russian (includes ru-RU)
  • ar: Arabic (includes ar-SA, ar-EG, ar-AE)

de, en, fr, es, and it are fully supported localization/translation-target languages. zh, pt, pl, tr, nl, cs, ja, ru, and ar are ingestion-only languages: they can appear in stored/native content and are accepted anywhere LanguageData is used, but backend-generated translations and fallback localized strings are not produced in these languages.

currency'EUR' | 'GBP' | 'USD' | 'AUD' | 'CAD' | 'NZD' | 'CNY' | 'BRL' | 'PLN' | 'TRY' | 'JPY' | 'CZK' | 'RUB' | 'AED' | 'SAR' | 'HKD' | 'SGD' | 'CHF' | 'ZAR' | 'SEK' | 'DKK' | 'NOK' | 'KRW' | 'INR' | 'TWD' | 'HUF' | 'RON' | 'MXN' | 'THB'

Supported currencies (ISO 4217 codes):

  • EUR: Euro
  • GBP: British Pound
  • USD: US Dollar
  • AUD: Australian Dollar
  • CAD: Canadian Dollar
  • NZD: New Zealand Dollar
  • CNY: Chinese Yuan
  • BRL: Brazilian Real
  • PLN: Polish Złoty
  • TRY: Turkish Lira
  • JPY: Japanese Yen
  • CZK: Czech Koruna
  • RUB: Russian Ruble
  • AED: UAE Dirham
  • SAR: Saudi Riyal
  • HKD: Hong Kong Dollar
  • SGD: Singapore Dollar
  • CHF: Swiss Franc
  • ZAR: South African Rand
  • SEK: Swedish Krona
  • DKK: Danish Krone
  • NOK: Norwegian Krone
  • KRW: South Korean Won
  • INR: Indian Rupee
  • TWD: New Taiwan Dollar
  • HUF: Hungarian Forint
  • RON: Romanian Leu
  • MXN: Mexican Peso
  • THB: Thai Baht

Example request

{
  "email": "collector@example.com",
  "firstName": "Ada",
  "lastName": "Lovelace",
  "language": "de",
  "currency": "EUR"
}

Response

Confirmation request handled. The requested mailbox may be pending, already confirmed, or rate suppressed.

Changes