Developers › API reference › Entitlements

PUT `/api/v1/entitlements/{userId}/{accountId}`

Set one user's permissions on one account.

Scope entitlements:write
operationId adminSetEntitlement

The token needs the scope entitlements: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/entitlements/{userId}/{accountId}

Path parameters

Name	Description	Example
`userId`	The id of the user.	`7`
`accountId`	The id of the account.	`12`

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: `PermissionSet`

Field	Type	Required	Description
`view`	boolean	no	May view the account.
`propose`	boolean	no	May propose orders on the account.
`trade`	boolean	no	May trade (release, amend, cancel) on the account.
`approve`	boolean	no	May approve orders on the account.

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/entitlements/7/12" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"view":true,"propose":true,"trade":false,"approve":false}'

Python (requests)

import os, requests

r = requests.put(
    "https://vestoris.com/api/v1/entitlements/7/12",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
    },
    json={
        "view": True,
        "propose": True,
        "trade": False,
        "approve": 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/entitlements/7/12", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "view": true,
      "propose": true,
      "trade": false,
      "approve": 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: Entitlement. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Response fields

Field	Type	Description
`user_id`	id (string)	The user.
`account_id`	id (string)	The account's id.
`view`	boolean	May view the account.
`propose`	boolean	May propose orders on the account.
`trade`	boolean	May trade.
`approve`	boolean	May approve orders on the account.

Example response

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

{
    "user_id": "7",
    "account_id": "12",
    "view": true,
    "propose": true,
    "trade": true,
    "approve": false
}

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/entitlements/7/12"
}

On the screens

The same thing in the app is explained in:

PUT /api/v1/entitlements/{userId}/{accountId}