Skip to main content
POST
/
shopping
/
{portfolio}
/
v1
/
facilities
/
lead
Create a new lead
curl --request POST \
  --url https://public-api.prd.monument.io/shopping/{portfolio}/v1/facilities/lead \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "person": {
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "city": "<string>",
    "state": "AL",
    "country": "AD",
    "zip": "<string>",
    "military": {
      "commandingOfficer": "<string>",
      "commandingOfficerEmail": "<string>",
      "startDateOfService": "2023-11-07T05:31:56Z",
      "dateOfBirth": "2023-11-07T05:31:56Z",
      "branch": "<string>"
    },
    "haveMilitary": true,
    "isSmsEnrolled": true,
    "identification": {
      "identificationType": "DRIVER_LICENSE",
      "identificationString": "<string>",
      "country": "AD",
      "state": "AL",
      "issueDate": "2023-11-07T05:31:56Z",
      "expirationDate": "2023-11-07T05:31:56Z"
    },
    "phone": "<string>",
    "phoneType": {}
  },
  "unitGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "facilityUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "taxId": "<string>",
  "dateDesiredMoveIn": "2023-11-07T05:31:56Z",
  "businessName": "<string>",
  "leadType": "BUSINESS",
  "leadStatus": "OPEN",
  "hasBeneficiary": true,
  "beneficiary": {
    "firstName": "<string>",
    "lastName": "<string>",
    "relationship": "<string>",
    "email": "<string>",
    "phone": "<string>"
  },
  "alternateContact": {
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "relationship": "<string>"
  },
  "haveAlternateContact": true,
  "vehicle": {
    "type": "<string>",
    "make": "<string>",
    "model": "<string>",
    "vinNumber": "<string>",
    "haveVehicleLien": true,
    "licensePlateNumber": "<string>",
    "vehicleLien": {
      "name": "<string>",
      "address": "<string>"
    }
  },
  "haveVehicle": true
}
'
{
  "leadUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "verifyToken": "<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
​
person
object
required
​
unitGroupUuid
string<uuid>
required
​
facilityUuid
string<uuid>
required
​
taxId
string | null
​
dateDesiredMoveIn
string<date-time> | null
​
businessName
string | null
​
leadType
enum<string>
Available options:
BUSINESS,
PERSONAL
​
leadStatus
enum<string>
Available options:
OPEN,
CONVERTED,
LOST,
PENDING,
RESERVED,
WAITLISTED
​
hasBeneficiary
boolean
​
beneficiary
object
​
alternateContact
object
​
haveAlternateContact
boolean
​
vehicle
object
​
haveVehicle
boolean

Response

201 - application/json

Result of creating a lead, needed to make future updates to leads

​
leadUuid
string<uuid>
required

Unique identifier for the lead created

​
verifyToken
string | null
required

Temporary verification token needed to update the created lead while the lead is shopping