Creates a tenancy
curl --request POST \
--url https://api.helloproper.com/tenancies \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"purpose": "<string>",
"address": {
"streetName": "<string>",
"streetNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"country": "<string>",
"floor": "<string>",
"door": "<string>",
"subdivision": "<string>",
"co": "<string>"
}
}
'import requests
url = "https://api.helloproper.com/tenancies"
payload = {
"purpose": "<string>",
"address": {
"streetName": "<string>",
"streetNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"country": "<string>",
"floor": "<string>",
"door": "<string>",
"subdivision": "<string>",
"co": "<string>"
}
}
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({
purpose: '<string>',
address: {
streetName: '<string>',
streetNumber: '<string>',
postalCode: '<string>',
city: '<string>',
country: '<string>',
floor: '<string>',
door: '<string>',
subdivision: '<string>',
co: '<string>'
}
})
};
fetch('https://api.helloproper.com/tenancies', 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.helloproper.com/tenancies",
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([
'purpose' => '<string>',
'address' => [
'streetName' => '<string>',
'streetNumber' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'country' => '<string>',
'floor' => '<string>',
'door' => '<string>',
'subdivision' => '<string>',
'co' => '<string>'
]
]),
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.helloproper.com/tenancies"
payload := strings.NewReader("{\n \"purpose\": \"<string>\",\n \"address\": {\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"floor\": \"<string>\",\n \"door\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"co\": \"<string>\"\n }\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.helloproper.com/tenancies")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"purpose\": \"<string>\",\n \"address\": {\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"floor\": \"<string>\",\n \"door\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"co\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helloproper.com/tenancies")
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 \"purpose\": \"<string>\",\n \"address\": {\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"floor\": \"<string>\",\n \"door\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"co\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"tenancyId": "<string>",
"leaseId": "<string>"
}Tenancies
Creates a tenancy
POST
/
tenancies
Creates a tenancy
curl --request POST \
--url https://api.helloproper.com/tenancies \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"purpose": "<string>",
"address": {
"streetName": "<string>",
"streetNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"country": "<string>",
"floor": "<string>",
"door": "<string>",
"subdivision": "<string>",
"co": "<string>"
}
}
'import requests
url = "https://api.helloproper.com/tenancies"
payload = {
"purpose": "<string>",
"address": {
"streetName": "<string>",
"streetNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"country": "<string>",
"floor": "<string>",
"door": "<string>",
"subdivision": "<string>",
"co": "<string>"
}
}
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({
purpose: '<string>',
address: {
streetName: '<string>',
streetNumber: '<string>',
postalCode: '<string>',
city: '<string>',
country: '<string>',
floor: '<string>',
door: '<string>',
subdivision: '<string>',
co: '<string>'
}
})
};
fetch('https://api.helloproper.com/tenancies', 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.helloproper.com/tenancies",
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([
'purpose' => '<string>',
'address' => [
'streetName' => '<string>',
'streetNumber' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'country' => '<string>',
'floor' => '<string>',
'door' => '<string>',
'subdivision' => '<string>',
'co' => '<string>'
]
]),
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.helloproper.com/tenancies"
payload := strings.NewReader("{\n \"purpose\": \"<string>\",\n \"address\": {\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"floor\": \"<string>\",\n \"door\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"co\": \"<string>\"\n }\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.helloproper.com/tenancies")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"purpose\": \"<string>\",\n \"address\": {\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"floor\": \"<string>\",\n \"door\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"co\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.helloproper.com/tenancies")
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 \"purpose\": \"<string>\",\n \"address\": {\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\",\n \"floor\": \"<string>\",\n \"door\": \"<string>\",\n \"subdivision\": \"<string>\",\n \"co\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"tenancyId": "<string>",
"leaseId": "<string>"
}Params
The purpose of the lease (e.g., “key:residential”)
The address details of the tenancy
Show child attributes
Show child attributes
The name of the street
The number of the property on the street
The postal code for the address
The city of the address
The country code of the address
The floor of the address if applicable
The door of the address if applicable
The subdivision of the address if applicable
The c/o for the address if applicable
Response
The unique identifier for the created tenancy
The unique identifier for the draft lease created for the tenancy
⌘I