Types

Create a new room type

Creates a new room type in the system. This operation requires write permissions on properties. The counts_towards_habitable field determines whether the room counts toward the habitable area according to the Carrez Law.

post/types/rooms

Request

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

Request body

namestring required

Name of the room type to create

counts_towards_habitableboolean required

Indicates whether this room counts toward the habitable area (Carrez law)

Example request

{
  "name": "Office",
  "counts_towards_habitable": true
}

Response

Room type created successfully

idstring uuid nullable required

Unique identifier of the room type

namestring nullable required

Room type name

counts_towards_habitableboolean nullable required

Indicates whether this room counts toward the habitable area (Carrez law)

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-446655440002",
  "name": "Living room",
  "counts_towards_habitable": true,
  "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.