PATCH `/api/v1/users/{id}`

Change role or status (If-Match).

Scope admin:users
If-Match
operationId adminUpdateUser

The token needs the scope admin:users, 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

PATCH /api/v1/users/{id}

Path parameters

Name	Description	Example
`id`	The id of the user.	`7`

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

Field	Type	Required	Description
`role`	string	no	A role: trader, portfolio_manager, compliance_officer, operations, firm_admin or viewer.
`status`	string	no	"active" or "disabled".

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 PATCH "https://vestoris.com/api/v1/users/7" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'If-Match: "3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f"' \
  -H "Content-Type: application/json" \
  -d '{"role":"portfolio_manager"}'

Python (requests)

import os, requests

r = requests.patch(
    "https://vestoris.com/api/v1/users/7",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "If-Match": "\"3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f\"",
    },
    json={
        "role": "portfolio_manager"
    },
    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/users/7", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "If-Match": "\"3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f\"",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "role": "portfolio_manager"
  }),
});
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: User. With an ETag header. 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	The user's name.
`email`	string or null	Email address.
`kind`	string	"person" or "service".
`role`	string	A role: trader, portfolio_manager, compliance_officer, operations, firm_admin or viewer.
`status`	string	active, invited or disabled.
`privileges`	list of string	Effective privileges.
`privilege_adjustments`	object	Privileges granted or revoked on top of the role's defaults.
`last_login_at`	date-time or null	The user's last sign-in.
`created_at`	date-time or null	When it was created.

Example response

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

{
    "id": "1042",
    "name": "Alex Rivera",
    "email": "pat@example-ria.com",
    "kind": "person",
    "role": "portfolio_manager",
    "status": "active",
    "privileges": [
        "use_blotter",
        "export"
    ],
    "privilege_adjustments": [],
    "last_login_at": null,
    "created_at": "2026-10-27T14:30:00Z"
}

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/users/7"
}

On the screens

The same thing in the app is explained in:

Users and permissions

PATCH /api/v1/users/{id}