---
title: "Update user"
method: PATCH
path: "/v1/users/{id}"
tags: ["users"]
---

# Update user

`PATCH /v1/users/{id}`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/users/{id}`
- Auth: HTTP bearer

Updates a person's profile. Supported fields are `name` and `trainingStep` (which resets a feature walkthrough for that person). Email address and account status cannot be changed through this operation. Requires access to every location the target person belongs to.

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string: Trimmed; must not be empty.
  - `trainingStep` string, nullable: Walkthrough position (`s1`…`s5`, `l1`…`l6`, `done`); null resets it.

## Response `200`

Success.

- object
  - `data` object, required
    - `id` string, required
    - `email` string, required
    - `name` string, required
    - `status` 'active' | 'invited' | 'deactivated', required
    - `trainingStep` string, nullable, required: Walkthrough position; null when not started or reset.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The person belongs to a location where you do not hold `user.edit`.
- `404`: No such person in this workspace.
- `422`: Nothing to update, an empty or over-long `name`, or an unknown `trainingStep`.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)