Developers › API reference › User-defined fields

PUT `/api/v1/udf/{table}/records/{key}`

Set user-defined values of one record (If-Match).

Scope reference:write
If-Match
operationId referenceSetUdfValues

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

If-Match. Send If-Match with the ETag of your latest GET. If someone changed the resource since, you get 412 precondition_failed and nothing changes: GET it again, re-apply your change and retry.

Request

PUT /api/v1/udf/{table}/records/{key}

Path parameters

Name	Description	Example
`table`	The reference table: securities, issuers, accounts, account_groups, brokers, models, benchmarks, desks or list_entries.	`securities`
`key`	The record's key (a symbol, an account code…).	`AAPL`

Headers

Header	Required	Value
`Authorization`	yes	`Bearer <token>`: an OAuth access token (`vat_…`) or a personal access token (`vpt_…`). Get a token
`If-Match`	yes	The `ETag` of your latest GET of this resource. ETags
`Content-Type`	yes	`application/json`

Body: `UdfValuesIn`

Field	Type	Required	Description
`values`	object	yes	Values by field name (or udf_N); null clears one.

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/udf/securities/records/AAPL" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'If-Match: "3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f"' \
  -H "Content-Type: application/json" \
  -d '{"values":{"Internal rating":"BB"}}'

Python (requests)

import os, requests

r = requests.put(
    "https://vestoris.com/api/v1/udf/securities/records/AAPL",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "If-Match": "\"3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f\"",
    },
    json={
        "values": {
            "Internal rating": "BB"
        }
    },
    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/udf/securities/records/AAPL", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "If-Match": "\"3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f\"",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "values": {
          "Internal rating": "BB"
      }
  }),
});
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: UdfValues. With an ETag header. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`table`	string	The reference table: securities, issuers, accounts, account_groups, brokers, models, benchmarks, desks, list_entries.
`key`	string	The record's natural key (e.g. a symbol or account code).
`values`	object	Values by field name.

Example response

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

{
    "table": "securities",
    "key": "AAPL",
    "values": {
        "Internal rating": "BB"
    }
}

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`
412	The resource changed since your GET: get it again and retry with the new ETag	`precondition_failed`
422	Validation failed (the detail says which field), or blocked	`validation_failed`
428	A required header is missing	`precondition_required`
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/udf/securities/records/AAPL"
}

On the screens

The same thing in the app is explained in:

PUT /api/v1/udf/{table}/records/{key}