POST
/api/mailing-lists/confirmPublicConfirm a pending mailing list subscription
Completes the double opt-in started by POST /api/mailing-lists/join, using the token from the confirmation email. Confirming an already-confirmed subscription succeeds idempotently.
operationId
confirmSubscriptionMailing ListsAuthentication & permissionsPublic
Anyone — no credentials required
- Accepted credentials
- None required
Request body
Required
application/json
ConfirmSubscriptionRequestBody
| Property | Type | Description |
|---|---|---|
| token* | string | 43-character URL-safe base64 confirmation token from the confirmation email link. minLength: 43maxLength: 43 |
| email* | string (email) | Email address the confirmation was sent to. |
JSONExample
"token""string"
"email""subscriber@example.com"
Responses
application/json
ConfirmSubscriptionSuccessResponse
| Property | Type | Description |
|---|---|---|
| success* | true | |
| mailing_list_id* | string (uuid) | |
| email* | string (email) |
JSONExample
"success"true
"mailing_list_id""123e4567-e89b-12d3-a456-426614174000"
"email""user@example.com"
Example request
bashcurl
curl -X POST 'https://mail.schemavaults.com/api/mailing-lists/confirm' \
-H 'Content-Type: application/json' \
-d '{
"token": "string",
"email": "subscriber@example.com"
}'