Update user's primary email address

Update this user's primary email address in your community

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint will update the current email address users have associated with your community. By default, new email addresses are added to the user's account, but not verified, so the user will receive an email requesting that they verify the address (or otherwise "approve" the change). Upon verification, the user may choose to use the new email address as the primary for your community or keep their previous one as primary.

API callers also have the ability to set require_verification to false. In this event, the current email address for your community will be updated for the user and the user will not be sent a verification email. Further, the user's former email address will stay on their account. As this creates an opaque shift in how users will receive email notifications from your community (you have the power to do it without them knowing), this option should be used with caution.

Path Params
int32
required
Body Params
string
required

The new email address you want to use

boolean
Defaults to true

Must users verify the new email address prior to receiving emails from your community

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain