API ReferenceUsers

Delete User

<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 objects or null
applicationslist of objects or null
createdAtdatetime or null
deletedAtdatetime or null
emailstring or null
firstNamestring or null
hasAllPropertiesboolean or null
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
lastNamestring or null
organizationIdstring or nullformat: "uuid"
propertyIdsstring or null

Comma-separated list of property UUIDs

prospectslist of objects or null
readableIdstring or null
statusenum or null
Allowed values:
updatedAtdatetime or null
userPropertieslist of objects or null
usernamestring or null
workOrderslist of objects or null