POST
Authorization
All you need is to include your secret key as a value of authorization in the header and hit the endpoint above. 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.The current email address of the user you want to update
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
400 Bad Request - Missing Fields
400 Bad Request - Missing Fields
Returned when either oldEmail or newEmail is missing.
400 Bad Request - Invalid Old Email
400 Bad Request - Invalid Old Email
Returned when the old email format is invalid.
400 Bad Request - Invalid New Email
400 Bad Request - Invalid New Email
Returned when the new email format is invalid.
400 Bad Request - Identical Emails
400 Bad Request - Identical Emails
Returned when the old and new email addresses are the same.
404 Not Found
404 Not Found
Returned when no user exists with the provided old email address.
409 Conflict
409 Conflict
Returned when the new email is already in use by another user.
500 Internal Server Error
500 Internal Server Error
Returned when an unexpected error occurs.