Sign in
Authentication (Allauth Headless)

Add/Change email address

Changed on

The following functionality is available:

  • Adding a new email address for an already signed in user (ACCOUNT_CHANGE_EMAIL = False).
  • Change to a new email address for an already signed in user (ACCOUNT_CHANGE_EMAIL = True).
  • Change to a new email address during the email verification process at signup (ACCOUNT_EMAIL_VERIFICATION_SUPPORTS_CHANGE = True).

In all cases, an email verification mail will be sent containing a link or code that needs to be verified.

post/api/v2/allauth/app/v1/account/email

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

client'app' | 'browser' required

The type of client accessing the API.

Headers

X-Session-Tokenstring

Session token. Only needed when client is equal to app.

Request body

emailstring required

The email address.

Example request

{
  "email": "email@domain.org"
}

Response

List of email addresses.

status200 required

Example response

{
  "data": [
    {
      "email": "email@domain.org",
      "primary": true
    }
  ]
}

Changes

  • v2b147245b3d11Revision changes
    • info

      added the required property ////// to the response with the status