Skip to main content
PUT
/
shopping
/
{portfolio}
/
v1
/
facilities
/
lead
/
{leadUuid}
Update lead indicated, setting their personal information, facility, unit group, and services 
curl --request PUT \
  --url https://public-api.prd.monument.io/shopping/{portfolio}/v1/facilities/lead/{leadUuid} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "lead": {
    "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
  },
  "verifyToken": "<string>",
  "unitGroupUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "additionalServices": [
    "<string>"
  ],
  "coverageUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accessPlanUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isAutopayEnabled": true,
  "facilityUuid": {}
}
'

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

​
leadUuid
string
required
​
portfolio
string
required

Body

application/json
​
lead
object
required
​
verifyToken
string
required

Verification token retrieved from create Lead, must be correct for the lead or updates will fail to prevent unuathorized updates.

​
unitGroupUuid
string<uuid>
​
additionalServices
string[]

Array of additional services the lead has selected.

​
coverageUuid
string<uuid> | null
​
accessPlanUuid
string<uuid> | null
​
isAutopayEnabled
boolean | null
​
facilityUuid
object

Response

200

Response to updating a lead, no response body details