Skip to navigation
REST API EndpointsUsers

Sign Up Organization Member

View as Markdown

Create a single user for your organization.

Available to: Organization administrators

Environments: Live

Rate Limit: 100 requests per hour, 1-second back-off, counts failed requests only

Note: The /user/createEvaluationUsers endpoint replaces /user/signUpOrganizationMember, /user/addTradovateSubscription, and /userPlugin/addEntitlementSubscription.

Requests with firstName and lastName fields exceeding a combined 60 characters are rejected, despite each field individually allowing up to 64 characters.

You can add Tradovate Subscriptions and entitlements (such as TradingView) directly from the signUpOrganizationMember operation. This can help save resources when signing up new organization members.

  • To provide a default Tradovate Subscription, include the tradovateSubscriptionPlanId field with the value of one of your organization’s pre-defined Tradovate Subscription plans.
  • To provide default entitlement subscriptions, include the entitlementIds field, an array of integer IDs matching the entitlement subscriptions you’d like to apply to the user.
Do not include entitlement ID 22 (GroupTrade) in entitlementIds. Requests that pass entitlement ID 22 fail, and no user is created. Entitlement ID 22 is deprecated: Group Trading is now standard for any user with two or more accounts in the same environment and no longer requires an entitlement.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequired3-64 characters
emailstringRequired<=64 characters
passwordstringRequired8-64 characters
firstNamestringRequired<=64 characters
lastNamestringRequired1-64 characters
tradovateSubscriptionPlanIdlongOptional
entitlementIdslist of longsOptional
originOrganizationstringOptional<=64 characters

Response

SignUpResponse
errorCodeenum
DataError, EmailAlreadyRegistered, EmailAndPasswordCompromised, EmailPolicyFailed, FailedRecaptcha, PasswordCompromised, Success, UnknownError, UserAlreadyExists, WeakPassword, WrongChallenge, WrongChallengeOrigin
emailVerifiedboolean
errorTextstringOptional<=8192 characters

Non-empty if the request failed

userIdlongOptional