Delete User

{
  "activities": [
    {
      "notes": "notes",
      "type": "EMAILED",
      "prospectId": "prospectId",
      "assignedUserId": "assignedUserId",
      "propertyId": "propertyId",
      "organizationId": "organizationId",
      "householdId": "householdId",
      "customerStatus": "customerStatus",
      "startTime": "2024-01-15T09:30:00Z",
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "applications": [
    {
      "notes": "notes",
      "status": "APPROVED",
      "submittedAt": "2024-01-15T09:30:00Z",
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
      "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
      "assignedUserId": "assignedUserId",
      "assignedUnitId": "assignedUnitId",
      "householdId": "householdId",
      "leaseId": "leaseId",
      "applicantId": "applicantId",
      "organizationId": "organizationId",
      "propertyId": "propertyId"
    }
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "email": "email",
  "firstName": "firstName",
  "hasAllProperties": true,
  "id": "id",
  "idempotencyId": "idempotencyId",
  "lastName": "lastName",
  "organizationId": "organizationId",
  "propertyIds": "propertyIds",
  "prospects": [
    {
      "firstName": "firstName",
      "middleName": "middleName",
      "lastName": "lastName",
      "phone": "phone",
      "email": "email",
      "referralSource": "referralSource",
      "propertyId": "propertyId",
      "organizationId": "organizationId",
      "assignedUserId": "assignedUserId",
      "prospectStatusId": "prospectStatusId",
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "readableId": "readableId",
  "status": "ACTIVE",
  "updatedAt": "2024-01-15T09:30:00Z",
  "userProperties": [
    {
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "userId": "userId",
      "propertyId": "propertyId",
      "organizationId": "organizationId",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "username": "username",
  "workOrders": [
    {
      "status": "OPEN",
      "priority": "LOW",
      "hasPetAlert": true,
      "completedAt": "2024-01-15T09:30:00Z",
      "requestorPhone": "requestorPhone",
      "requestorEmail": "requestorEmail",
      "requestedStartDateFrom": "requestedStartDateFrom",
      "requestedStartDateTo": "requestedStartDateTo",
      "requestedStartTimeFrom": "requestedStartTimeFrom",
      "requestedStartTimeTo": "requestedStartTimeTo",
      "dueDate": "dueDate",
      "description": "description",
      "serviceNotes": "serviceNotes",
      "vendorNotes": "vendorNotes",
      "entryNotes": "entryNotes",
      "entryPreference": "24_HOUR_NOTICE",
      "isDoorCodeActive": true,
      "isAlarmActive": true,
      "doorCode": "doorCode",
      "alarmCode": "alarmCode",
      "holdReason": "holdReason",
      "otherLocationDetail": "otherLocationDetail",
      "attachmentIds": "attachmentIds",
      "technicianNotes": "technicianNotes",
      "previouslyReported": true,
      "id": "id",
      "readableId": "readableId",
      "idempotencyId": "idempotencyId",
      "createdAt": "createdAt",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "assignedUserId": "assignedUserId",
      "householdId": "householdId",
      "customerId": "customerId",
      "unitId": "unitId",
      "maintenanceIssueId": "maintenanceIssueId",
      "maintenanceLocationId": "maintenanceLocationId",
      "propertyId": "propertyId",
      "organizationId": "organizationId",
      "totalCostOfMaterialsUsed": 1.1,
      "totalAmountOwedByResident": 1.1,
      "totalAmountOwedByProperty": 1.1,
      "hourlyServiceRate": 1.1,
      "totalLaborCost": 1.1
    }
  ]
}

Available by Request

Remove a user account from the system. This deactivates the user and removes their access to the platform.

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

<Badge>Available by Request</Badge> Remove a user account from the system. This deactivates the user and removes their access to the platform. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Path parameters

userIdstringRequired

The id of the user

Response

Expected response to a valid request

activitieslist of objectsOptional

applicationslist of objectsOptional

createdAtdatetimeOptional

deletedAtdatetimeOptional

emailstringOptional

firstNamestringOptional

hasAllPropertiesbooleanOptional

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

lastNamestringOptional

organizationIdstringOptionalformat: "uuid"

propertyIdsstringOptional

Comma-separated list of property UUIDs

prospectslist of objectsOptional

readableIdstringOptional

statusenumOptional

updatedAtdatetimeOptional

userPropertieslist of objectsOptional

usernamestringOptional

workOrderslist of objectsOptional