Types

Create a new property type

Creates a new property type in the system. This operation requires write permissions on properties.

post/types/estates

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/types/estates
  • Auth: HTTP bearer

Request body

namestring required

Name of the property type to create

Example request

{
  "name": "Furnished studio"
}

Response

Property type created successfully

idstring uuid nullable required

Unique identifier of the property type

namestring nullable required

Property type name

created_atstring date-time nullable required

Creation date and time

updated_atstring date-time nullable required

Last modification date and time

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "3-bedroom apartment",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.