anon_email
API referenceAliases

Delete an alias

DELETE
/aliases/{alias_id}

Permanently delete an alias and free its quota slot.

This is a hard delete: the address is immediately free for anyone to claim and cannot be restored. Mail already in flight to the address is dropped.

Authorization

CognitoUserPool
headerAuthorizationBearer <token>

Cognito user pool ID token. API Gateway validates the token (identity token: no OAuth scopes are configured on the authorizer) and forwards its claims; the sub claim is the tenant key.

Path Parameters

alias_id*string

Opaque alias id (not the email address).

Response Body

Alias deleted.

curl -X DELETE "https://example.com/aliases/string"
Empty