PUT
/v1/admin/fraud/overrides/{override}Change what an override does. The trader and the detector stay as they are. The four fields are the override as it should be, so one left out is cleared. An ended override applies again once it gets a new end or none.
Needs a firm. Our own staff name one with the Propper-Workspace header.
Request
| Field | Description |
|---|---|
level | off, 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 |
params | Only the thresholds that differ, by key, and only those the detector's fields mark overridable. Ranges as for the detectors |
reason | Up to 1000 characters |
expires_at | An 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 PUT "https://api.proppertrading.com/v1/admin/fraud/overrides/fovr_n936unrak5zz8u2k" \
-H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
-H "Propper-Workspace: acme" \
-H "Content-Type: application/json" \
-d '{"level": null, "params": {"max_countries": 10}, "reason": "Travels for work, asked by email on 3 October.", "expires_at": null}'
Response
The override as it is now.
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | workspace_required | Asked by our own staff without naming a firm |
| 401 | invalid_token | Not a token, or the secret does not match |
| 401 | revoked_token | Signed out here or from another device |
| 401 | expired_token | Ninety days without use, or a set expiry passed |
| 403 | admin_access_required | This account no longer helps run the environment |
| 403 | insufficient_scope | This device does not hold admin:write |
| 403 | workspace_not_permitted | The Propper-Workspace header names an environment this account cannot act in |
| 403 | forbidden | Without manage_fraud |
| 404 | resource_not_found | No override with that id in this firm |
| 422 | validation_failed | 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 |