Skip to main content
PATCH
Update Site

Authorizations

X-API-KEY
string
header
required

Path Parameters

site_id
string<uuid>
required

ID of the site to update.

Body

Fields for updating a site.

Clearing dummySiteReason without a confirmed street address is rejected.

externalId
string | null

ID of the site on external platforms used during exports. Used to associate site in Nectar with site within your database.

name
string

Name of the site.

Required string length: 1 - 255
address
string

Address of the site.

Maximum string length: 255
path
string[]

List of location tags in increasing specificity used to filter sites. Filters must be entered from more general to more specific. E.g. ['US', 'CA', 'ON']

Maximum array length: 10
Required string length: 1 - 100
occupancyPercent
string<decimal> | null

Occupancy percent, must be a number from 0 to 100. Usage for the site will be multiplied by this value for specified accounts.

Pattern: ^-?\d{0,3}(?:\.\d{0,4})?$
occupancyApplicationMode
enum<string>

Controls how occupancy percent is applied to usage data. ALL applies to all data on this site regardless of account settings. PER_ACCOUNT applies only to accounts with the occupancy override enabled. DISABLED means occupancy is never applied regardless of account settings. PER_CONNECTION is a deprecated alias for PER_ACCOUNT; reads still return it and writes still accept it.

  • DISABLED - Disabled
  • ALL - All
  • PER_ACCOUNT - Per Account
  • PER_CONNECTION - Per Connection (deprecated alias for Per Account)
Available options:
DISABLED,
ALL,
PER_ACCOUNT,
PER_CONNECTION
dummySiteReason
string | null

If set, this site is a placeholder and a street address is not required. The value describes why (for example API testing, a catch-all, or a multi-address bundle). Omit or null for a regular site. Clearing it on update requires a confirmed street address.

Response

A site: a physical location, or a placeholder when dummySiteReason is set.

id
string<uuid>
required

Unique identifier for the site.

name
string
required

Name of the site.

Maximum string length: 255
dataCollectionStopDate
string<date> | null
required

Date when data collection for this site was stopped. A non-null value indicates the site has been soft-deleted/archived.

externalId
string | null

ID of the site on external platforms used during exports. Used to associate site in Nectar with site within your database.

address
string

Address of the site.

Maximum string length: 255
path
string[]

List of location tags in increasing specificity used to filter sites. Filters must be entered from more general to more specific. E.g. ['US', 'CA', 'ON']

Maximum array length: 10
Maximum string length: 100
occupancyPercent
string<decimal> | null

Occupancy percent, must be a number from 0 to 100. Usage for the site will be multiplied by this value for specified accounts.

Pattern: ^-?\d{0,3}(?:\.\d{0,4})?$
occupancyApplicationMode
enum<string>

Controls how occupancy percent is applied to usage data. ALL applies to all data on this site regardless of account settings. PER_ACCOUNT applies only to accounts with the occupancy override enabled. DISABLED means occupancy is never applied regardless of account settings. PER_CONNECTION is a deprecated alias for PER_ACCOUNT; reads still return it and writes still accept it.

  • DISABLED - Disabled
  • ALL - All
  • PER_ACCOUNT - Per Account
  • PER_CONNECTION - Per Connection (deprecated alias for Per Account)
Available options:
DISABLED,
ALL,
PER_ACCOUNT,
PER_CONNECTION
dummySiteReason
string | null

If set, this site is a placeholder and a street address is not required. The value describes why (for example API testing, a catch-all, or a multi-address bundle). Omit or null for a regular site. Clearing it on update requires a confirmed street address.