Skip to main content
POST
/
api
/
partners
/
v2.0
/
org
/
{org_id}
/
users
/
{user_id}
/
buildings
Register a building for a user
curl --request POST \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/buildings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "property_type": "Detached",
  "occupant_type": "Students",
  "space_heating": "Gas boiler",
  "water_heating": "Gas boiler",
  "property_size_m2": 123,
  "property_age": 123,
  "num_occupants": 123,
  "photovoltaic": false,
  "street_and_number": "<string>",
  "street_add_info": "<string>",
  "zip_code": "<string>",
  "town": "<string>",
  "country": "<string>"
}
'
{
  "name": "<string>",
  "property_type": "<string>",
  "property_size_m2": 123,
  "property_age": 123,
  "num_occupants": 123,
  "occupant_type": "<string>",
  "space_heating": "<string>",
  "water_heating": "<string>",
  "photovoltaic": false,
  "street_and_number": "<string>",
  "street_add_info": "<string>",
  "zip_code": "<string>",
  "town": "<string>",
  "country": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
org_id
string<uuid>
required

The organization ID of the user's organization

​
user_id
string<uuid>
required

The user ID of the user whom the building belongs to

Body

application/json
​
name
string
required
Maximum string length: 100
​
property_type
enum<string> | null
Available options:
Detached,
Semi-detached,
Bungalow,
Terraced,
End-terrace,
Flat
​
occupant_type
enum<string> | null
Available options:
Students,
Working adults,
At home adults,
Young family,
Older family,
Retirees
​
space_heating
enum<string> | null
Available options:
Gas boiler,
Electric storage,
Electric heaters,
Heat pump,
Oil boiler,
Solar,
Other,
Hybrid heat pump,
District heating,
Wood pellet
​
water_heating
enum<string> | null
Available options:
Gas boiler,
Electric,
Oil boiler,
Solar,
Heat pump,
Other
​
property_size_m2
integer | null
​
property_age
integer | null
​
num_occupants
integer | null
​
photovoltaic
boolean | null
default:false
​
street_and_number
string | null
Maximum string length: 100
​
street_add_info
string | null
Maximum string length: 100
​
zip_code
string | null
Maximum string length: 20
​
town
string | null
Maximum string length: 100
​
country
string | null
Maximum string length: 2

Response

200 - application/json

OK

​
name
string
required
Maximum string length: 100
​
property_type
string | null
Maximum string length: 50
​
property_size_m2
integer | null
​
property_age
integer | null
​
num_occupants
integer | null
​
occupant_type
string | null
Maximum string length: 50
​
space_heating
string | null
Maximum string length: 50
​
water_heating
string | null
Maximum string length: 50
​
photovoltaic
boolean | null
default:false
​
street_and_number
string | null
Maximum string length: 100
​
street_add_info
string | null
Maximum string length: 100
​
zip_code
string | null
Maximum string length: 20
​
town
string | null
Maximum string length: 100
​
country
string | null
Maximum string length: 2
​
id
string<uuid> | null