Route: https://api.kayran.live/DeleteUser
This function allow you to delete a specific user from your server.
Roles Required: Admin.
Request Syntax
{
"apiKey": "String",
"email": "String",
"id": 0123456789
}
Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your Kayran given API Key.
How do I get it ? :
Located in the “Profile” section.
Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.
Type :
String
Is it Optional ? :
No.
Parameter Name :
Parameter Usage and Options :
The Email address of the user you wish to delete.
Type :
String
Is it Optional ? :
No.
Parameter Name :
id
Parameter Usage and Options :
The ID of the user you wish to delete.
How do I get it ? :
Use the “GetUser” or “GetUsers functions, or, use the users table in the “Users” sub-section under the “Manage” section.
Type :
Integer
Is it Optional ? :
No.
Successful Response
{
"Error": 0,
"Function": "DeleteUser",
"Data": "User Deleted."
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.