Skip to main content
Monument Public API home page
Search...
⌘K
Documentation
Shopping API Reference
Integration API Reference
ShoppingApi
GET
Get all facilities
POST
Create a new lead
GET
Validate lead verification token
PUT
Update lead indicated, setting their personal information, facility, unit group, and services
POST
Call when a lead exits the shopping experience, marking them as immediately visible in the FMS.
POST
Action to take when a lead is fully filled out and is ready to generate a lease. Will mark a unit in the unit group they've selected as reserved.
GET
Get details for a converted lead
POST
Checks if a tenant already exists with this email, sends a verfication code to their email they must retrieve if so
POST
Authenticates that the verification code matches the one sent to the tenants email. If successful, creates a new lead pre-assocatiated with this tenant.
GET
Get billing template for a lead
GET
Get unit groups for a facility
GET
Get facility details
GET
Check if a lead has been converted
GET
Get rental flow configuration for a facility
GET
Retrieve access plans for a facility
GET
Retrieve shopping cart for a lead
GET
Get unit group details
GET
Get tax information for a unit group
GET
Get payment processor information
GET
Retrieve payment processor info for a given facility
POST
Create a payment profile for a lead to use for their initial and future payments
GET
Get Payrix public API key
GET
Get Unit by Lead UUID and Verify Code
POST
Get Gate Access Code by Lead UUID and Verify Code
GET
Get private coverage information
GET
Get coverage options for a facility
Monument Public API home page
Search...
⌘K
Search...
Navigation
ShoppingApi
Call when a lead exits the shopping experience, marking them as immediately visible in the FMS.
ShoppingApi
Call when a lead exits the shopping experience, marking them as immediately visible in the FMS.
POST
/
shopping
/
{portfolio}
/
v1
/
facilities
/
lead
/
{leadUuid}
/
exit-shopping
Try it
201
Copy
{}
Path Parameters
leadUuid
string
required
Response
200
Shopping experience successfully ended.
Previous
Action to take when a lead is fully filled out and is ready to generate a lease. Will mark a unit in the unit group they've selected as reserved.
Next
⌘I
201
Copy
{}