Buildings
Create a building
POST
/
v1
/
buildings
Create a building
curl --request POST \
--url https://api.yorlet.com/v1/buildings \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"currency": "gbp",
"name": "<string>",
"active": true,
"description": "<string>",
"marketing": {
"featured_photo": "<string>",
"photos": [
"<string>"
]
},
"metadata": {},
"single_unit": true,
"viewings_availability": {},
"viewings_require_confirmation": true
}
'import requests
url = "https://api.yorlet.com/v1/buildings"
payload = {
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"currency": "gbp",
"name": "<string>",
"active": True,
"description": "<string>",
"marketing": {
"featured_photo": "<string>",
"photos": ["<string>"]
},
"metadata": {},
"single_unit": True,
"viewings_availability": {},
"viewings_require_confirmation": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
postal_code: '<string>',
state: '<string>'
},
currency: 'gbp',
name: '<string>',
active: true,
description: '<string>',
marketing: {featured_photo: '<string>', photos: ['<string>']},
metadata: {},
single_unit: true,
viewings_availability: {},
viewings_require_confirmation: true
})
};
fetch('https://api.yorlet.com/v1/buildings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/buildings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'postal_code' => '<string>',
'state' => '<string>'
],
'currency' => 'gbp',
'name' => '<string>',
'active' => true,
'description' => '<string>',
'marketing' => [
'featured_photo' => '<string>',
'photos' => [
'<string>'
]
],
'metadata' => [
],
'single_unit' => true,
'viewings_availability' => [
],
'viewings_require_confirmation' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/buildings"
payload := strings.NewReader("{\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"currency\": \"gbp\",\n \"name\": \"<string>\",\n \"active\": true,\n \"description\": \"<string>\",\n \"marketing\": {\n \"featured_photo\": \"<string>\",\n \"photos\": [\n \"<string>\"\n ]\n },\n \"metadata\": {},\n \"single_unit\": true,\n \"viewings_availability\": {},\n \"viewings_require_confirmation\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/buildings")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"currency\": \"gbp\",\n \"name\": \"<string>\",\n \"active\": true,\n \"description\": \"<string>\",\n \"marketing\": {\n \"featured_photo\": \"<string>\",\n \"photos\": [\n \"<string>\"\n ]\n },\n \"metadata\": {},\n \"single_unit\": true,\n \"viewings_availability\": {},\n \"viewings_require_confirmation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/buildings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"currency\": \"gbp\",\n \"name\": \"<string>\",\n \"active\": true,\n \"description\": \"<string>\",\n \"marketing\": {\n \"featured_photo\": \"<string>\",\n \"photos\": [\n \"<string>\"\n ]\n },\n \"metadata\": {},\n \"single_unit\": true,\n \"viewings_availability\": {},\n \"viewings_require_confirmation\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "building",
"active": true,
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"currency": "<string>",
"description": "<string>",
"marketing": {
"featured_photo": "<string>",
"photos": [
"<string>"
]
},
"name": "<string>",
"removable": true,
"single_unit": true,
"type": "block_management",
"unit_fees": {
"management_fee": 123,
"management_fee_amount": 123,
"management_fee_discount": {
"percent_off": 123,
"end": 123
},
"management_fee_type": "percentage",
"renewal_fee": 123,
"rent_review_fee": 123,
"tax": 123,
"tax_behavior": "exclusive",
"tenant_find_fee": 123,
"updated_at": 123
},
"viewing_booking_url": "<string>",
"viewings_availability": {},
"viewings_require_confirmation": true,
"account": "<string>",
"deleted": false,
"metadata": {}
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
application/json
The physical address of the building.
Show child attributes
Show child attributes
Three-letter ISO currency code, in lowercase. Must be a supported currency.
Available options:
gbp, usd, eur, sek Example:
"gbp"
The name of the building.
Whether the building is currently active.
An arbitrary description attached to the building.
Marketing details displayed for the building.
Show child attributes
Show child attributes
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Show child attributes
Show child attributes
Whether the building is treated as a single unit.
The type of the building.
Available options:
block_management, commercial, residential, student Default fees applied to units in this building.
Show child attributes
Show child attributes
Weekly viewing hours for this building. Omit to leave unchanged. null inherits the account viewing calendar.
Show child attributes
Show child attributes
Whether bookings from this building's public viewing link need confirmation. Omit to leave unchanged. null inherits the account setting.
Response
200 - application/json
Returns the task object if the request succeeded.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
Available options:
building Whether the building is currently active.
The physical address of the building.
Show child attributes
Show child attributes
The default currency used for the building.
An arbitrary description attached to the building.
Marketing details displayed for the building.
Show child attributes
Show child attributes
The name of the building.
Whether the building can be deleted.
Whether the building is treated as a single unit.
The type of the building.
Available options:
block_management, commercial, residential, student, null Default fees applied to units in this building.
Show child attributes
Show child attributes
The public URL a lead can use to book a viewing at this building. Present once a booking link has been minted.
Weekly viewing hours for this building. null inherits the account viewing calendar. An empty object means the building offers no self-serve slots.
Show child attributes
Show child attributes
Whether bookings from this building's public viewing link need a team member to confirm them. null inherits the account setting.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Show child attributes
Show child attributes
Was this page helpful?
Create a building
curl --request POST \
--url https://api.yorlet.com/v1/buildings \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"currency": "gbp",
"name": "<string>",
"active": true,
"description": "<string>",
"marketing": {
"featured_photo": "<string>",
"photos": [
"<string>"
]
},
"metadata": {},
"single_unit": true,
"viewings_availability": {},
"viewings_require_confirmation": true
}
'import requests
url = "https://api.yorlet.com/v1/buildings"
payload = {
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"currency": "gbp",
"name": "<string>",
"active": True,
"description": "<string>",
"marketing": {
"featured_photo": "<string>",
"photos": ["<string>"]
},
"metadata": {},
"single_unit": True,
"viewings_availability": {},
"viewings_require_confirmation": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
postal_code: '<string>',
state: '<string>'
},
currency: 'gbp',
name: '<string>',
active: true,
description: '<string>',
marketing: {featured_photo: '<string>', photos: ['<string>']},
metadata: {},
single_unit: true,
viewings_availability: {},
viewings_require_confirmation: true
})
};
fetch('https://api.yorlet.com/v1/buildings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/buildings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'postal_code' => '<string>',
'state' => '<string>'
],
'currency' => 'gbp',
'name' => '<string>',
'active' => true,
'description' => '<string>',
'marketing' => [
'featured_photo' => '<string>',
'photos' => [
'<string>'
]
],
'metadata' => [
],
'single_unit' => true,
'viewings_availability' => [
],
'viewings_require_confirmation' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/buildings"
payload := strings.NewReader("{\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"currency\": \"gbp\",\n \"name\": \"<string>\",\n \"active\": true,\n \"description\": \"<string>\",\n \"marketing\": {\n \"featured_photo\": \"<string>\",\n \"photos\": [\n \"<string>\"\n ]\n },\n \"metadata\": {},\n \"single_unit\": true,\n \"viewings_availability\": {},\n \"viewings_require_confirmation\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/buildings")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"currency\": \"gbp\",\n \"name\": \"<string>\",\n \"active\": true,\n \"description\": \"<string>\",\n \"marketing\": {\n \"featured_photo\": \"<string>\",\n \"photos\": [\n \"<string>\"\n ]\n },\n \"metadata\": {},\n \"single_unit\": true,\n \"viewings_availability\": {},\n \"viewings_require_confirmation\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/buildings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"state\": \"<string>\"\n },\n \"currency\": \"gbp\",\n \"name\": \"<string>\",\n \"active\": true,\n \"description\": \"<string>\",\n \"marketing\": {\n \"featured_photo\": \"<string>\",\n \"photos\": [\n \"<string>\"\n ]\n },\n \"metadata\": {},\n \"single_unit\": true,\n \"viewings_availability\": {},\n \"viewings_require_confirmation\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "building",
"active": true,
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"country": "<string>",
"postal_code": "<string>",
"state": "<string>"
},
"currency": "<string>",
"description": "<string>",
"marketing": {
"featured_photo": "<string>",
"photos": [
"<string>"
]
},
"name": "<string>",
"removable": true,
"single_unit": true,
"type": "block_management",
"unit_fees": {
"management_fee": 123,
"management_fee_amount": 123,
"management_fee_discount": {
"percent_off": 123,
"end": 123
},
"management_fee_type": "percentage",
"renewal_fee": 123,
"rent_review_fee": 123,
"tax": 123,
"tax_behavior": "exclusive",
"tenant_find_fee": 123,
"updated_at": 123
},
"viewing_booking_url": "<string>",
"viewings_availability": {},
"viewings_require_confirmation": true,
"account": "<string>",
"deleted": false,
"metadata": {}
}