POST
/api/mailing-listsAdminCreate a mailing list
operationId
createMailingListMailing ListsAuthentication & permissionsAdmin
Platform administrators only
- Accepted credentials
- Access token (Bearer)
Authorization: Bearer <JWT> - Access token (cookie)
cookie "access_token_schemavaults-mail"
- Access token (Bearer)
- Who may call
- Platform administrators only
Request body
Required
application/json
CreateMailingListRequestBody
| Property | Type | Description |
|---|---|---|
| name* | string | minLength: 3maxLength: 64 |
| description* | string | minLength: 3maxLength: 256 |
| public* | boolean | Whether the list is shown in the public mailing list directory. |
JSONExample
"name""Product updates"
"description""Occasional announcements about new features."
"public"true
Responses
application/json
CreateMailingListSuccessResponse
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string | |
| resource_id* | string (uuid) | ID of the newly created mailing list. |
JSONExample
"success"true
"message""string"
"resource_id""123e4567-e89b-12d3-a456-426614174000"
Example request
bashcurl
curl -X POST 'https://mail.schemavaults.com/api/mailing-lists' \
-H 'Authorization: Bearer <access_token>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Product updates",
"description": "Occasional announcements about new features.",
"public": true
}'