POST /v1/properties
Create a new property
Creates a new property for the company. Checks subscription limits for maximum properties allowed.
Request
POST /v1/properties
Parameters
[]
Response
{
"201": {
"description": "Property created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"property": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"company_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"address": {
"type": [
"string",
"null"
]
},
"latitude": {
"type": [
"number",
"null"
]
},
"longitude": {
"type": [
"number",
"null"
]
},
"property_type": {
"type": "string"
},
"timezone": {
"type": "string"
},
"currency": {
"type": "string"
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"amenities": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"company_id",
"name",
"description",
"address",
"latitude",
"longitude",
"property_type",
"timezone",
"currency",
"images",
"amenities",
"created_at",
"updated_at"
]
}
},
"required": [
"property"
]
}
},
"required": [
"success",
"data"
]
}
}
}
},
"403": {
"description": "Property limit exceeded for current subscription"
}
}
View in Interactive API Reference