Create an alias
Create an alias that forwards to the given recipients, or to the
account's default recipient when recipient_ids is omitted.
local_partis generated from random words when omitted.- The address is
<local_part>@<domain>, where<domain>is the first entry ofGET /domain-options. - Every recipient must be verified and active, and count against the plan's recipient quota (recipients are shared, not per alias).
- Creating an alias consumes one slot of the plan's alias quota.
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.
application/json- body
local_part?stringLocal part of the address: 2–64 characters of a-z, 0-9,
hyphen, or underscore, starting alphanumeric. Generated from
random words when omitted.
^[a-z0-9][a-z0-9_-]{1,63}$description?stringFree-form label.
recipient_ids?array<string>Recipients to forward to. Every id must be a verified, active recipient owned by the caller. When omitted or empty, the account's default recipient is used.
Alias created.
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 POST "https://example.com/aliases" \ -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}