Create a recipient
Register a forwarding destination and send it a confirmation email.
The recipient starts unverified; it cannot be attached to an alias until the link in that email is opened. Creating a recipient consumes one slot of the plan's recipient 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
email*stringThe inbox forwarded mail is delivered to.
emailname?stringFree-form label.
Recipient created (unverified).
application/json- response
recipient_id*stringOpaque id, stable for the life of the recipient.
email*stringemailname*stringFree-form label. Empty when never set.
active*booleanWhether this recipient currently receives forwarded mail.
verified*booleanSet once the confirmation link has been opened.
pgp_public_key*|Armored PGP public key, when one is registered.
pgp_fingerprint*|Fingerprint derived from the public key.
pgp_expires_at*|Key expiry, unix epoch milliseconds, when the key declares one.
require_encryption*booleanWhen true, mail to this recipient is encrypted to pgp_public_key
(and rejected if that fails). When false, mail is forwarded as-is.
datetime_created*integerCreation time, unix epoch milliseconds.
datetime_deleted*|Unix epoch milliseconds, or null when the event has not occurred.
curl -X POST "https://example.com/recipients" \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com" }'{ "recipient_id": "string", "email": "user@example.com", "name": "string", "active": true, "verified": true, "pgp_public_key": "string", "pgp_fingerprint": "string", "pgp_expires_at": 0, "require_encryption": true, "datetime_created": 0, "datetime_deleted": 0}