Admin
APIs for administrator functions.
Permanently deletes all transactions for the specified subscriber. This is an administrative action and cannot be undone. Only users with sufficient administrative privileges can perform this operation. No values are updatable; this is a destructive operation that removes all payment and policy records for the subscriber.
The access token for the network operator admin session.
The email address of the subscriber whose transactions are to be deleted.
POST /preview/networkoperatorconsole/admin/deleteSubscriberTransactionsPermanently HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"EmailAddress": "[email protected]"
}Transactions deleted successfully.
{
"message": "Transactions removed. ",
"EndDateTimeUTC.ISO8601": "2025-06-20T16:26:15.457Z",
"errorProcessing": false
}Permanently deletes the specified subscriber account and all associated transactions. This is an administrative action and cannot be undone. Only users with sufficient administrative privileges can perform this operation. No values are updatable; this is a destructive operation that removes all payment, policy, and account records for the subscriber.
The access token for the network operator admin session.
The email address of the subscriber whose account is to be deleted.
POST /preview/networkoperatorconsole/admin/deleteSubscriberAccountPermanently HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"EmailAddress": "[email protected]"
}Subscriber account and transactions deleted successfully.
{
"message": "Transactions removed. Subscriber account deleted. ",
"errorProcessing": false
}Permanently deletes the specified venue and all associated units and equipment. This is an administrative action and cannot be undone. Only users with sufficient administrative privileges can perform this operation. If the venue has active/future policies, deletion will fail unless forceDelete is set to true. No values are updatable; this is a destructive operation.
The access token for the network operator admin session.
The unique identifier for the venue to be deleted.
Set to true to force deletion even if active/future policies exist. Default is false.
POST /preview/networkoperatorconsole/admin/deleteVenuePermanently HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 98
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}",
"forceDelete": false
}Venue deleted successfully (or errorProcessing true if failed).
{
"errorProcessing": false
}Permanently deletes the specified keypool and all associated keys and bins. This is an administrative action and cannot be undone. Only users with sufficient administrative privileges can perform this operation. No values are updatable; this is a destructive operation that removes all keys, bins, and the keypool record itself.
The access token for the network operator admin session.
The unique identifier for the keypool to be deleted.
POST /preview/networkoperatorconsole/admin/deleteKeypoolPermanently HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 82
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"KeyPoolID": "{{KeyPoolID}}"
}Keypool deleted successfully (or errorProcessing true if failed).
{
"errorProcessing": false
}Permanently deletes the specified equipment from the given venue. This is an administrative action and cannot be undone. Only users with sufficient administrative privileges can perform this operation. No values are updatable; this is a destructive operation that removes the equipment record and all associated configuration and logs.
The access token for the network operator admin session.
The unique identifier for the venue containing the equipment to be deleted.
The unique identifier for the equipment to be deleted.
POST /preview/networkoperatorconsole/admin/deleteVenueEquipmentPermanently HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 114
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}",
"EquipmentID": "{{AnonEquipmentID}}"
}Equipment deleted successfully (or errorProcessing true if failed).
{
"errorProcessing": false
}Permanently deletes all units associated with the specified venue. This is an administrative action and cannot be undone. Only users with sufficient administrative privileges can perform this operation. No values are updatable; this is a destructive operation that removes all venue units and their associated data. If any unit has active/future policies, deletion will fail unless forceDelete is set to true for that unit.
The access token for the network operator admin session.
The unique identifier for the venue whose units are to be deleted.
POST /preview/networkoperatorconsole/admin/deleteAllVenueUnitsPermanently HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 78
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"VenueID": "{{VenueID}}"
}All venue units deleted successfully (or errorProcessing true if failed).
{
"message": "Deleted all units at venue permanently. ",
"errorProcessing": false
}Permanently deletes the specified venue unit. This is an administrative action and cannot be undone. Only users with sufficient administrative privileges can perform this operation. No values are updatable; this is a destructive operation that removes the venue unit and all associated data. If the unit has active/future policies, deletion will fail unless forceDelete is set to true.
The access token for the network operator admin session.
The unique identifier for the venue unit to be deleted.
Set to true to force deletion even if active/future policies exist. Default is false.
POST /preview/networkoperatorconsole/admin/deleteVenueUnitPermanently HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 98
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"UnitID_internal": "{{AnonUnitID_internal}}"
}Venue unit deleted successfully (or errorProcessing true if failed).
{
"message": "ANON_UNIT_ID removed. ",
"errorProcessing": false
}Was this helpful?