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

# Write to a point

> Sends a write to a single point. Build the `actions` array from the point write fields.

> [!WARNING]
>
> Point writes can command live building equipment. Test with a non-critical point before you automate writes.

Call [List point write fields](https://docs.kodelabs.com/products/kode-api/api-reference/points/list-point-write-fields.md) first to learn which fields the point accepts.


## OpenAPI

````yaml /openapi/kode-api.yaml post /api/v1/buildings/{buildingId}/integrations/datasources/{datasourceId}/devices/{deviceId}/points/{pointId}/write
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}/integrations/datasources/{datasourceId}/devices/{deviceId}/points/{pointId}/write:
    post:
      tags:
        - Points
      summary: Write to a point
      description: >-
        Sends a write to a single point. Build the `actions` array from the
        point write fields.
      operationId: writePoint
      parameters:
        - $ref: '#/components/parameters/BuildingId'
        - $ref: '#/components/parameters/DatasourceId'
        - $ref: '#/components/parameters/DeviceId'
        - $ref: '#/components/parameters/PointId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PointWriteRequest'
      responses:
        '200':
          description: The point priority array after the write.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PointWriteResult'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '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
    DatasourceId:
      name: datasourceId
      in: path
      required: true
      description: Data source identifier from List building data sources.
      schema:
        type: string
      example: 67c97396a0fceb379fc4ec08
    DeviceId:
      name: deviceId
      in: path
      required: true
      description: Device identifier.
      schema:
        type: string
      example: ahu-01
    PointId:
      name: pointId
      in: path
      required: true
      description: Point identifier.
      schema:
        type: string
      example: zone-temp-setpoint
  schemas:
    PointWriteRequest:
      type: object
      required:
        - actions
      properties:
        actions:
          type: array
          description: Field values built from List point write fields.
          items:
            $ref: '#/components/schemas/ActionValue'
          example:
            - id: priority
              value: override
            - id: duration
              value: '3600000'
            - id: value
              value: 72
        notes:
          type: string
          description: Note recorded with the write.
          example: Raised setpoint for after-hours event
    PointWriteResult:
      type: object
      properties:
        type:
          type: string
          example: TABLE
        value:
          type: object
          properties:
            headers:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  order:
                    type: integer
                  value:
                    type: string
              example:
                - key: level
                  order: 1
                  value: Level
                - key: val
                  order: 2
                  value: Current Value
            values:
              type: array
              items:
                type: object
                additionalProperties: true
              example:
                - level: 8
                  val: '72.0'
                - level: 10
                  val: '68.5'
    ActionValue:
      type: object
      required:
        - id
        - value
      properties:
        id:
          type: string
          description: Field identifier from the fields endpoint.
          example: priority
        value:
          description: Field value. The type depends on the field `dataType`.
          oneOf:
            - title: String
              type: string
              example: override
            - title: Number
              type: number
              example: 72
            - title: Boolean
              type: boolean
  responses:
    BadRequest:
      description: The request is invalid. Check required fields, types, and limits.
    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.
    NotFound:
      description: The resource does not exist or is not assigned to the service account.
    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.