Update a meter

Update a meter

curl --request PUT \
  --url https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/meters/{meterId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "areaServed": 123,
  "installationDate": "2022-03-10T00:00:00.000Z",
  "condition": "<string>",
  "serialNumber": "<string>",
  "storageUnitSymbol": "<string>",
  "conversionFactor": 123,
  "model": "<string>",
  "vendor": "<string>",
  "manufacturer": "<string>",
  "tenant": "<string>",
  "deviceClass": "<string>",
  "zone": "<string>",
  "siteLevel": true,
  "location": "<string>",
  "description": "<string>",
  "isMain": true,
  "endUse": "<string>",
  "dataInterval": "<string>",
  "identifier": "<string>",
  "locatedIn": "<string>",
  "utilityAccountId": "<string>",
  "utilityProvider": "<string>",
  "utilityMeterId": "<string>",
  "meterReaderDeviceId": "<string>"
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    areaServed: 123,
    installationDate: '2022-03-10T00:00:00.000Z',
    condition: '<string>',
    serialNumber: '<string>',
    storageUnitSymbol: '<string>',
    conversionFactor: 123,
    model: '<string>',
    vendor: '<string>',
    manufacturer: '<string>',
    tenant: '<string>',
    deviceClass: '<string>',
    zone: '<string>',
    siteLevel: true,
    location: '<string>',
    description: '<string>',
    isMain: true,
    endUse: '<string>',
    dataInterval: '<string>',
    identifier: '<string>',
    locatedIn: '<string>',
    utilityAccountId: '<string>',
    utilityProvider: '<string>',
    utilityMeterId: '<string>',
    meterReaderDeviceId: '<string>'
  })
};

fetch('https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/meters/{meterId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/meters/{meterId}"

payload = {
    "name": "<string>",
    "areaServed": 123,
    "installationDate": "2022-03-10T00:00:00.000Z",
    "condition": "<string>",
    "serialNumber": "<string>",
    "storageUnitSymbol": "<string>",
    "conversionFactor": 123,
    "model": "<string>",
    "vendor": "<string>",
    "manufacturer": "<string>",
    "tenant": "<string>",
    "deviceClass": "<string>",
    "zone": "<string>",
    "siteLevel": True,
    "location": "<string>",
    "description": "<string>",
    "isMain": True,
    "endUse": "<string>",
    "dataInterval": "<string>",
    "identifier": "<string>",
    "locatedIn": "<string>",
    "utilityAccountId": "<string>",
    "utilityProvider": "<string>",
    "utilityMeterId": "<string>",
    "meterReaderDeviceId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/meters/{meterId}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
  "name": "<string>",
  "areaServed": 123,
  "installationDate": "2022-03-10T00:00:00.000Z",
  "condition": "<string>",
  "serialNumber": "<string>",
  "storageUnitSymbol": "<string>",
  "conversionFactor": 123,
  "model": "<string>",
  "vendor": "<string>",
  "manufacturer": "<string>",
  "tenant": "<string>",
  "deviceClass": "<string>",
  "zone": "<string>",
  "siteLevel": true,
  "location": "<string>",
  "description": "<string>",
  "isMain": true,
  "endUse": "<string>",
  "dataInterval": "<string>",
  "identifier": "<string>",
  "locatedIn": "<string>",
  "utilityAccountId": "<string>",
  "utilityProvider": "<string>",
  "utilityMeterId": "<string>",
  "meterReaderDeviceId": "<string>"
}'

{
  "_id": "<string>",
  "organizationId": "<string>",
  "createdAt": "2026-10-28T13:51:31+0000",
  "updatedAt": "2026-10-28T13:51:31+0000",
  "name": "<string>",
  "area": {
    "name": "<string>",
    "_id": "<string>",
    "order": 123
  },
  "locatedIn": {
    "_id": "<string>",
    "name": "<string>",
    "category": "<string>"
  },
  "building": {
    "_id": "<string>",
    "organizationId": "<string>",
    "createdAt": "2026-10-28T13:51:31+0000",
    "updatedAt": "2026-10-28T13:51:31+0000",
    "name": "<string>"
  },
  "canonicalType": "<string>",
  "connector": {
    "_id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "integrationType": "<string>"
  },
  "fieldsInConnector": {
    "_id": "<string>",
    "name": "<string>",
    "navName": "<string>",
    "axSlotPath": "<string>",
    "device": "<string>"
  },
  "location": "<string>",
  "ontology": {
    "canonicalType": "<string>",
    "entities": [
      "<string>"
    ],
    "messages": [
      "<string>"
    ],
    "virtualPoints": [
      {
        "cName": "<string>",
        "cFunc": "<string>"
      }
    ],
    "requiredRefs": [
      {
        "key": "<string>",
        "value": 123,
        "canonicalType": "<string>"
      }
    ],
    "match": true
  },
  "originType": "VIRTUAL",
  "references": [
    {
      "device": {
        "_id": "<string>",
        "name": "<string>"
      },
      "type": "INPUT",
      "key": "<string>",
      "ontology": {
        "canonicalType": "<string>",
        "entities": [
          "<string>"
        ]
      },
      "manuallyAdded": true,
      "deviceId": "<string>",
      "refKey": "<string>"
    }
  ],
  "spaceReferences": [
    {
      "space": {
        "_id": "<string>",
        "name": "<string>",
        "category": "<string>"
      },
      "key": "serves"
    }
  ],
  "pointsCount": 123,
  "points": [
    {
      "_id": "<string>",
      "field": "<string>",
      "name": "<string>",
      "unit": {
        "_id": "<string>",
        "category": "<string>",
        "baseSymbol": "<string>",
        "symbol": "<string>"
      },
      "dataInterval": "<string>"
    }
  ],
  "areaServed": 123,
  "installationDate": "2022-03-10T00:00:00.000Z",
  "condition": "<string>",
  "serialNumber": "<string>",
  "model": "<string>",
  "description": "<string>",
  "vendor": "<string>",
  "manufacturer": "<string>",
  "status": "ACTIVE",
  "identifier": "<string>",
  "apiMeta": {
    "spareMeter": "<string>",
    "multiplyBy": 123,
    "multiplyTotalBy": 123,
    "certificationDate": "<string>",
    "nextCertificationDate": "<string>",
    "externalMeterCode": "<string>"
  },
  "sourceForm": "<string>",
  "utilityAccountId": "<string>",
  "utilityProvider": "<string>",
  "utilityMeterId": "<string>",
  "meterReaderDeviceId": "<string>",
  "meterCategory": "<string>",
  "conversionFactor": 123,
  "dataInterval": "<string>",
  "isMain": true,
  "endUse": "<string>"
}

PUT

https://api.kodelabs.com/kodeos

api

buildings

{buildingId}

meters

{meterId}

Update a meter

curl --request PUT \
  --url https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/meters/{meterId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "areaServed": 123,
  "installationDate": "2022-03-10T00:00:00.000Z",
  "condition": "<string>",
  "serialNumber": "<string>",
  "storageUnitSymbol": "<string>",
  "conversionFactor": 123,
  "model": "<string>",
  "vendor": "<string>",
  "manufacturer": "<string>",
  "tenant": "<string>",
  "deviceClass": "<string>",
  "zone": "<string>",
  "siteLevel": true,
  "location": "<string>",
  "description": "<string>",
  "isMain": true,
  "endUse": "<string>",
  "dataInterval": "<string>",
  "identifier": "<string>",
  "locatedIn": "<string>",
  "utilityAccountId": "<string>",
  "utilityProvider": "<string>",
  "utilityMeterId": "<string>",
  "meterReaderDeviceId": "<string>"
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    areaServed: 123,
    installationDate: '2022-03-10T00:00:00.000Z',
    condition: '<string>',
    serialNumber: '<string>',
    storageUnitSymbol: '<string>',
    conversionFactor: 123,
    model: '<string>',
    vendor: '<string>',
    manufacturer: '<string>',
    tenant: '<string>',
    deviceClass: '<string>',
    zone: '<string>',
    siteLevel: true,
    location: '<string>',
    description: '<string>',
    isMain: true,
    endUse: '<string>',
    dataInterval: '<string>',
    identifier: '<string>',
    locatedIn: '<string>',
    utilityAccountId: '<string>',
    utilityProvider: '<string>',
    utilityMeterId: '<string>',
    meterReaderDeviceId: '<string>'
  })
};

fetch('https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/meters/{meterId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/meters/{meterId}"

payload = {
    "name": "<string>",
    "areaServed": 123,
    "installationDate": "2022-03-10T00:00:00.000Z",
    "condition": "<string>",
    "serialNumber": "<string>",
    "storageUnitSymbol": "<string>",
    "conversionFactor": 123,
    "model": "<string>",
    "vendor": "<string>",
    "manufacturer": "<string>",
    "tenant": "<string>",
    "deviceClass": "<string>",
    "zone": "<string>",
    "siteLevel": True,
    "location": "<string>",
    "description": "<string>",
    "isMain": True,
    "endUse": "<string>",
    "dataInterval": "<string>",
    "identifier": "<string>",
    "locatedIn": "<string>",
    "utilityAccountId": "<string>",
    "utilityProvider": "<string>",
    "utilityMeterId": "<string>",
    "meterReaderDeviceId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.kodelabs.com/kodeos/api/v1/buildings/{buildingId}/meters/{meterId}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
  "name": "<string>",
  "areaServed": 123,
  "installationDate": "2022-03-10T00:00:00.000Z",
  "condition": "<string>",
  "serialNumber": "<string>",
  "storageUnitSymbol": "<string>",
  "conversionFactor": 123,
  "model": "<string>",
  "vendor": "<string>",
  "manufacturer": "<string>",
  "tenant": "<string>",
  "deviceClass": "<string>",
  "zone": "<string>",
  "siteLevel": true,
  "location": "<string>",
  "description": "<string>",
  "isMain": true,
  "endUse": "<string>",
  "dataInterval": "<string>",
  "identifier": "<string>",
  "locatedIn": "<string>",
  "utilityAccountId": "<string>",
  "utilityProvider": "<string>",
  "utilityMeterId": "<string>",
  "meterReaderDeviceId": "<string>"
}'

{
  "_id": "<string>",
  "organizationId": "<string>",
  "createdAt": "2026-10-28T13:51:31+0000",
  "updatedAt": "2026-10-28T13:51:31+0000",
  "name": "<string>",
  "area": {
    "name": "<string>",
    "_id": "<string>",
    "order": 123
  },
  "locatedIn": {
    "_id": "<string>",
    "name": "<string>",
    "category": "<string>"
  },
  "building": {
    "_id": "<string>",
    "organizationId": "<string>",
    "createdAt": "2026-10-28T13:51:31+0000",
    "updatedAt": "2026-10-28T13:51:31+0000",
    "name": "<string>"
  },
  "canonicalType": "<string>",
  "connector": {
    "_id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "integrationType": "<string>"
  },
  "fieldsInConnector": {
    "_id": "<string>",
    "name": "<string>",
    "navName": "<string>",
    "axSlotPath": "<string>",
    "device": "<string>"
  },
  "location": "<string>",
  "ontology": {
    "canonicalType": "<string>",
    "entities": [
      "<string>"
    ],
    "messages": [
      "<string>"
    ],
    "virtualPoints": [
      {
        "cName": "<string>",
        "cFunc": "<string>"
      }
    ],
    "requiredRefs": [
      {
        "key": "<string>",
        "value": 123,
        "canonicalType": "<string>"
      }
    ],
    "match": true
  },
  "originType": "VIRTUAL",
  "references": [
    {
      "device": {
        "_id": "<string>",
        "name": "<string>"
      },
      "type": "INPUT",
      "key": "<string>",
      "ontology": {
        "canonicalType": "<string>",
        "entities": [
          "<string>"
        ]
      },
      "manuallyAdded": true,
      "deviceId": "<string>",
      "refKey": "<string>"
    }
  ],
  "spaceReferences": [
    {
      "space": {
        "_id": "<string>",
        "name": "<string>",
        "category": "<string>"
      },
      "key": "serves"
    }
  ],
  "pointsCount": 123,
  "points": [
    {
      "_id": "<string>",
      "field": "<string>",
      "name": "<string>",
      "unit": {
        "_id": "<string>",
        "category": "<string>",
        "baseSymbol": "<string>",
        "symbol": "<string>"
      },
      "dataInterval": "<string>"
    }
  ],
  "areaServed": 123,
  "installationDate": "2022-03-10T00:00:00.000Z",
  "condition": "<string>",
  "serialNumber": "<string>",
  "model": "<string>",
  "description": "<string>",
  "vendor": "<string>",
  "manufacturer": "<string>",
  "status": "ACTIVE",
  "identifier": "<string>",
  "apiMeta": {
    "spareMeter": "<string>",
    "multiplyBy": 123,
    "multiplyTotalBy": 123,
    "certificationDate": "<string>",
    "nextCertificationDate": "<string>",
    "externalMeterCode": "<string>"
  },
  "sourceForm": "<string>",
  "utilityAccountId": "<string>",
  "utilityProvider": "<string>",
  "utilityMeterId": "<string>",
  "meterReaderDeviceId": "<string>",
  "meterCategory": "<string>",
  "conversionFactor": 123,
  "dataInterval": "<string>",
  "isMain": true,
  "endUse": "<string>"
}

Send the fields you want to change. Use locatedIn to put the meter in a space. To link a meter to a space it serves or measures, use Assign a meter to a space.

status must be ACTIVE, OUT_OF_SERVICE, or DECOMMISSIONED, in capitals. installationDate must be a date in YYYY-MM-DD format.

Authorizations

Authorization

string

header

required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Path Parameters

buildingId

string

required

Building identifier from List buildings.

meterId

string

required

Identifier of the meter to update.

Body

application/json

name

string

Name of the meter.

areaServed

integer<int32>

Area the meter serves.

installationDate

string<date>

Date the meter was installed (YYYY-MM-DD).

Example:

"2022-03-10T00:00:00.000Z"

condition

string

Condition of the meter.

serialNumber

string

Serial number.

storageUnitSymbol

string

Unit symbol of the stored readings.

conversionFactor

number<double>

Factor that converts a reading to the storage unit.

model

string

Model of the meter.

vendor

string

Vendor of the meter.

manufacturer

string

Manufacturer of the meter.

tenant

string

Tenant the meter belongs to.

deviceClass

string

Device class of the meter.

zone

string

Zone of the meter.

siteLevel

boolean

Whether the meter is a site-level meter.

location

string

Location of the meter.

description

string

Description of the meter.

isMain

boolean

Whether this is the main meter of the building.

endUse

string

End use of the meter.

dataInterval

string

Interval of the meter data.

identifier

string

Your own identifier for the meter.

locatedIn

string

Identifier of the space the meter is in. The space must exist.

status

enum<string>

ACTIVE, OUT_OF_SERVICE, or DECOMMISSIONED. The value is case-sensitive.

Available options:

ACTIVE,

OUT_OF_SERVICE,

DECOMMISSIONED

utilityAccountId

string

Utility account of the meter.

utilityProvider

string

Utility provider.

utilityMeterId

string

Meter id at the utility.

meterReaderDeviceId

string

Device that reads the meter.

Response

The updated meter.

_id

string

Meter identifier.

organizationId

string

createdAt

string

read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

updatedAt

string

read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

name

string

Name of the meter.

area

object

Show child attributes

locatedIn

object

The space the meter is in.

Show child attributes

building

object

Show child attributes

canonicalType

string

Canonical type of the meter.

connector

object

Show child attributes

fieldsInConnector

object

Show child attributes

location

string

ontology

object

Show child attributes

originType

enum<string>

How the meter was created: ORIGIN for a meter from a data source, VIRTUAL for a calculated meter, or MANUAL for a meter you add by hand.

Available options:

VIRTUAL,

ORIGIN,

MANUAL

references

object[]

Meters and devices this meter reads from.

Show child attributes

spaceReferences

object[]

Spaces the meter serves or measures.

Show child attributes

pointsCount

integer<int32>

points

object[]

Show child attributes

areaServed

integer<int32>

installationDate

string<date>

Date the meter was installed.

Example:

"2022-03-10T00:00:00.000Z"

condition

string

serialNumber

string

model

string

description

string

vendor

string

manufacturer

string

status

enum<string>

ACTIVE, OUT_OF_SERVICE, or DECOMMISSIONED.

Available options:

ACTIVE,

OUT_OF_SERVICE,

DECOMMISSIONED

identifier

string

Your own identifier for the meter.

apiMeta

object

Show child attributes

sourceForm

string

utilityAccountId

string

utilityProvider

string

utilityMeterId

string

meterReaderDeviceId

string

meterCategory

string

conversionFactor

number<double>

dataInterval

string

isMain

boolean

Whether this is the main meter of the building.

endUse

string

Get started

Guides

API reference

Authorizations

Path Parameters

Body

Response