anon_email
API referenceRecipients

Delete a recipient

DELETE
/recipients/{recipient_id}

Permanently delete a recipient and free its quota slot.

Deleting a recipient that is still attached to one or more aliases is refused: detach it everywhere first, or delete those aliases.

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

recipient_id*string

Opaque recipient id.

Response Body

Recipient deleted.

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

Update a recipient PATCH

Previous Page

Resend a recipient verification email POST

Next Page