users

Update user

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.

patch/v1/users/{id}

Request

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

Path parameters

idstring required

User id.

Request body

namestring

Trimmed; must not be empty.

trainingStepstring nullable

Walkthrough position (s1…s5, l1…l6, done); null resets it.

Response

Success.

Changes

No recorded changes to this operation across all 2 revisions of this API.