> ## 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 the status of a user > Activates or deactivates a user. Send `active` as `true` or `false`. > [!WARNING] > > The first time KODE activates a user, it sends an account email to the user's address, with a link to set a password. Check that the user is the right one before you send the request. > [!NOTE] > > Send the status the user does not have yet. A request for the status the user already has fails with `400` and the message "Invalid status update". Read the user with [Get a user](https://docs.kodelabs.com/products/kode-api/api-reference/users/get-a-user.md) to check `active` first. > [!NOTE] > > The response is the updated user. A deactivated user stays in your organization. To delete the user, use [Delete a user](https://docs.kodelabs.com/products/kode-api/api-reference/users/delete-a-user.md). ## OpenAPI ````yaml /openapi/kode-api.yaml put /api/v1/users/{userId}/status 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}/status: put: tags: - Users summary: Update the status of a user description: Activates or deactivates a user. Send `active` as `true` or `false`. operationId: updateUserStatus 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/UpdateUserStatusRequest' required: true responses: '200': description: The updated user. content: application/json: schema: $ref: '#/components/schemas/UserPublic' '400': description: >- `active` is missing, `null`, or not a boolean, the body is not valid JSON, or the user already has the status you sent ("Invalid status update"). '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: >- No user with this `userId` exists in your organization ("User not found"). '429': $ref: '#/components/responses/TooManyRequests' components: schemas: UpdateUserStatusRequest: type: object required: - active properties: active: description: '`true` to activate the user, `false` to deactivate the user.' type: boolean 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. Forbidden: description: The service account lacks permission for this building or operation. 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.