internal

Request email change

Changed on
post/api/auth/request-email-change

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/auth/request-email-change
  • Auth
    none declared

Request body

current_passwordstring password nullable

Current password — required if the user already has a password set. Not required for OIDC-only users.

new_emailstring email required

Address to move the account to. A confirmation link is sent there.

Response

Verification email sent to the new address, or the change applied at once when the server has no email transport

dataTupleUnit

No payload. Present only so the envelope keeps its shape.

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

    • info

      api tag auth removed

    • breaking

      the request property format changed from no format to password

    • breaking

      the //// response's property type changed from no type to object for status

    • info

      the request optional property became write-only