account

Subscribe an email address to the newsletter

No authentication. Uses an unauthenticated PocketBase client (POCKETBASE_URL); no superuser client is involved.

  • email is only checked for presence: it is not trimmed, lowercased or format-validated and is used verbatim.
  • An existing users record with this email (or a PocketBase validation_not_unique error on email) answers 200 with isExisting: true.
  • Otherwise a users record is created via POST <POCKETBASE_URL>/api/collections/users/records with a random server-side password, name derived from the email local part, emailVisibility: false, newsletter_source (= source, default landing_page) and newsletter_subscribed_at. The PocketBase verification email is then requested; a failure there is ignored. The answer is 200 with needsVerification: true.
  • Any other PocketBase failure answers 500 Failed to subscribe; a non-JSON or null body answers 500 Internal server error.
post/api/newsletter/subscribe

Request

  • Base URL: https://voltplan.app
  • URL: https://voltplan.app/api/newsletter/subscribe
  • Auth: none required

Request body

emailstring required

Only checked for presence; not trimmed, lowercased or format-validated.

sourcestring

Sign-up origin stored as newsletter_source.

Response

Account created (verification pending) or already subscribed.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.