Skip to main content
The SDK exposes a delete-community API for authorized users when a community is no longer needed. Treat deletion as irreversible from the client UI, and confirm your product’s data-retention and recovery policy outside the client SDK.
Deleting a community cannot be undone through the client SDK. Use explicit confirmation in your product UI before calling the SDK method.

Parameters

Permission Requirements

Deletion is permission-gated by the backend. In most products, deletion controls are shown only to community creators, moderators, or administrators, but the SDK call is still validated server-side.

Delete a Community

Call the delete-community method with a communityId. TypeScript, Android, and Flutter use deleteCommunity; iOS uses deleteCommunity(withId:).

Client Impact

After successful deletion, handle the client-side effects explicitly:
  • Remove the community from any local list or cached UI state.
  • Navigate away from deleted community detail screens.
  • Stop showing actions that require the deleted communityId.
  • Refresh affected discovery or membership queries when needed.

Pre-deletion Considerations

Product Policy

Before exposing deletion, decide how your product handles:
  1. What data is retained or recoverable outside the client SDK.
  2. Whether members should be notified before deletion.
  3. Whether archive, privacy, or moderation actions are safer than deletion.

Member Management

Refresh membership and discovery views after deletion so users do not see stale references to the deleted community.

Best Practices

Implement multiple confirmation steps and consider a cooling-off period for community deletion requests to prevent impulsive decisions.

Implementation Guidelines

  1. Require multiple explicit confirmations.
  2. Make users type the community name to confirm.
  3. Verify user permissions before showing delete options.
  4. Show clear progress during deletion operations.
  5. Provide clear confirmation of successful deletion.

User Experience Considerations

  1. Emphasize the permanent nature of deletion.
  2. Offer data export before deletion if your product supports it.
  3. Provide tools to notify community members.
  4. Handle post-deletion navigation appropriately.

Update Community

Modify community settings as an alternative to deletion

Community Moderation

Manage communities with moderation tools instead of deletion

Create Community

Learn about community creation to understand deletion impact

Member Management

Handle member relationships before community deletion