Skip to main content
Use this endpoint to update a user’s email address within your project. The user is identified by their current email and updated with a new email address.
POST

Authorization

All you need is to include your secret key as a value of authorization in the header and hit the endpoint above.
string
required
Use the secret key that matches the mode you are in TEST or LIVE

Request Body

Provide both the current email address and the new email address for the user.
string
required
The current email address of the user you want to update
string
required
The new email address to assign to the user. Must be a valid email format and not already in use by another user in this project.
  • The new email must be different from the old email
  • The new email cannot already be in use by another user in the same project and mode
  • Users are scoped to both project and mode (TEST or LIVE)

Response

If the email is updated successfully, you will receive a confirmation with the update details.

Error Responses

Returned when either oldEmail or newEmail is missing.
Returned when the old email format is invalid.
Returned when the new email format is invalid.
Returned when the old and new email addresses are the same.
Returned when no user exists with the provided old email address.
Returned when the new email is already in use by another user.
Returned when an unexpected error occurs.