Add a user to the ban list for a project.
PUT/v2/projects/{project_id}/ban/{user_id} Path Parameters
The unique identifier of the project.
The unique identifier of the user to ban (numeric ID).
Request Body
Optional reason for banning the user.
curl -X PUT "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/ban/123456789012345678" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
const project_id = 'YOUR_PROJECT_ID';
const user_id = '123456789012345678';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/ban/${user_id}`, {
method: 'PUT',
headers: {
'Authorization': 'Bearer YOUR_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
});
const data = await response.json();
import requests
project_id = 'YOUR_PROJECT_ID'
user_id = '123456789012345678'
response = requests.put(
f'https://api.botsubscription.com/v2/projects/{project_id}/ban/{user_id}',
headers={'Authorization': 'Bearer YOUR_TOKEN'},
json={}
)
data = response.json()
$project_id = 'YOUR_PROJECT_ID';
$user_id = '123456789012345678';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/ban/{$user_id}");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_TOKEN', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{}');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
User bannedapplication/json
{
"ok": true,
"request_id": "11111111-1111-1111-1111-111111111111",
"method": "PUT",
"path": "/v2/projects/YOUR_PROJECT_ID/ban/123456789012345678",
"code": 200,
"message": "User banned successfully",
"data": {
"user_id": "123456789012345678",
"banned_at": "2025-01-15T10:30:00.000Z",
"banned_by": null,
"banned_reason": "Violation of terms"
}
}
User already bannedapplication/json
{
"ok": false,
"request_id": "11111111-1111-1111-1111-111111111111",
"method": "PUT",
"path": "/v2/projects/YOUR_PROJECT_ID/ban/123456789012345678",
"code": 409,
"error": {
"error_code": "CONFLICT",
"message": "User is already banned."
}
}
User not foundapplication/json
{
"ok": false,
"request_id": "11111111-1111-1111-1111-111111111111",
"method": "PUT",
"path": "/v2/projects/YOUR_PROJECT_ID/ban/123456789012345678",
"code": 404,
"error": {
"error_code": "NOT_FOUND",
"message": "User not found"
}
}
Last updated: