POST
/api/admin/api-keys/{api_key_id}/recipientsAdminAdd a recipient to an API key's audience recipient allowlist
Individual-recipient entries and mailing-list entries form ONE combined audience allowlist for the key (unless the key's allow_any_audience flag is set).
operationId
addApiKeyRecipientAdmin: API KeysAuthentication & 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
Path parameters
| Name | Type | Description |
|---|---|---|
| api_key_id* | string (uuid) | ID of the API key. |
Request body
Required
application/json
ApiKeyRecipientMutationBody
| Property | Type | Description |
|---|---|---|
| email* | string (email) | Individual recipient address to add to / remove from the key's audience. |
JSONExample
"email""customer@example.com"
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/admin/api-keys/<api_key_id>/recipients' \
-H 'Authorization: Bearer <access_token>' \
-H 'Content-Type: application/json' \
-d '{
"email": "customer@example.com"
}'