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

# Set the status of a building

> Sets a building to `PUBLISHED` or `UNPUBLISHED`. You can switch it back at any time.

A new building is `UNPUBLISHED`. The building keeps this status in `published` (`true` for `PUBLISHED`) until you change it again.

| `status` | Result |
| - | - |
| `PUBLISHED` | `published` is `true`. |
| `UNPUBLISHED` | `published` is `false`. |

The values are case-sensitive. Sending the status the building already has returns `409`, so a repeated call is not safe to treat as a no-op.

The status does not delete any data. If your service account's role limits access to published buildings, an unpublished building returns `403` on reads, including [Get a building](https://docs.kodelabs.com/products/kode-api/api-reference/buildings/get-a-building.md) and [Get a job](https://docs.kodelabs.com/products/kode-api/api-reference/buildings/get-a-job.md). Publishing and unpublishing still work in that case.


## OpenAPI

````yaml /openapi/kode-api.yaml put /api/v1/buildings/{buildingId}/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/buildings/{buildingId}/status:
    put:
      tags:
        - Buildings
      summary: Set the status of a building
      description: >-
        Sets a building to `PUBLISHED` or `UNPUBLISHED`. You can switch it back
        at any time.
      operationId: updateBuildingStatus
      parameters:
        - $ref: '#/components/parameters/BuildingId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateBuildingStatusRequest'
        required: true
      responses:
        '200':
          description: The building with its new status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuildingPublic'
        '400':
          description: >-
            `status` is missing, empty, in lower case, or not `PUBLISHED` or
            `UNPUBLISHED`.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The building does not exist, is not available to your service
            account, or has no `api` product enabled. Your service account also
            needs the **Publish or unpublish building** action.
        '409':
          description: The building already has this status.
        '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:
    UpdateBuildingStatusRequest:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          pattern: ^(PUBLISHED|UNPUBLISHED)$
    BuildingPublic:
      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
        name:
          type: string
        identifier:
          type: string
        area:
          $ref: '#/components/schemas/Area1'
        yearBuild:
          type: integer
          format: int32
        primaryFunction:
          type: string
        tags:
          type: array
          items:
            type: string
        address:
          $ref: '#/components/schemas/Address1'
        picture:
          type: string
        tz:
          type: string
        areasCount:
          type: integer
          format: int32
        devicesCount:
          type: integer
          format: int32
        connectorsCount:
          type: integer
          format: int32
        systemsCount:
          type: integer
          format: int32
        pointsCount:
          type: integer
          format: int32
        stats:
          $ref: '#/components/schemas/BuildingStats1'
        baseTemp:
          type: number
          format: double
        published:
          type: boolean
        ossEnabled:
          type: boolean
        climateZone:
          $ref: '#/components/schemas/ClimateZone1'
        region:
          type: string
        brand:
          type: string
        zone:
          type: string
        district:
          type: string
        phoneNumber:
          type: string
        site:
          $ref: '#/components/schemas/Site1'
        products:
          type: array
          items:
            $ref: '#/components/schemas/Product'
    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
    Area1:
      type: object
      properties:
        _id:
          type: string
        value:
          type: number
          format: double
        unit:
          type: string
    Address1:
      type: object
      properties:
        address1:
          type: string
        address2:
          type: string
        country:
          type: string
        countryAbbr:
          type: string
        state:
          type: string
        stateAbbr:
          type: string
        city:
          type: string
        zip:
          type: string
        location:
          $ref: '#/components/schemas/Location1'
    BuildingStats1:
      type: object
      properties:
        buildingId:
          type: string
        devices:
          $ref: '#/components/schemas/Devices1'
    ClimateZone1:
      type: object
      properties:
        iecc:
          type: string
        ba:
          type: string
    Site1:
      type: object
      properties:
        identifier:
          type: string
        name:
          type: string
    Product:
      type: object
      properties:
        id:
          type: string
        enabled:
          type: boolean
    Location1:
      type: object
      properties:
        lat:
          type: number
          format: double
        lng:
          type: number
          format: double
    Devices1:
      type: object
      properties:
        ok:
          type: integer
          format: int32
        down:
          type: integer
          format: int32
  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.