> ## Documentation Index > Fetch the complete documentation index at: https://docs.kodelabs.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a user > Changes the name, organization role, phone number, or position of a user. > [!NOTE] > > You cannot change `email` with this operation. To change `active`, use [Update the status of a user](https://docs.kodelabs.com/products/kode-api/api-reference/users/update-the-status-of-a-user.md). To change app access, use [Assign an app to a user](https://docs.kodelabs.com/products/kode-api/api-reference/users/assign-an-app-to-a-user.md), [Update the KODE OS role of a user](https://docs.kodelabs.com/products/kode-api/api-reference/users/update-the-kode-os-role-of-a-user.md), and [Remove app access from a user](https://docs.kodelabs.com/products/kode-api/api-reference/users/remove-app-access-from-a-user.md). > [!NOTE] > > Send the fields you want to change. A field you leave out keeps its value. A blank name or role is ignored. An empty `phone` or `position` clears the value. Names can have up to 40 characters, and `position` up to 200. > [!WARNING] > > This operation returns `403` if you set `role` to `CLIENT_ADMIN`. The `role` field here is the organization role. The role in an app changes with [Update the KODE OS role of a user](https://docs.kodelabs.com/products/kode-api/api-reference/users/update-the-kode-os-role-of-a-user.md). ## OpenAPI ````yaml /openapi/kode-api.yaml put /api/v1/users/{userId} openapi: 3.1.0 info: title: KODE API version: 1.0.0 summary: Programmatic access to KODE OS resources and operations. description: > Use the KODE API to work with buildings, data sources, connectors, devices, points, virtual devices, timeseries data, schedules, the ontology, templating, mass writes, spaces, space assignments, tenants, meters, users, actions, and AssetOps work orders. license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.kodelabs.com/kodeos description: KODE API security: - bearerAuth: [] tags: - name: Authentication description: OAuth 2.0 discovery, token, and revocation endpoints. - name: Buildings description: Buildings and their areas. - name: Data sources description: Data sources connected to a building. - name: Devices description: Devices and their points. - name: Points description: Point queries and point writes. - name: Timeseries description: Current and historical point values. - name: Actions description: Actions exposed by building data sources. - name: Work orders description: AssetOps work orders, lookups, comments, and attachments. - name: Connectors description: KODE API connectors and the devices and points ingested through them. - name: Schedules description: Schedules discovered on building data sources. - name: Templating description: Apply ontology templates to groups of points. - name: Virtual devices description: Virtual devices that group points from other devices. - name: Ontology description: Canonical types, fields, units, and connections of the KODE ontology. - name: Users description: Users of the organization and their app access. - name: Mass write description: Write values to many points across buildings, and follow each run. - name: Spaces description: Levels and space units of a building, and the meters located in them. - name: Space assignments description: Assign tenants to leasable spaces of a building for a period. - name: Tenants description: Tenants of a building, the people or companies that lease its spaces. - name: Meters description: >- Meters of a building, their space assignments, parent and child links, and readings. paths: /api/v1/users/{userId}: put: tags: - Users summary: Update a user description: >- Changes the name, organization role, phone number, or position of a user. operationId: updateUser parameters: - name: userId in: path required: true schema: type: string description: Identifier of the user to update. requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserRequest' required: true responses: '200': description: The updated user. content: application/json: schema: $ref: '#/components/schemas/UserPublic' '400': description: >- A field is too long or has the wrong type, or `phone` or `role` is not valid. `error.fields` names the field when the API checks it. '401': $ref: '#/components/responses/Unauthorized' '403': description: >- The service account is not allowed to set the role you sent, for example `CLIENT_ADMIN`. The message is "You're not allowed to update users in given role". '404': description: No user with this `userId` exists in your organization. '429': $ref: '#/components/responses/TooManyRequests' components: schemas: UpdateUserRequest: type: object properties: firstName: type: string maxLength: 40 lastName: type: string maxLength: 40 role: type: string phone: type: string position: type: string maxLength: 200 UserPublic: type: object properties: _id: type: string organizationId: type: string createdAt: $ref: '#/components/schemas/Date' type: string readOnly: true updatedAt: $ref: '#/components/schemas/Date' type: string readOnly: true firstName: type: string lastName: type: string email: type: string phone: type: string position: type: string role: type: string memberType: type: string active: type: boolean invitationStatus: type: string assignedInApps: type: array items: $ref: '#/components/schemas/AppAssignmentPublic' Date: type: string description: >- Date and time in UTC, with a numeric offset and no colon, for example `2026-10-28T13:51:31+0000`. examples: - 2026-10-28T13:51:31+0000 AppAssignmentPublic: type: object properties: appId: type: string role: type: string assignmentStatus: type: string responses: Unauthorized: description: The access token is missing, invalid, or expired. Request a new token. TooManyRequests: description: >- A rate-limit window is exhausted. Wait, then retry with increasing delays. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Paste an access token from [Create an access token](/products/kode-api/api-reference/authentication/create-an-access-token). Tokens expire, so request a new one if you receive `401`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.