Authorize or revoke user entitlements

Update your firm’s entitlement status for the requested user and entitlement package. L2 market data access may be created directly. L1 access can be updated only when the user already has L1 eligibility. Call PATCH /api/users/{user_id}/entitlements/ using the user_id value returned by GET /api/entitlements/user-entitlements/, and pass either the entitlement name or exchange codes plus level in the request body to identify which package should be changed. Use AUTHORIZED to grant access, REVOKED to remove access, or PENDING to restore a pending state for your firm. Revoking access for your firm may not change the entitlement status shown by later entitlement reads if the user remains eligible through another source.

PATCH /api/users/{user_id}/entitlements/

cURL

AuthorizeL2DataRequest

curl --request PATCH \
  --url https://api.example.com/api/users/{user_id}/entitlements/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entitlement": "CBOT",
  "level": "l2",
  "status": "AUTHORIZED"
}
'

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Path Parameters

user_id · integer · required

Trader user id whose entitlement records should be updated.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

entitlement · string

Human-readable entitlement name to update for this user.

exchange_codes · string[]

Exchange codes whose matching entitlements should be updated for this user. Use this instead of entitlement when changing multiple exchanges in one request.

level · enum<string>

Market data level for the entitlement being updated. L2 requests can create a new entitlement entry for your firm; L1 requests require existing eligibility for the requested entitlement.

• l1 - Level 1
• l2 - Level 2

Available options: l1, l2

status · enum<string>

New status to apply to your firm's entitlement for the selected user and entitlement. This does not change eligibility from other sources.

• PENDING - Pending Authorization
• AUTHORIZED - Authorized
• REVOKED - Revoked

Available options: PENDING, AUTHORIZED, REVOKED

Response

204

Your firm's targeted entitlement status was created or updated successfully.