Update Move Out

PUT

https://api.fortresstech.io/v1/moveOuts/:moveOutId

PUT

/v1/moveOuts/:moveOutId

curl -X PUT https://api.fortresstech.io/v1/moveOuts/moveOutId \
     -H "x-api-key: <apiKey>"

200Updated

{
  "scheduledDate": "2023-01-15",
  "actualDate": "2023-01-15",
  "status": "SCHEDULED",
  "reason": "string",
  "reasonType": "string",
  "noticeDate": "2023-01-15",
  "id": "string",
  "readableId": "string",
  "idempotencyId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "organizationId": "string",
  "propertyId": "string",
  "unitId": "string",
  "householdId": "string",
  "leaseId": "string",
  "property": {
    "name": "string",
    "shortName": "string",
    "email": "string",
    "phone": "string",
    "physicalStreetAddress1": "string",
    "physicalStreetAddress2": "string",
    "physicalCity": "string",
    "physicalState": "string",
    "physicalZip": "string",
    "physicalCountry": "string",
    "mailingStreetAddress1": "string",
    "mailingStreetAddress2": "string",
    "mailingCity": "string",
    "mailingState": "string",
    "mailingZip": "string",
    "mailingCountry": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "timezone": "string",
    "longitude": 1.1,
    "latitude": 1.1,
    "turnMoveOutDays": 1,
    "status": "ACTIVE",
    "propertyClass": "Conventional",
    "organizationId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "offboardedAt": "2024-01-15T09:30:00Z",
    "countyName": "string",
    "acquisitionDate": "2024-01-15T09:30:00Z"
  },
  "unit": {
    "number": "string",
    "floorLevel": "string",
    "isADA": true,
    "streetAddress1": "string",
    "streetAddress2": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "fullAddress": "string",
    "status": "VACANT_READY",
    "isOccupied": true,
    "floorPlanId": "string",
    "propertyId": "string",
    "organizationId": "string",
    "buildingId": "string",
    "currentHouseholdId": "string",
    "lastMoveOutId": "string",
    "priorLeaseId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "vacantSince": "2024-01-15T09:30:00Z",
    "reportOrder": 1.1,
    "makeReadyDate": "2023-01-15",
    "reportConfigurationValue": "Quoting Rent",
    "lastVacancyStartDate": "2023-01-15",
    "mostRecentApplicationId": "string"
  },
  "lease": {
    "startDate": "2023-01-15",
    "endDate": "2023-01-15",
    "moveInDate": "2023-01-15",
    "moveOutDate": "2023-01-15",
    "rentAmount": 1.1,
    "leasedRent": 1.1,
    "securityDepositAmount": 1.1,
    "makeReadyDate": "2023-01-15",
    "turnMoveOutDays": 1,
    "documentId": "string",
    "moveOutId": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "propertyId": "string",
    "unitId": "string",
    "householdId": "string",
    "organizationId": "string"
  },
  "household": {
    "status": "APPLICANT",
    "isUnderEviction": true,
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "currentUnitId": "string",
    "currentLeaseId": "string",
    "applicationId": "string",
    "organizationId": "string",
    "propertyId": "string",
    "currentCertificationId": "string",
    "prospectId": "string",
    "primaryCustomerId": "string",
    "totalActiveRentAmount": 1.1,
    "totalActiveSubsidyAmount": 1.1,
    "totalActiveFeesAmount": 1.1,
    "unitId": "string"
  }
}

Available by Request

Update information for a specific move-out record, such as changing the move-out date, updating unit condition notes, modifying forwarding address, or adjusting other details associated with the resident’s departure.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

moveOutIdstringRequired

The id of the move out

Response

Expected response to a valid request

scheduledDatedateOptional

actualDatedateOptional

statusenumOptional

Allowed values:

reasonstringOptional

reasonTypestringOptional

noticeDatedateOptional

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

organizationIdstringOptionalformat: "uuid"

propertyIdstringOptionalformat: "uuid"

unitIdstringOptionalformat: "uuid"

householdIdstringOptionalformat: "uuid"

leaseIdstringOptionalformat: "uuid"

propertyobjectOptional

unitobjectOptional

leaseobjectOptional

householdobjectOptional