Create Site

post

https://api.arcadia.com/plug/sites

This endpoint allows you to create a new site in the Arcadia system. A site object allows you to group credentials, accounts, meters, and statements by a location or another logical grouping for your system.

This endpoint supports Sandbox Mode.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

area

int32 | null

≥ 1

The area of the Site in square feet.

buildingType

string | null

enum

The type of building.

buildingTypeGroup

string | null

enum

The group of building types.

city

string

The city associated with the billing address.

country

string

The country associated with the billing address.

facilityType

string

deprecated

Custom field for you to input site’s facility type. Deprecated in favor of buildingType.

heatingFuel

string | null

enum

The type of heating fuel used in the Site.

Allowed:

hvacCoolType

string | null

enum

The type of cooling system in the Site.

Allowed:

hvacHeatType

string | null

enum

The type of heating system in the Site.

Allowed:

hvacVentType

string | null

enum

The type of ventilation system in the Site.

Allowed:

isLocationRecommendationIgnored

boolean

Indicates if a site has been opted out of address verification.

meterIds

array of strings

An array of unique identifiers for multiple meters.

meterIds

numberOfStories

int32 | null

≥ 1

The number of stories of the Site.

postalCode

string

The postal code or ZIP code associated with the address of the account.

recipient

string

deprecated

The recipient for the address. Deprecated because recipient is not useful for sites.

region

string

The region or geographic area associated with the Site.

siteCode

string

A code or identifier assigned to a specific site.

siteName

string

required

The name or label assigned to a specific Site.

siteNumber

string

The number or identifier assigned to a specific Site.

state

string

The state or province associated with the billing address of the account.

streetLine1

string

The first line of the street address.

streetLine2

string

The second line of the street address.

subRegion

string

A subregion or subdivision within a larger region, such as a county or district.

yearBuilt

int32 | null

≥ 1

The year the Site was built, ranging from 1 to the current year plus 10.

Headers

Arcadia-Version

string

required

Defaults to 2024-02-21

The Arcadia-Version for the request

string

enum

Defaults to application/hal+json

Generated from available response content types

Allowed:

Response

200OK