Skip to main content
POST

Overview

Remove specific users from channel whitelist. After removal, users will lose whitelist privileges and will not be able to send messages to the channel if whitelist mode is enabled.

Request Body

Required Parameters

string
required
Channel ID, cannot be empty or contain special characters
integer
required
Channel type
  • 1 - Person channel
  • 2 - Group channel
array
required
List of user IDs to remove from whitelist
string
User ID

Response Fields

string
required
Operation status, returns "ok" on success

Status Codes

Functionality

Remove Operation

The remove operation performs the following steps:
  1. Verify Users: Check if specified users are in the whitelist
  2. Remove Entries: Delete specified users from channel whitelist
  3. Permission Changes: Users lose whitelist privileges
  4. Take Effect Immediately: Permission changes take effect immediately

Permission Impact

Removed users will lose:

Whitelist Mode Impact

When Whitelist Mode is Enabled

  • Removed Users: Cannot send messages to the channel
  • Other Whitelisted Users: Unaffected, continue to enjoy privileges
  • Regular Users: Still cannot send messages

When Whitelist Mode is Disabled

  • Removed Users: Can still send messages normally
  • Permission Changes: Mainly affects special permissions and priority

Use Cases

Permission Downgrade

Batch Cleanup

Temporary Restriction

Whitelist Management Strategy

Operation Comparison

Management Principles

  1. Principle of Least Privilege: Only give necessary users whitelist permissions
  2. Regular Review: Regularly check the necessity of whitelist users
  3. Permission Grading: Assign different levels of permissions based on user roles
  4. Transparent Management: Record all permission change operations

Best Practices

  1. Permission Audit: Regularly review whitelist user activity and necessity
  2. Progressive Removal: For important users, consider progressive permission downgrade
  3. Notification Mechanism: Notify relevant users and administrators before removal
  4. Backup Strategy: Backup current whitelist state before batch operations
  5. Monitor Impact: Monitor channel activity changes after removal
  6. Document Records: Record removal reasons and expected impact

Error Handling

Common Errors