Users

Modify Email Address

Change the authenticated user's email address.

Available to: All authenticated users

Environments: Live

Rate Limit: 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

errorTextTrigger
Non-empty errorTextThe request failed; the field describes the reason.
post/user/modifyemailaddress

Request

  • Base URL: https://demo.tradovateapi.com/v1
  • URL: https://demo.tradovateapi.com/v1/user/modifyemailaddress
  • Auth: HTTP bearer

Request body

userIdinteger
emailstring required

Response

UserStatusMessage

errorTextstring

Non-empty if the request failed

status'Active' | 'Closed' | 'Initiated' | 'TemporaryLocked' | 'UnconfirmedEmail'

Active, Closed, Initiated, TemporaryLocked, UnconfirmedEmail

Changes

No recorded changes to this operation across all 1 revision of this API.