FairePlace Property Management API

Amendment Notifications

Endpointhttps://api.faireplace.com/api

List notifications for an amendment

GET

https://api.faireplace.com/api

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

Returns all notifications associated with a specific amendment.

List notifications for an amendment › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

List notifications for an amendment › Responses

List of notifications

object[]

id

string · uuid · required

amendment_id

string · uuid · required

lease_id

string · uuid · required

notification_type

string · enum · required

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

Enum values:

SIGNATURE_REQUIRED

AMENDMENT_ACTIVATED

AMENDMENT_EXPIRING

AMENDMENT_REJECTED

VALIDATION_PENDING

RENT_MODIFICATION_NOTICE

status

string · enum · required

Enum values:

DRAFT

SENT

READ

ACTIONED

EXPIRED

title

string · required

recipient_type

string · enum · required

Enum values:

OWNER

LESSEE

VALIDATOR

CREATOR

recipient_id

string · uuid · required

created_at

string · date-time · required

updated_at

string · date-time · required

content

object | null

sent_date

string | null · date-time

read_date

string | null · date-time

actioned_date

string | null · date-time

expires_at

string | null · date-time

GET/leases/{lease_id}/amendments/{amendment_id}/notifications

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/notifications

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "amendment_id": "00000000-0000-0000-0000-000000000000",
    "lease_id": "00000000-0000-0000-0000-000000000000",
    "notification_type": "SIGNATURE_REQUIRED",
    "status": "DRAFT",
    "title": "title",
    "content": {},
    "recipient_type": "OWNER",
    "recipient_id": "00000000-0000-0000-0000-000000000000",
    "sent_date": "2024-08-25T15:00:00Z",
    "read_date": "2024-08-25T15:00:00Z",
    "actioned_date": "2024-08-25T15:00:00Z",
    "expires_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Get a specific notification

GET

https://api.faireplace.com/api

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

Returns details of a single amendment notification.

Get a specific notification › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

notification_id

string · uuid · required

Get a specific notification › Responses

Notification details

id

string · uuid · required

amendment_id

string · uuid · required

lease_id

string · uuid · required

notification_type

string · enum · required

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

Enum values:

SIGNATURE_REQUIRED

AMENDMENT_ACTIVATED

AMENDMENT_EXPIRING

AMENDMENT_REJECTED

VALIDATION_PENDING

RENT_MODIFICATION_NOTICE

status

string · enum · required

Enum values:

DRAFT

SENT

READ

ACTIONED

EXPIRED

title

string · required

recipient_type

string · enum · required

Enum values:

OWNER

LESSEE

VALIDATOR

CREATOR

recipient_id

string · uuid · required

created_at

string · date-time · required

updated_at

string · date-time · required

content

object | null

sent_date

string | null · date-time

read_date

string | null · date-time

actioned_date

string | null · date-time

expires_at

string | null · date-time

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

curl --request GET \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/notifications/:notification_id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "amendment_id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notification_type": "SIGNATURE_REQUIRED",
  "status": "DRAFT",
  "title": "title",
  "content": {},
  "recipient_type": "OWNER",
  "recipient_id": "00000000-0000-0000-0000-000000000000",
  "sent_date": "2024-08-25T15:00:00Z",
  "read_date": "2024-08-25T15:00:00Z",
  "actioned_date": "2024-08-25T15:00:00Z",
  "expires_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update notification status

PUT

https://api.faireplace.com/api

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

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).

Update notification status › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

notification_id

string · uuid · required

Update notification status › Request Body

status

string · enum · required

Enum values:

SENT

READ

ACTIONED

EXPIRED

Update notification status › Responses

Notification updated

id

string · uuid · required

amendment_id

string · uuid · required

lease_id

string · uuid · required

notification_type

string · enum · required

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

Enum values:

SIGNATURE_REQUIRED

AMENDMENT_ACTIVATED

AMENDMENT_EXPIRING

AMENDMENT_REJECTED

VALIDATION_PENDING

RENT_MODIFICATION_NOTICE

status

string · enum · required

Enum values:

DRAFT

SENT

READ

ACTIONED

EXPIRED

title

string · required

recipient_type

string · enum · required

Enum values:

OWNER

LESSEE

VALIDATOR

CREATOR

recipient_id

string · uuid · required

created_at

string · date-time · required

updated_at

string · date-time · required

content

object | null

sent_date

string | null · date-time

read_date

string | null · date-time

actioned_date

string | null · date-time

expires_at

string | null · date-time

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

curl --request PUT \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/notifications/:notification_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "SENT"
}
'

shell

Example Request Body

{
  "status": "SENT"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "amendment_id": "00000000-0000-0000-0000-000000000000",
  "lease_id": "00000000-0000-0000-0000-000000000000",
  "notification_type": "SIGNATURE_REQUIRED",
  "status": "DRAFT",
  "title": "title",
  "content": {},
  "recipient_type": "OWNER",
  "recipient_id": "00000000-0000-0000-0000-000000000000",
  "sent_date": "2024-08-25T15:00:00Z",
  "read_date": "2024-08-25T15:00:00Z",
  "actioned_date": "2024-08-25T15:00:00Z",
  "expires_at": "2024-08-25T15:00:00Z",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete a notification

DELETE

https://api.faireplace.com/api

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

Permanently deletes an amendment notification.

Delete a notification › path Parameters

lease_id

string · uuid · required

amendment_id

string · uuid · required

notification_id

string · uuid · required

Delete a notification › Responses

Notification deleted

No data returned

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

curl --request DELETE \
  --url https://api.faireplace.com/api/leases/:lease_id/amendments/:amendment_id/notifications/:notification_id

shell

Example Responses

No example specified for this content type

Amendment History Documents