Developers › API reference › Firm

PATCH /api/v1/firm

Change settings (If-Match).

• Scope firm:write
• If-Match
• operationId adminUpdateFirm

The token needs the scope firm:write, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Request

PATCH /api/v1/firm

Headers

Body: FirmPatch

Other fields of the resource are accepted too; unknown fields are reported by a validation problem, never ignored silently.

Decimals (money, prices, quantities, percentages) are sent as strings, ids as strings, times as ISO 8601 UTC.

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl -X PATCH "https://vestoris.com/api/v1/firm" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'If-Match: "3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f"' \
  -H "Content-Type: application/json" \
  -d '{"settings":{"approval_order_value":"1000000.00","stuck_minutes":30}}'

import os, requests

r = requests.patch(
    "https://vestoris.com/api/v1/firm",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "If-Match": "\"3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f\"",
    },
    json={
        "settings": {
            "approval_order_value": "1000000.00",
            "stuck_minutes": 30
        }
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

const res = await fetch("https://vestoris.com/api/v1/firm", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "If-Match": "\"3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f\"",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "settings": {
          "approval_order_value": "1000000.00",
          "stuck_minutes": 30
      }
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: Firm. With an ETag header. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Example response

HTTP/1.1 200 OK
Content-Type: application/json
ETag: "3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f"

{
    "id": "1042",
    "name": "Example RIA",
    "code": "ACME",
    "demo": true,
    "status": "active",
    "settings": {
        "approval_order_value": "1000000.00",
        "approval_pct_of_account": "5.00",
        "ai_enabled": true,
        "ai_retention_days": 2555,
        "wash_window_days": 5,
        "spoof_cancel_minutes": 5,
        "spoof_min_value": "500000.00",
        "stuck_minutes": 30,
        "override_approval_value": "250000.00",
        "single_co_approval": false,
        "legacy_keys_enabled": true,
        "api_max_access_ttl": 3600,
        "api_max_refresh_days": 30,
        "api_rate_per_minute": 600
    }
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/firm"
}

On the screens

The same thing in the app is explained in:

• Firm settings