POST
/api/mailing-lists/joinPublicStart a mailing list subscription (double opt-in)
Sends a confirmation email to the address; the subscription only becomes active once the emailed link is confirmed via POST /api/mailing-lists/confirm. The response does not reveal whether the address was already subscribed. Subject to the CORS origin allowlist for cross-origin browser calls.
operationId
joinMailingListMailing ListsAuthentication & permissionsPublic
Anyone — no credentials required
- Accepted credentials
- None required
Request body
Required
application/json
JoinMailingListRequestBodyStarts a double-opt-in subscription: a confirmation email is sent to the address before it is added to the list.
| Property | Type | Description |
|---|---|---|
| email* | string (email) | Email address to subscribe. |
| mailing_list_id* | string (uuid) | ID of the mailing list to join. |
JSONExample
"email""subscriber@example.com"
"mailing_list_id""b7d1f9c2-4a3e-4d24-9f6b-2f42f8f0a111"
Responses
application/json
SuccessMessageResponseSuccess envelope for operations with no response payload.
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string |
JSONExample
"success"true
"message""string"
Example request
bashcurl
curl -X POST 'https://mail.schemavaults.com/api/mailing-lists/join' \
-H 'Content-Type: application/json' \
-d '{
"email": "subscriber@example.com",
"mailing_list_id": "b7d1f9c2-4a3e-4d24-9f6b-2f42f8f0a111"
}'