Update Meter

patch

https://api.arcadia.com/plug/meters/{meterId}

To make updates to a specific meter, you can make a PATCH call to the meters endpoint. Each meter can have up to 10 custom data fields associated. Custom data fields are not required. Custom data allows you to organize meters and tie them back to records in your own system. To update a custom data field, the field must already have a defined label. To define a Custom Data label, you must use the Update Organization Custom Data endpoint.

This endpoint supports Sandbox Mode.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

meterId

string

required

Body Params

customData

object

You can use these fields to specify additional metadata.

electricServiceIdentifier

string

length between 17 and 22

The Electric Service Identifier (ESI ID) associated with the address for the meter. This field will be ignored when updating meters that are not associated with an intervals third party portal.

isIntervalsProductActive

boolean

Indicates if intervals is activated for the meter.

isStandalone

boolean

Indicates a meter is not expected to relate to a site.

meterNumber

string

length between 0 and 255

A meter identifier provided by the commodity provider (oftentimes the bill publisher). This field will be ignored when updating meters that are not associated with an intervals third party portal.

retailCustomerEmail

string

length between 0 and 255

The customer email address associated with the account for the meter. An email will be sent to this email address to grant data sharing access. This field will be ignored when updating meters that are not associated with an intervals third party portal.

site

string

A physical location or facility associated with the meter. This field should be used to specify the site ID.

Headers

Arcadia-Version

string

required

Defaults to 2024-02-21

The Arcadia-Version for the request

Response

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK