Create a property
POST
https://secure.alterestate.com/api/v1/properties/create/Creates a property in your agency’s inventory.
Authentication
Send Authorization: Token your_api_key_here. Account token. Keep it on your server.
Body parameters
| Field | Type | Description |
|---|---|---|
namerequired | string | Public property name. Example: Modern apartment in Naco. |
categoryrequired | number | Category ID. See List properties. Example: 1. |
listing_typerequired | number | 1 for sale, 2 for rent. Example: 1. |
sale_price | number | Sale price. Example: 185000. |
currency_sale | string | Sale price currency. Example: USD. |
city | number | City ID. Example: 156. |
sector | number | Sector ID. Example: 2234. |
room | number | Bedrooms. Example: 2. |
bathroom | number | Bathrooms. Example: 2. |
parkinglot | number | Parking spaces. Example: 1. |
property_area | number | Built area. Example: 110. |
description | string | Long description. Stored text may be rendered as HTML later, so send plain text or HTML you trust. Example: Bright apartment with a balcony.. |
Example request
POST
curl --request POST \
--url 'https://secure.alterestate.com/api/v1/properties/create/' \
--header 'Authorization: Token your_api_key_here' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "Modern apartment in Naco",
"category": 1,
"listing_type": 1,
"sale_price": 185000,
"currency_sale": "USD",
"city": 156,
"sector": 2234,
"room": 2,
"bathroom": 2,
"parkinglot": 1,
"property_area": 110,
"description": "Bright apartment with a balcony."
}'Example response
201 Created
{
"uid": "JSORJ9S5AY",
"cid": 292960,
"slug": "modern-apartment-in-naco-292960",
"name": "Modern apartment in Naco",
"sale_price": 185000,
"currency_sale": "USD"
}400 Bad Request
{
"name": [
"This field is required."
]
}Last updated . Questions? Emailengineering@alterestate.com.