Account

Update account

Update your account information.

  • User Account (API Token): Update user profile fields.
  • Alias Account (Alias Credentials): Update alias-scoped settings using the nested settings object. Legacy flat fields are accepted for compatibility. The response matches GET /v1/account.
put/v1/account

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/account
  • Auth: one of:
    • HTTP basic
    • HTTP basic

Request body

display_namestring

Display name

localestring

Locale preference

emailstring email

Current email address (user authentication only). The login email cannot be changed through the API; sending a different value returns a 400 error. Change it under My Account > Profile instead.

avatar_urlstring uri

Avatar URL (user authentication only)

Response

Account updated successfully

OR

Example response

{
  "sessions": [],
  "has_newsletter": true,
  "plan": "free",
  "email": "test1@test1.com",
  "max_quota_per_alias": 10737418240,
  "full_email": "test1@test1.com",
  "display_name": "test1@test1.com",
  "otp_enabled": false,
  "last_locale": "en",
  "address_country": "None",
  "id": "683fb2e81cc5d449a0d4cd9d",
  "object": "user",
  "locale": "en",
  "created_at": "2025-06-04T02:43:52.646Z",
  "updated_at": "2025-06-04T02:43:55.350Z",
  "address_html": "",
  "api_token": "15ac16ae21784aa2cb4d5508"
}

Changes

No recorded changes to this operation across all 1 revision of this API.