Modify Email Address

View as Markdown
### Change the authenticated user's email address. **Available to:** All authenticated users **Environments:** Live **[Rate Limit](/api/authentication#request-rate-limits-and-time-penalties):** 1 request per hour, 15-second back-off, counts all requests Changes the email address for the calling user. The request takes the new `email` (up to 64 characters); omit `userId` to change your own address. For a standard user changing their own email, the new address is not applied immediately — the server sends a confirmation message to the new address, and the change takes effect after the user confirms it. When an organization administrator changes the email of a member of their organization, the new address is applied directly without a confirmation step. The response returns the user's `email` and `status`. A non-empty `errorText` indicates the change request failed. **Common Failure Scenarios** - The `email` is missing or exceeds the 64-character limit. - A non-administrator sets `userId` to a user other than themselves. **Error Messages** | `errorText` | Trigger | |-------------|---------| | Non-empty `errorText` | The request failed; the field describes the reason. |

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
emailstringRequired<=64 characters
userIdlongOptional

Response

UserStatusMessage
errorTextstring<=8192 characters

Non-empty if the request failed

statusenum
Active, Closed, Initiated, TemporaryLocked, UnconfirmedEmail