Update an alias
Partial update of an alias's description or active state. At least one field is required.
Deactivating an alias stops it accepting mail without deleting the address.
CognitoUserPoolAuthorizationBearer <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.
alias_id*stringOpaque alias id (not the email address).
application/json- body
1 <= propertiesdescription?stringNew label. Whitespace is trimmed.
active?booleanSet false to stop the alias accepting mail.
The updated alias.
application/json- response
alias_id*stringOpaque id, stable for the life of the alias.
alias_email*stringThe full forwarding address.
emaildescription*stringFree-form label. Empty when never set.
active*booleanWhether the alias currently accepts mail.
destination_emails*array<>Addresses this alias forwards to.
emails_sent*integerMessages accepted for forwarding, as reported by SES.
emails_delivered*integeremails_bounced*integeremails_complaint*integeremails_replied*integeremails_blocked*integerdatetime_last_sent*|Unix epoch milliseconds, or null when the event has not occurred.
datetime_last_delivered*|Unix epoch milliseconds, or null when the event has not occurred.
datetime_last_bounced*|Unix epoch milliseconds, or null when the event has not occurred.
datetime_last_complaint*|Unix epoch milliseconds, or null when the event has not occurred.
datetime_last_blocked*|Unix epoch milliseconds, or null when the event has not occurred.
datetime_last_replied*|Unix epoch milliseconds, or null when the event has not occurred.
datetime_created*integerCreation time, unix epoch milliseconds.
datetime_updated*integerLast modification time, unix epoch milliseconds.
datetime_deleted*|Unix epoch milliseconds, or null when the event has not occurred.
curl -X PATCH "https://example.com/aliases/string" \ -H "Content-Type: application/json" \ -d '{}'{ "alias_id": "string", "alias_email": "user@example.com", "description": "string", "active": true, "destination_emails": [ "user@example.com" ], "emails_sent": 0, "emails_delivered": 0, "emails_bounced": 0, "emails_complaint": 0, "emails_replied": 0, "emails_blocked": 0, "datetime_last_sent": 0, "datetime_last_delivered": 0, "datetime_last_bounced": 0, "datetime_last_complaint": 0, "datetime_last_blocked": 0, "datetime_last_replied": 0, "datetime_created": 0, "datetime_updated": 0, "datetime_deleted": 0}