Amendment Documents

Update an amendment document

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

Request

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

Path parameters

lease_idstring uuid required
amendment_idstring uuid required
document_idstring uuid required

Request body

document_type'DRAFT' | 'SIGNED_COPY' | 'SUPPORTING_DOCUMENT' | 'NOTICE' | 'CALCULATION_DETAILS' | 'LEGAL_NOTICE'
file_pathstring
notesstring nullable

Response

Document updated

idstring uuid required
amendment_idstring uuid required
document_type'DRAFT' | 'SIGNED_COPY' | 'SUPPORTING_DOCUMENT' | 'NOTICE' | 'CALCULATION_DETAILS' | 'LEGAL_NOTICE' required

Type of document

file_pathstring required

Path to the stored document (e.g., /api/media/serve/{media_id})

upload_datestring date-time required
is_validatedboolean required

Whether the document has been validated

validation_datestring date-time nullable
validated_bystring uuid nullable
notesstring nullable

Example response

{
  "document_type": "DRAFT"
}

Changes

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