1. Docs
  2. API Reference
  3. Confirm an email-address change

Confirm an email-address change

POST/v1/auth/confirm-email-change

Completes an email change using the token from the confirmation link. No sign-in is needed, because the token itself proves the request. The pending address becomes the account's email immediately and is marked verified, the token is used up, and existing sessions stay signed in. Refuses an unknown or already used token with 400 (auth.invalid_verification_token), an expired one with 400 (auth.verification_token_expired), and with 409 (auth.email_change_in_use) when another user took the address after the request was made.

Request body

application/json

tokenstring Required

The confirmation token from the email link

Responses

application/json

  • dataMessageResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

MessageResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/v1/auth/confirm-email-change" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "string"
  }'
Response
{
  "data": {
    "message": "string"
  }
}
 Related endpoints
POSTRegister a new user
POSTCreate an additional Account for the authenticated admin (no new user)
GETReview the parked account-creation intent before resuming
POSTResume a deferred account creation parked at the register form
DELETEDismiss the parked account-creation intent without creating anything
POSTLook up invite details by token
POSTAccept an invite
POSTAuthenticate and receive tokens
POSTSelect an Account from a pre-auth session (multi-Account login)
POSTSwitch the active Application in an authenticated session
POSTRefresh access token
POSTLogout and revoke tokens
GETVerify email address
POSTResend verification email
POSTResend verification email by token
POSTRequest password reset
POSTReset password with token
POSTChange password (authenticated)
GETGet current user profile
GETGet current user avatar image
POSTUpload profile avatar
DELETERemove profile avatar
POSTRequest an email-address change
GETGet current user permissions
GETList the Accounts the current user belongs to
GETList active sessions
DELETERevoke all sessions
DELETERevoke a specific session
 Was this page helpful?

Tell us how we can improve this guide.

Canopy