Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
rentalRecords
/
{unitRentalRecordUuid}
/
paymentLink
Send payment link to a tenant
curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/paymentLink \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "method": "email"
}
'

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
​
facilityUuid
string
required
​
unitRentalRecordUuid
string
required

Body

application/json

Method to send the payment link (email or sms)

​
method
enum<string>
default:email

The method to send the payment link

Available options:
sms,
email

Response

Payment link sent successfully