Overview
Ban management allows administrators to prevent specific content from appearing on the platform by filtering text, patterns, images, and blocking user addresses.Ban Terms
Manage banned text terms that will be filtered from token names and descriptions.Get Ban Terms
Add Ban Term
Remove Ban Term
string
required
The ID of the ban term to remove
Regex Ban Patterns
Use regular expressions for more sophisticated content filtering.Get Regex Patterns
Add Regex Pattern
Remove Regex Pattern
string
required
The ID of the regex pattern to remove
Image Ban Terms
Manage banned terms for image content filtering.Get Image Ban Terms
Add Image Ban Term
Remove Image Ban Term
string
required
The ID of the image ban term to remove
User Bans
Manage banned user addresses.Get Banned Users
string
required
Number of results to return
string
required
Number of results to skip for pagination
string
required
Field to sort by (e.g., createdAt, address)
string
required
Sort order: asc or desc
string
required
Search term to filter users
string
required
Filter by active ban status (true/false)
string
required
Filter users with unban requests (true/false)
string
required
Filter bans from this date (ISO 8601 format)
string
required
Filter bans until this date (ISO 8601 format)
Ban User Address
string
required
The wallet address to ban from the platform
Ban Content by ID
number
required
The ID of the content to ban
Get Ban Details
number
required
The ID of the ban to retrieve
Best Practices
- Start with specific terms: Add exact matches before using regex patterns
- Test patterns: Verify regex patterns don’t create false positives
- Document bans: Keep records of why terms or addresses were banned
- Review regularly: Periodically audit ban lists to ensure they’re still relevant
- Use bulk operations: For banning multiple addresses, consider using bulk endpoints
- Monitor effectiveness: Check moderation logs to see if bans are working as intended