YourNextHome
API ReferenceEstate

Create estate

POST
/api/v1/estate

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/estate" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "id": "string",
  "name": "string",
  "description": "string",
  "organizationId": "string",
  "slug": "string",
  "photoUrl": "string",
  "navigatorId": "string",
  "organization": {
    "id": "string",
    "name": "string",
    "featureFlags": [
      "estates"
    ]
  },
  "buildings": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "features": [
        {
          "name": "string",
          "description": "string",
          "type": "parking"
        }
      ],
      "source": "string"
    }
  ],
  "integrationType": "VOX_DEVELOPER",
  "isPreview": true,
  "subscriptionStatus": "DRAFT",
  "manuallyActivatedAt": "string",
  "manuallyActivatedById": "string",
  "createdAt": "2019-08-24T14:15:22Z"
}