Banning Community Members

Ban a Member

Ban a specified user from a community within your organization.

Note: Although configured as a GET route internally, this endpoint requires a JSON request body.

• HTTP Method: GET
• Endpoint URL: https://api.trywhiteowl.com/api/v1/communities/ban
• Authentication: Bearer Token (API Key)

---

Request Headers

Header	Type	Required	Description
Authorization	String	Yes	Bearer token format: Bearer YOUR_API_KEY
Content-Type	String	Yes	application/json

---

Request Body

Field	Type	Required	Description
id	Number	Yes	The numeric identifier of the community.
member	String	Yes	The ID or username of the member to ban.
organization	String	Yes	Your organization identifier.

Example Payload:

{
  "id": 101,
  "member": "usr_9988",
  "organization": "org_12345"
}

---

Code Examples

cURL

curl -X GET "https://api.trywhiteowl.com/api/v1/communities/ban" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 101,
    "member": "usr_9988",
    "organization": "org_12345"
  }'

JavaScript (Fetch)

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    id: 101,
    member: 'usr_9988',
    organization: 'org_12345'
  })
};

fetch('https://api.trywhiteowl.com/api/v1/communities/ban', options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(err => console.error(err));

Python (Requests)

import requests

url = "https://api.trywhiteowl.com/api/v1/communities/ban"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {
    "id": 101,
    "member": "usr_9988",
    "organization": "org_12345"
}

response = requests.get(url, headers=headers, json=payload)
print(response.json())

---

Response Structure

Success Response (200 OK)

{
  "success": true,
  "message": "Member banned successfully"
}

Error Responses

• Validation / Internal Error:

{
  "success": false,
  "message": "There was an error banning member"
}