Change email
POST
/v1/me/change-email
Start changing the signed-in user's login email. Re-enter the current password to confirm and give the new address. Your email does NOT change yet: we send a confirmation link to the new address (it becomes your login only once you click it) and an alert to your current address so you can cancel if it wasn't you. A wrong password is 403; an address that's already the one on your account or isn't a valid email is 400; one already registered elsewhere is 409. Requires an interactive login: this identity change can't be performed with an API key (403 interactive_auth_required).
Authorizations
Bearer
JWT bearer token from POST /v1/auth/login.
Type
HTTP (bearer)
or
ApiKey
Scoped API key for non-interactive clients (issued by PBI #1426).
Type
API Key (header: X-Api-Key)
Request Body
application/json
Email-change initiation payload (POST /me/change-email, #2125) — the new address + the current password.
The address to move the account's login email to (validated + normalized server-side).
The account's current password, re-entered to authorize the change.
Responses
Accepted
application/json
Email-change initiation result (POST /me/change-email, #2125) — the change is pending, not yet applied.
A short human-readable next-step for the caller to surface.
true — a confirmation link was sent to the new address; the login email is unchanged until it's confirmed.