Skip to main content
Soft-deletes a user of your access token’s organization: the user’s status is set to -99 and they stop appearing in List users. Integrations can delete only users whose roles are branch-level (branch_user / branch_manager).
Auth: Authorization: Bearer <accessToken> — an organization-scoped token from Authentication.

Path parameters

Example

Response

Returns 200 with the deleted user; status is -99.
Notes:
  • This is a soft delete — the record is kept with status: -99 and is excluded from lists; the user can no longer sign in or be used.
  • The delete response does not include roles.
  • Deleting a user that does not exist returns entity_not_found (400); a user outside your organization returns auth_error (400).
  • Deleting a user whose roles are not branch-level returns user_not_deletable (400); API users return api_user_not_deletable (400).
  • The deleted user’s email stays reserved — creating a new user with the same email still returns user_already_exists (400).
Last modified on October 8, 2026