Properties
Create property
Requires scope: property:create
POST
/
projects
/
{id}
/
properties
Create property
curl --request POST \
--url https://app.deal-pipe.de/api/v1/projects/{id}/properties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"unitIdentifier": "<string>",
"street": "<string>",
"houseNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"unitNumber": "<string>",
"zimmer": 123,
"wohnflaecheQm": 123,
"kaufpreis": 123,
"kaltmieteWohnung": 123,
"baujahr": 123,
"unitLocation": "<string>",
"etageLabel": "<string>",
"etage": 123
}
'import requests
url = "https://app.deal-pipe.de/api/v1/projects/{id}/properties"
payload = {
"unitIdentifier": "<string>",
"street": "<string>",
"houseNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"unitNumber": "<string>",
"zimmer": 123,
"wohnflaecheQm": 123,
"kaufpreis": 123,
"kaltmieteWohnung": 123,
"baujahr": 123,
"unitLocation": "<string>",
"etageLabel": "<string>",
"etage": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
unitIdentifier: '<string>',
street: '<string>',
houseNumber: '<string>',
postalCode: '<string>',
city: '<string>',
unitNumber: '<string>',
zimmer: 123,
wohnflaecheQm: 123,
kaufpreis: 123,
kaltmieteWohnung: 123,
baujahr: 123,
unitLocation: '<string>',
etageLabel: '<string>',
etage: 123
})
};
fetch('https://app.deal-pipe.de/api/v1/projects/{id}/properties', 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://app.deal-pipe.de/api/v1/projects/{id}/properties",
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([
'unitIdentifier' => '<string>',
'street' => '<string>',
'houseNumber' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'unitNumber' => '<string>',
'zimmer' => 123,
'wohnflaecheQm' => 123,
'kaufpreis' => 123,
'kaltmieteWohnung' => 123,
'baujahr' => 123,
'unitLocation' => '<string>',
'etageLabel' => '<string>',
'etage' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.deal-pipe.de/api/v1/projects/{id}/properties"
payload := strings.NewReader("{\n \"unitIdentifier\": \"<string>\",\n \"street\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"zimmer\": 123,\n \"wohnflaecheQm\": 123,\n \"kaufpreis\": 123,\n \"kaltmieteWohnung\": 123,\n \"baujahr\": 123,\n \"unitLocation\": \"<string>\",\n \"etageLabel\": \"<string>\",\n \"etage\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.deal-pipe.de/api/v1/projects/{id}/properties")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"unitIdentifier\": \"<string>\",\n \"street\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"zimmer\": 123,\n \"wohnflaecheQm\": 123,\n \"kaufpreis\": 123,\n \"kaltmieteWohnung\": 123,\n \"baujahr\": 123,\n \"unitLocation\": \"<string>\",\n \"etageLabel\": \"<string>\",\n \"etage\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.deal-pipe.de/api/v1/projects/{id}/properties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"unitIdentifier\": \"<string>\",\n \"street\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"zimmer\": 123,\n \"wohnflaecheQm\": 123,\n \"kaufpreis\": 123,\n \"kaltmieteWohnung\": 123,\n \"baujahr\": 123,\n \"unitLocation\": \"<string>\",\n \"etageLabel\": \"<string>\",\n \"etage\": 123\n}"
response = http.request(request)
puts response.read_body{
"property": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalSourceId": "<string>",
"unitIdentifier": "<string>",
"unitNumber": "<string>",
"street": "<string>",
"houseNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"latitude": "<string>",
"longitude": "<string>",
"etage": 123,
"zimmer": "<string>",
"wohnflaecheQm": "<string>",
"nutzflaecheQm": "<string>",
"baujahr": 123,
"status": "frei",
"visibility": "online",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"kaufpreis": "<string>",
"kaufpreisStellplatz": "<string>",
"kaltmieteWohnung": "<string>",
"kaltmieteStellplatz": "<string>",
"hausgeldGesamt": "<string>",
"hausgeldNichtUmlagefaehig": "<string>",
"kaufpreisPerQm": "<string>",
"kaltmietePerQm": "<string>",
"bruttorendite": "<string>",
"bauzustand": "<string>",
"anlageklasse": "<string>",
"mietstatus": "<string>",
"vermietetSeit": "<string>",
"energieeffizienzklasse": "<string>",
"energieausweistyp": "<string>",
"energieverbrauch": "<string>",
"heizungsart": "<string>",
"isDenkmal": true,
"isErbbaupacht": true,
"videoUrl": "<string>",
"virtualTourUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"images": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "<string>",
"fileName": "<string>",
"sortOrder": 123,
"url": "<string>",
"thumbnailUrl": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Pattern:
^[0-9]*$Floor label, e.g. UG, EG, OG, DG or a numeric floor.
Available options:
online, offline, pending_review Available options:
frei, auf_anfrage, reserviert, notarvorbereitung, notartermin, verkauft Response
Created
Monetary and area values are decimal strings (e.g. "320000.00") so no precision is lost in JSON. Fields absent from this schema are internal and are never returned.
Show child attributes
Show child attributes
⌘I
Create property
curl --request POST \
--url https://app.deal-pipe.de/api/v1/projects/{id}/properties \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"unitIdentifier": "<string>",
"street": "<string>",
"houseNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"unitNumber": "<string>",
"zimmer": 123,
"wohnflaecheQm": 123,
"kaufpreis": 123,
"kaltmieteWohnung": 123,
"baujahr": 123,
"unitLocation": "<string>",
"etageLabel": "<string>",
"etage": 123
}
'import requests
url = "https://app.deal-pipe.de/api/v1/projects/{id}/properties"
payload = {
"unitIdentifier": "<string>",
"street": "<string>",
"houseNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"unitNumber": "<string>",
"zimmer": 123,
"wohnflaecheQm": 123,
"kaufpreis": 123,
"kaltmieteWohnung": 123,
"baujahr": 123,
"unitLocation": "<string>",
"etageLabel": "<string>",
"etage": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
unitIdentifier: '<string>',
street: '<string>',
houseNumber: '<string>',
postalCode: '<string>',
city: '<string>',
unitNumber: '<string>',
zimmer: 123,
wohnflaecheQm: 123,
kaufpreis: 123,
kaltmieteWohnung: 123,
baujahr: 123,
unitLocation: '<string>',
etageLabel: '<string>',
etage: 123
})
};
fetch('https://app.deal-pipe.de/api/v1/projects/{id}/properties', 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://app.deal-pipe.de/api/v1/projects/{id}/properties",
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([
'unitIdentifier' => '<string>',
'street' => '<string>',
'houseNumber' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'unitNumber' => '<string>',
'zimmer' => 123,
'wohnflaecheQm' => 123,
'kaufpreis' => 123,
'kaltmieteWohnung' => 123,
'baujahr' => 123,
'unitLocation' => '<string>',
'etageLabel' => '<string>',
'etage' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.deal-pipe.de/api/v1/projects/{id}/properties"
payload := strings.NewReader("{\n \"unitIdentifier\": \"<string>\",\n \"street\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"zimmer\": 123,\n \"wohnflaecheQm\": 123,\n \"kaufpreis\": 123,\n \"kaltmieteWohnung\": 123,\n \"baujahr\": 123,\n \"unitLocation\": \"<string>\",\n \"etageLabel\": \"<string>\",\n \"etage\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.deal-pipe.de/api/v1/projects/{id}/properties")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"unitIdentifier\": \"<string>\",\n \"street\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"zimmer\": 123,\n \"wohnflaecheQm\": 123,\n \"kaufpreis\": 123,\n \"kaltmieteWohnung\": 123,\n \"baujahr\": 123,\n \"unitLocation\": \"<string>\",\n \"etageLabel\": \"<string>\",\n \"etage\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.deal-pipe.de/api/v1/projects/{id}/properties")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"unitIdentifier\": \"<string>\",\n \"street\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"zimmer\": 123,\n \"wohnflaecheQm\": 123,\n \"kaufpreis\": 123,\n \"kaltmieteWohnung\": 123,\n \"baujahr\": 123,\n \"unitLocation\": \"<string>\",\n \"etageLabel\": \"<string>\",\n \"etage\": 123\n}"
response = http.request(request)
puts response.read_body{
"property": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalSourceId": "<string>",
"unitIdentifier": "<string>",
"unitNumber": "<string>",
"street": "<string>",
"houseNumber": "<string>",
"postalCode": "<string>",
"city": "<string>",
"latitude": "<string>",
"longitude": "<string>",
"etage": 123,
"zimmer": "<string>",
"wohnflaecheQm": "<string>",
"nutzflaecheQm": "<string>",
"baujahr": 123,
"status": "frei",
"visibility": "online",
"archived": true,
"archivedAt": "2023-11-07T05:31:56Z",
"kaufpreis": "<string>",
"kaufpreisStellplatz": "<string>",
"kaltmieteWohnung": "<string>",
"kaltmieteStellplatz": "<string>",
"hausgeldGesamt": "<string>",
"hausgeldNichtUmlagefaehig": "<string>",
"kaufpreisPerQm": "<string>",
"kaltmietePerQm": "<string>",
"bruttorendite": "<string>",
"bauzustand": "<string>",
"anlageklasse": "<string>",
"mietstatus": "<string>",
"vermietetSeit": "<string>",
"energieeffizienzklasse": "<string>",
"energieausweistyp": "<string>",
"energieverbrauch": "<string>",
"heizungsart": "<string>",
"isDenkmal": true,
"isErbbaupacht": true,
"videoUrl": "<string>",
"virtualTourUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"images": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "<string>",
"fileName": "<string>",
"sortOrder": 123,
"url": "<string>",
"thumbnailUrl": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}
}