The Voomerr Check Username allows users to check whether a username is available or not. This accepts a username and returns a response indicating whether the username is available or not.
Endpoint #
The Voomerr Check Username endpoint is POST https://admin.voomerr.com/api/check-username.php
.
Request Parameters #
The following parameter is required to check the availability of a username:
Parameter | Type | Required | Description |
---|---|---|---|
username | string | Yes | The username to check the availability of. |
Example Request #
POST https://admin.voomerr.com/api/check-username.php
{
"username": "johndoe"
}
Response #
The response from the API will contain a JSON object with the following fields:
Field | Type | Description |
---|---|---|
success | boolean | Whether the request was successful or not. |
message | string | A message describing the result of the request. |
available | boolean | Whether the username is available or not. |
If the request is successful, the ‘success’ field will be ‘true’, and the ‘message’ field will contain a success message. The ‘available’ field will indicate whether the username is available or not. If the username is available, the ‘available’ field will be ‘true’. If the username is not available, the ‘available’ field will be ‘false’.
If the request fails, the ‘success’ field will be ‘false’, and the ‘message’ field will contain an error message.
Example Response #
{
"success": true,
"message": "Username is available.",
"available": true
}