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>"
  }
}'
{
  "tenancyId": "<string>",
  "leaseId": "<string>"
}

​
Params

​
purpose
string
required
The purpose of the lease (e.g., “key:residential”)
​
address
object
required
The address details of the tenancy

​
Response

​
tenancyId
string
The unique identifier for the created tenancy
​
leaseId
string
The unique identifier for the draft lease created for the tenancy