API referenceAccount
Set the default recipient
PUT
Set the recipient new aliases forward to when recipient_ids is
omitted at creation.
The recipient must belong to the caller; a foreign id is a 404, not a 403, so ids cannot be probed across tenants.
CognitoUserPoolheader
AuthorizationBearer <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
recipient_id*stringRecipient to use as the default destination for new aliases.
Default recipient updated.
application/json- response
message*stringcurl -X PUT "https://example.com/account/default-recipient" \ -H "Content-Type: application/json" \ -d '{ "recipient_id": "string" }'{ "message": "default recipient updated"}