Lease Types

Create a new lease type

Create a new lease type with the provided parameters

post/lease-types

Request

Base URL: https://api.faireplace.com/api
URL: https://api.faireplace.com/api/lease-types
Auth: HTTP bearer

Request body

country_idstring uuid required

Country ID (ISO jurisdiction reference)

namestring required

Lease type name

descriptionstring nullable

Lease type description

is_furnishedboolean required

Indicates whether the lease is furnished

Example request

{
  "country_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Furnished lease 3 years",
  "description": "Furnished lease for a duration of 3 years with annual revision",
  "is_furnished": true
}

Response

Lease type created successfully

idstring uuid required

Unique identifier of the lease type

country_idstring uuid required

Country ID (ISO jurisdiction reference)

namestring required

Lease type name

descriptionstring nullable

Lease type description

is_furnishedboolean required

Indicates whether the lease is furnished

created_atstring date-time required

Creation date

updated_atstring date-time required

Last modification date

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "country_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Furnished lease 3 years",
  "description": "Furnished lease for a duration of 3 years with annual revision",
  "is_furnished": 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.