anon_email
API referenceAlias recipients

Attach one recipient to an alias

POST
/aliases/{alias_id}/recipients

Add a single recipient to an alias without touching the rest of the list. Attaching a recipient that is already attached is a conflict.

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.

Request Body

application/json
  1. body
recipient_id*string

Recipient to add. Must not already be attached.

Response Body

The updated alias.

application/json
  1. response
alias_id*string

Opaque id, stable for the life of the alias.

alias_email*string

The full forwarding address.

Formatemail
description*string

Free-form label. Empty when never set.

active*boolean

Whether the alias currently accepts mail.

destination_emails*array<>

Addresses this alias forwards to.

emails_sent*integer

Messages accepted for forwarding, as reported by SES.

emails_delivered*integer
emails_bounced*integer
emails_complaint*integer
emails_replied*integer
emails_blocked*integer
datetime_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*integer

Creation time, unix epoch milliseconds.

datetime_updated*integer

Last 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/string/recipients" \  -H "Content-Type: application/json" \  -d '{    "recipient_id": "string"  }'
{  "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}

Delete an alias DELETE

Previous Page

Replace the recipients of an alias PUT

Next Page