Delete User Account API

API for deleting user accounts with different options

Endpoint

DELETE /api/users/user/{userId}

Description

This endpoint allows you to delete a user account with different options. You can choose to:

  • Only unpair the user from their partner (keeping the account)
  • Delete the account but keep all user data
  • Completely delete the account and all associated data

Request Options

ParameterTypeRequiredDescription
onlyUnpairBooleanNoIf true, only unpair the user without deleting the account
keepDataBooleanNoIf true, delete the user account but keep all their data

Response Format

FieldTypeDescription
successBooleanIndicates if the operation was successful
messageStringA descriptive message about the operation
actionStringThe type of action performed: "unpair", "delete_keep_data", or "delete_all"