Revoke Trading Permission
Revoke a single trading permission.
Available to: Traders (to revoke permissions given to someone else); traders (to revoke permissions given to them); organization administrators (any account in their organization)
Environments: Demo, Live
Rate Limit: No endpoint-specific limit
A trading permission lets another party, such as a vendor, trade using an account. Revoke one permission by passing its tradingPermissionId. The response returns the updated TradingPermission with its status set to Revoked, or to Declined when the caller is the user the permission was granted to.
Revoking is final for that permission. Calling the endpoint again for a permission that’s already revoked or declined returns a Duplicate request error, along with the unchanged permission, rather than changing anything.
revokeTradingPermission returns an HTTP 200 even when the ID doesn’t match a permission, so check the response body rather than the status code. A successful revoke returns the tradingPermission object; a failure returns an errorText.
Error Messages
Related Endpoints
- To revoke several permissions in one request, use
revokeTradingPermissions.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed