Update a renewal status
Update a lease’s renewal status for a given renter and unit
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The Community ID, this will look like either ‘1234’ or ‘P1234-567’. Alternatively, if you prefix this value with
partner-id:, for example partner-id:apts123 you can use your own community, as long as you have previously provided that
ID to Funnel.
Examples
Funnel Community ID
The raw integer Funnel ID of a community.
1234Funnel Community Syndication ID
The community’s Funnel syndcation ID. An ID in this format is often provided in Funnel feeds to ILS partners.
P1234-567Partner ID
The ID of the community in the partner system. This needs to have been previously provided to Funnel and setup.
partner-id:apts123The client’s funnel id (often referred to as client id or prospect id), this will look like ‘1234’.
Example
12345The Funnel unit id.
Example
12345Request Body
Section titled “Request Body ”object
Should show the Renewal card
The text of the renewal body
Should show the alert
The text of the renewal alert body
The alert type “WARNING” or “INFO”
Should allow click-through by the resident to the Renewals Widget
The text of the renewal header
The text of the renewal header
The icon to show in the renewal card
RENEWAL, AUTOPAY, etc. for all icons see https://docs.google.com/document/d/1rY4lMiGGa1IxT_IAzrCBXSpifZ9Fz2LCKAJ2TeLHOR8Responses
Section titled “ Responses ”Renewal status successfully updated
object
7We were unable to authenticate your request with the provided API key.
object
CommunityNotFoundCould not find community with corresponding ID.An active lease could not be matched using the provided community, renter, and unit.
object
LeaseNotFoundCould not find active lease for client.