# Sync Commands

Sync keeps bans, messages, or role assignments aligned across guilds and channels.

# Quick start

  1. Create a ban sync: /sync bans direction:to guild-id:1234567890
  2. Create a message sync: /sync messages direction:both channel-id:1234567890
  3. Pause or resume: /sync pause sync-id:abc123 or /sync resume sync-id:abc123

# /sync bans

# Syntax

/sync bans direction:to guild-id:1234567890

# Options

Option Description Required
direction to, from, or both. Yes
guild-id Target guild ID. Yes

# Requirements

Requirement Notes
Ban Members Required for the user in both guilds.
Ban Members Required for the bot in both guilds.
Config level advanced Required for non-owners.
Config ownerOnly If enabled, only the guild owner can use major commands.

# /sync messages

# Syntax

/sync messages direction:both channel-id:1234567890

# Options

Option Description Required
direction to, from, or both. Yes
channel-id Target channel ID. Yes

# Requirements

Requirement Notes
Manage Webhooks and Manage Messages Required for the user in the source channel.
Manage Webhooks and Administrator Required for the bot in the target channel.
Paid tier Requires Scale or Enterprise.
Config level advanced Required for non-owners.
Config ownerOnly If enabled, only the guild owner can use major commands.

# Notes

+- Message syncs can be paused and resumed. +- Cooldowns may apply.

# /sync roles

# Syntax

/sync roles direction:to first_role:@Role second_role:@Role guild-id:1234567890

# Options

Option Description Required
direction to, from, or both. Yes
first_role Role in the current guild. Yes
second_role Role in the target guild. Yes
guild-id Target guild ID. Yes

# Requirements

Requirement Notes
Manage Roles Required for the user in both guilds.
Manage Roles Required for the bot in both guilds.
Paid tier Requires Enterprise.
Config level advanced Required for non-owners.
Config ownerOnly If enabled, only the guild owner can use major commands.

# Notes

+- Role sync is currently in testing and may be limited to the developer team.

# /sync pause

# Syntax

/sync pause sync-id:abc123

# Options

Option Description Required
sync-id Sync ID to pause. Yes

# Notes

+- For message syncs, you need channel permissions to manage the sync.

# /sync resume

# Syntax

/sync resume sync-id:abc123

# Options

Option Description Required
sync-id Sync ID to resume. Yes

# /sync delete

# Syntax

/sync delete sync-id:abc123

# Options

Option Description Required
sync-id Sync ID to delete. Yes

# Requirements

Requirement Notes
Config level advanced Required for non-owners.
Config ownerOnly If enabled, only the guild owner can use major commands.

# Notes

+- Requires confirmation before deletion.

# /sync list

# Syntax

/sync list page:1

# Options

Option Description Required
page Page number to display. No