Skip to navigation

Create Evaluation Users

View as Markdown

Batch create up to 100 organization users at once.

Available to: Organization administrators

Environments: Live

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

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

This endpoint can help reduce your application’s API usage footprint. It batches the functionality of several calls at once for each EvaluationUser configuration object:

  • Provide a tradovateSubscriptionPlanId integer value matching one of your organization-specific Tradovate Subscription plans to assign that membership to the created user without invoking an additional call.
  • Provide an entitlementIds integer array to pre-assign entitlement subscriptions with matching IDs to the user. One common use case is assigning your organization’s TradingView entitlement.
Do not include entitlement ID 22 (GroupTrade) in entitlementIds. Requests that pass entitlement ID 22 fail, and no users are 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.

Use this endpoint when creating new users to minimize API traffic.

Users are created individually. When a single user fails to create, that user’s entry in the results array contains an errorText describing the failure, and the remaining users are still created; each successful entry includes the new user’s userId.

Common Failure Scenarios

  • The users array is empty or contains more than 100 entries.
  • A tradovateSubscriptionPlanId or entitlementIds value doesn’t match a plan or entitlement available to your organization. This fails the entire request; no users are created.
  • A user’s combined firstName and lastName exceeds 60 characters.
  • Your organization is not currently allowed to add new users.

Error Messages

Access failures reject the whole request and are returned as an HTTP 401 response with the message text as the response body:

errorTextTrigger
"Users cannot be added for this organization"New-user creation is disabled for your organization.

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

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
userslist of objectsRequired

Response

CreateEvaluationUsersResponse
resultslist of objects
errorTextstringOptional<=8192 characters

Non-empty if the request failed