Skip to main content
POST
/
shopping
/
{portfolio}
/
v1
/
facilities
/
lead
/
generate-lease
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.
curl --request POST \
  --url https://public-api.prd.monument.io/shopping/{portfolio}/v1/facilities/lead/generate-lease \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "facilityUuid": "<string>",
  "unitGroupUuid": "<string>",
  "leadUuid": "<string>",
  "email": "<string>",
  "additionalServices": [
    "<string>"
  ]
}
'
{
  "leaseSessionUrl": "<string>"
}

Headers

​
x-api-key
any
required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

​
portfolio
string
required

Body

application/json
​
facilityUuid
string
required
​
unitGroupUuid
string
required
​
leadUuid
string
required
​
email
string
required
​
additionalServices
string[]

Response

201 - application/json

Details of the created lease to create display for the user

​
leaseSessionUrl
string
required

Embedable url for the lease which is signable by the lead.