anon_email
API referenceAccount

Update the account profile

PATCH
/account

Partial update of the sender display name or the default alias format. At least one field is required.

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.

Request Body

application/json
  1. body
Properties1 <= properties
from_name?string

Display name used on forwarded mail.

default_alias_format?AliasFormat

How a generated alias local part is produced: random English words joined with separators, or a UUID.

Value in"random_words""uuid"

Response Body

The updated profile.

application/json
  1. response
user_sub*string

The caller's Cognito subject id.

from_name*string

Display name used on forwarded mail. Empty when never set.

default_alias_format*AliasFormat

How a generated alias local part is produced: random English words joined with separators, or a UUID.

Value in"random_words""uuid"
default_recipient_id*string

Recipient new aliases forward to by default. Empty when unset.

alias_count*integer

Aliases currently held, against the plan's limit.

recipient_count*integer

Recipients currently held, against the plan's limit.

datetime_created*integer

Account creation time, unix epoch milliseconds.

curl -X PATCH "https://example.com/account" \  -H "Content-Type: application/json" \  -d '{}'
{  "user_sub": "string",  "from_name": "string",  "default_alias_format": "random_words",  "default_recipient_id": "string",  "alias_count": 0,  "recipient_count": 0,  "datetime_created": 0}