Update a recipient
Partial update of a recipient's name, active state, encryption requirement, or PGP public key. At least one field is required.
- Setting
pgp_public_keyre-derives the fingerprint and expiry. nameandpgp_public_keymust not be empty when present.- Deactivating a recipient stops it receiving forwarded mail without deleting the address or detaching it from aliases.
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.
recipient_id*stringOpaque recipient id.
application/json- body
1 <= propertiesname?stringNew label. Must not be empty.
1 <= lengthactive?booleanSet false to stop this recipient receiving forwarded mail.
require_encryption?booleanRequire encryption to this recipient's PGP key.
pgp_public_key?stringArmored PGP public key. Must not be empty. Replaces any existing key and re-derives the fingerprint and expiry.
1 <= lengthThe updated recipient.
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 PATCH "https://example.com/recipients/string" \ -H "Content-Type: application/json" \ -d '{}'{ "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}