PUT `/api/v1/blotter/views/{id}`

Replace a blotter view.

Scope orders:write
operationId ordersUpdateView

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

Request

PUT /api/v1/blotter/views/{id}

Path parameters

Name	Description	Example
`id`	The id of the view.	`3`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token
`Content-Type`	yes	`application/json`

Body: `BlotterViewIn`

Field	Type	Required	Description
`name`	string	yes	Name.
`config`	object	yes	Columns, widths, formats, sort, grouping, default filters and colour rules.
`shared`	boolean	no	Share with the firm (needs Manage shared views).

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

curl -X PUT "https://vestoris.com/api/v1/blotter/views/3" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"My fills today","config":{"columns":["created_at","symbol","side","quantity","filled_quantity","slippage_bps"],"filters":{"today":true}},"shared":false}'

Python (requests)

import os, requests

r = requests.put(
    "https://vestoris.com/api/v1/blotter/views/3",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    json={
        "name": "My fills today",
        "config": {
            "columns": [
                "created_at",
                "symbol",
                "side",
                "quantity",
                "filled_quantity",
                "slippage_bps"
            ],
            "filters": {
                "today": True
            }
        },
        "shared": False
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

JavaScript (fetch)

const res = await fetch("https://vestoris.com/api/v1/blotter/views/3", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "name": "My fills today",
      "config": {
          "columns": [
              "created_at",
              "symbol",
              "side",
              "quantity",
              "filled_quantity",
              "slippage_bps"
          ],
          "filters": {
              "today": true
          }
      },
      "shared": false
  }),
});
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: BlotterView. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`id`	id (string)	The record's id (a string of digits).
`name`	string	Name.
`shared`	boolean	Whether everyone in the firm can use it.
`mine`	boolean	Whether you made it.
`my_default`	boolean	Whether it is your default view.
`firm_default`	boolean	Whether it is the firm's default view.
`config`	any	The view: columns, widths, formats, sort, grouping, default filters and colour rules.
`notices`	list	Fields left out of the view, and why.

Example response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "1042",
    "name": "Execution quality",
    "shared": false,
    "mine": true,
    "my_default": false,
    "firm_default": false,
    "config": {
        "columns": [
            "created_at",
            "symbol",
            "side",
            "quantity",
            "state"
        ],
        "group_by": "symbol"
    },
    "notices": []
}

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.

Status	When	Problem codes
200	Success
400	The request is malformed	`invalid_request` `invalid_json`
401	No token, or it is invalid or expired	`invalid_token`
403	The token lacks the scope, or the person or service account behind it lacks the privilege or account permission	`insufficient_scope` `forbidden` `ip_not_allowed`
404	Not found, or not visible to you (the API never confirms what you may not see)	`not_found`
409	Not possible in the current state	`invalid_transition` `conflict`
422	Validation failed (the detail says which field), or blocked	`validation_failed`
429	Rate limited: wait for Retry-After seconds	`rate_limited`

{
    "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/blotter/views/3"
}

On the screens

The same thing in the app is explained in:

Blotter views and the view editor

PUT /api/v1/blotter/views/{id}