Amendment Notifications

Update notification status

Update the status of an amendment notification (e.g., mark as read or actioned). Status transitions automatically set the corresponding timestamp (sent_date, read_date, actioned_date).

put/leases/{lease_id}/amendments/{amendment_id}/notifications/{notification_id}

Request

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

Path parameters

lease_idstring uuid required
amendment_idstring uuid required
notification_idstring uuid required

Request body

status'SENT' | 'READ' | 'ACTIONED' | 'EXPIRED' required

Response

Notification updated

idstring uuid required
amendment_idstring uuid required
lease_idstring uuid required
notification_type'SIGNATURE_REQUIRED' | 'AMENDMENT_ACTIVATED' | 'AMENDMENT_EXPIRING' | 'AMENDMENT_REJECTED' | 'VALIDATION_PENDING' | 'RENT_MODIFICATION_NOTICE' required

Type of notification. VALIDATION_PENDING and RENT_MODIFICATION_NOTICE are reserved for future use.

status'DRAFT' | 'SENT' | 'READ' | 'ACTIONED' | 'EXPIRED' required
titlestring required
contentobject nullable
recipient_type'OWNER' | 'LESSEE' | 'VALIDATOR' | 'CREATOR' required
recipient_idstring uuid required
sent_datestring date-time nullable
read_datestring date-time nullable
actioned_datestring date-time nullable
expires_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time required

Changes

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