Leases

Update lease document

Update the metadata of a lease document

put/leases/{lease_id}/documents/{document_id}

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/documents/{document_id}
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

document_idstring uuid required

Document ID

Request body

lease_idstring uuid

Ignoré : le bail retenu est celui du path. Le champ reste accepté pour les clients qui l'envoient encore, mais il est facultatif et sans effet.

document_typestring nullable required

Document type

file_pathstring nullable

File path

descriptionstring nullable

Document description

Response

Document updated successfully

idstring uuid required

Unique identifier of the document

lease_idstring uuid required

Lease ID

document_typestring required

Document type

file_pathstring required

File path

descriptionstring nullable

Document description

created_atstring date-time required

Creation date

updated_atstring date-time required

Last modification date

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_id": "550e8400-e29b-41d4-a716-446655440001",
  "document_type": "CONTRACT",
  "file_path": "/documents/leases/2024/lease-001.pdf",
  "description": "Lease contract signed by both parties",
  "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.