Skip to main content
POST
Delete user profiles across all tenants

Authorizations

X-Bunker-Token
string
header
required

API token for authentication

Body

application/json
mode
enum<string>
required

Mode of user identification. The token mode is only allowed when tenantid or tenantname is also specified.

Available options:
login,
email,
phone,
custom,
token
identity
string
required

User identifier corresponding to the mode

unlockuuid
string
required

UUID from bulk list unlock for authorization

tenantid
integer

Optional tenant ID to restrict deletion to a single tenant

tenantname
string

Optional tenant name to restrict deletion to a single tenant

request_metadata
object

Additional metadata for the request

Response

User profiles deleted successfully

status
string
Example:

"ok"

total
integer

Total number of profiles deleted across tenants

rows
object[]