> ## 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 tenant

> Changes the details of a tenant.

> [!WARNING]
>
> Send every value you want the tenant to keep, including `name`. A value you leave out can be cleared, and `status` can go back to `active`. Read the tenant with [Get a tenant](https://docs.kodelabs.com/products/kode-api/api-reference/tenants/get-a-tenant.md) and send it back with your changes.

> [!NOTE]
>
> The `logo` cannot be changed after the tenant is created.


## OpenAPI

````yaml /openapi/kode-api.yaml put /api/v1/buildings/{buildingId}/tenants/{tenantId}
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/buildings/{buildingId}/tenants/{tenantId}:
    put:
      tags:
        - Tenants
      summary: Update a tenant
      description: Changes the details of a tenant.
      operationId: updateTenant
      parameters:
        - $ref: '#/components/parameters/BuildingId'
        - name: tenantId
          in: path
          required: true
          schema:
            type: string
          description: Identifier of the tenant to update.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTenantRequest'
        required: true
      responses:
        '200':
          description: The updated tenant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenantPublic'
        '400':
          description: The body is missing, or `contactPerson` has the wrong type.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The building does not exist or is not assigned to the service
            account. KODE API answers `403` in both cases so that building ids
            cannot be probed.
        '404':
          description: No tenant with this `tenantId` exists.
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    BuildingId:
      name: buildingId
      in: path
      required: true
      description: Building identifier from List buildings.
      schema:
        type: string
      example: 67c960faffaa42223163099e
  schemas:
    UpdateTenantRequest:
      type: object
      properties:
        name:
          description: Name of the tenant.
          type: string
        description:
          description: Description of the tenant.
          type: string
        status:
          description: '`active` or `inactive`.'
          type: string
        logo:
          description: Not used. The logo cannot be changed after the tenant is created.
          type: string
        contactPerson:
          $ref: '#/components/schemas/ContactPerson1'
          description: Contact person of the tenant.
        identifier:
          description: Your own identifier for the tenant.
          type: string
    TenantPublic:
      type: object
      properties:
        _id:
          description: Tenant identifier.
          type: string
        organizationId:
          type: string
        createdAt:
          $ref: '#/components/schemas/Date'
          type: string
          readOnly: true
        updatedAt:
          $ref: '#/components/schemas/Date'
          type: string
          readOnly: true
        name:
          description: Name of the tenant.
          type: string
        description:
          type: string
        type:
          description: Type of the tenant, for example `company`.
          type: string
        status:
          description: '`active` or `inactive`.'
          type: string
        buildingIds:
          description: Buildings the tenant belongs to.
          type: array
          items:
            type: string
        identifier:
          description: Your own identifier for the tenant.
          type: string
        logo:
          description: Logo of the tenant.
          type: string
        contactPerson:
          $ref: '#/components/schemas/ContactPerson2'
          description: Contact person of the tenant.
    ContactPerson1:
      type: object
      properties:
        firstName:
          description: First name.
          type: string
        lastName:
          description: Last name.
          type: string
        email:
          description: Email address.
          type: string
        phone:
          description: Phone number.
          type: string
    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
    ContactPerson2:
      type: object
      properties:
        firstName:
          description: First name.
          type: string
        lastName:
          description: Last name.
          type: string
        email:
          description: Email address.
          type: string
        phone:
          description: Phone number.
          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.