Skip to main content
POST
/
v1
/
createSite
Create a new site
curl --request POST \
  --url https://api.voltview.co.uk/v1/createSite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "address": "<string>",
  "postcode": "<string>",
  "floorArea": 123,
  "buildingType": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "address": "<string>",
  "postcode": "<string>",
  "region": "<string>",
  "floorArea": 123,
  "buildingType": "<string>",
  "meterCount": 123,
  "utilities": [
    "ELECTRICITY"
  ],
  "status": "ACTIVE"
}

Authorizations

Authorization
string
header
required

JWT token obtained from /v1/requestToken endpoint

Body

application/json
name
string
required

Name of the site

address
string

Site address

postcode
string

Site postcode

floorArea
number

Floor area in square meters

buildingType
string

Type of building

Response

Site created successfully

id
string
required

Site identifier

name
string
required

Site name

address
string
required

Site address

postcode
string

Site postcode

region
string

Geographic region

floorArea
number

Floor area in square meters

buildingType
string

Type of building

meterCount
integer

Number of meters at the site

utilities
enum<string>[]

Utilities available at the site

Available options:
ELECTRICITY,
GAS,
WATER
status
enum<string>

Site status

Available options:
ACTIVE,
INACTIVE