Create a trader override

.md

Hold one trader to a different level or threshold on one detector.

Scopesadmin:write
Permissionmanage_fraud
POST/v1/admin/fraud/overrides

Make an exception for one trader on one detector. It takes effect at once: access checks cached for the trader are thrown away.

A trader has at most one override per detector. Asking for a second is refused with 409 override_exists, which names the one in the way in override, so the app can open that one instead.

Needs a firm. Our own staff name one with the Propper-Workspace header.

Request

FieldDescription
user_idThe trader, by id. A trader of this firm who has not deleted their account
detectorThe detector's key. Not a trading rule
leveloff, monitor, flag, restrict or block, or null to keep the firm's level. Off exempts the trader, and an override can switch on for one trader a detector the firm has off
paramsOnly the thresholds that differ, by key, and only those the detector's fields mark overridable. Ranges as for the detectors
reasonUp to 1000 characters
expires_atAn instant after now, or null for no end. The website sends the end of the chosen day in the admin's own time zone

A level or at least one threshold, or there is nothing to override.

curl -X POST "https://api.proppertrading.com/v1/admin/fraud/overrides" \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
  -H "Propper-Workspace: acme" \
  -H "Idempotency-Key: 2a4c6e8b-0d2f-4a4c-9e6b-8d0f2a4c6e8a" \
  -H "Content-Type: application/json" \
  -d '{"user_id": "usr_aqms4nt797jdkttb", "detector": "max_countries", "params": {"max_countries": 8}, "reason": "Travels for work, asked by email on 3 October.", "expires_at": "2026-12-09T22:59:59Z"}'

Response

201, with the new override.

Errors

StatusCodeMeaning
400workspace_requiredAsked by our own staff without naming a firm
400missing_idempotency_keyA POST without an Idempotency-Key header
401invalid_tokenNot a token, or the secret does not match
401revoked_tokenSigned out here or from another device
401expired_tokenNinety days without use, or a set expiry passed
403admin_access_requiredThis account no longer helps run the environment
403insufficient_scopeThis device does not hold admin:write
403workspace_not_permittedThe Propper-Workspace header names an environment this account cannot act in
403forbiddenWithout manage_fraud
409override_existsThe trader already has an override on this detector, named in override
422validation_failedNo such trader or detector, nothing to override, a threshold this detector does not let one trader change, or one out of range, a reason over 1000 characters, an end in the past