Lease Transaction (PATCH)

This PATCH endpoint allows you to provide Funnel with the PMS identifiers related to a lease transaction.

PATCH /api/v2/lease-transactions/:id

Attributes

Name
resident_household_id
Type
string
Description
The 'Resident Household ID' from Realpage. Required.
Name
lease_integration_id
Type
string
Description
The 'Lease ID' from Realpage. Required.
Name
residents
Type
array
Description
An array of objects containing the PMS identifiers for each individual person. The field is required but can be empty.

{
    "resident_household_id": "rh-123",
    "lease_integration_id": "lease-123",
    "residents": [
        {
            "resident_member_id": "rm-123",
            "account_id": 737759
        },
        {
            "resident_member_id": "rm-456",
            "account_id": 737787
        },
    ]
}