Skip to content

Overview

Configure your campaign settings to customize your campaign’s user experience. You can adjust the following options:

Option Description
Toggle Reminders Turn reminders on or off for your campaign.
Toggle Post-Session Surveys Turn post-session surveys on or off for your campaign.
Toggle Attendance Messages Turn attendance messages on or off for your campaign.
Change the Tabletop Channel Set the channel where session threads are created.
Change the Announcement Channel Set the channel where announcements are sent.

Command Structure

Update all campaign settings using the /campaign settings command. Only the gamemaster can modify these settings, and every command requires the campaign ID. Auto-completion helps you locate the campaign ID based on your campaign’s name.

Success Response

When a setting is updated successfully, you'll see a success message in the channel where you issued the command. This message displays the campaign resource along with its updated settings.

Enable or Disable Reminders

Turn reminders on or off for your campaign. By default, reminders are disabled. To change this setting, use the /campaign settings reminders command and set the enabled option to true or false. For example, to disable reminders:

/campaign settings reminders campaign: <campaign_id> enabled: false

Parameters

Parameter Type Description
campaign string The ID of the campaign you want to update.
enabled Boolean Set to true to enable reminders or false to disable them (Default: false)

Enable or Disable Post-Session Surveys

Control whether post-session surveys are active for your campaign. Surveys are disabled by default. Update this setting with the /campaign settings survey command by setting the enabled option to true or false. For example, to disable surveys:

/campaign settings survey campaign: <campaign_id> enabled: false

Parameters

Parameter Type Description
campaign string The ID of the campaign you want to update.
enabled Boolean Set to true to enable surveys or false to disable them (Default: false)

Enable or Disable Attendance Messages

Manage attendance messages with ease. By default, attendance messages are disabled. Change the setting using the /campaign settings attendance command by setting the enabled option to true or false. For example, to disable attendance messages:

/campaign settings attendance campaign: <campaign_id> enabled: false

Parameters

Parameter Type Description
campaign string The ID of the campaign you want to update.
enabled Boolean Set to true to enable attendance messages or false to disable them (Default: false)

Change the Tabletop Channel

Set the text channel where session threads are created. Run the /campaign settings tabletop-channel command and specify the new channel. For example, to change to #new-tabletop:

/campaign settings campaign: <campaign_id> tabletop-channel: <channel_name>

Parameters

Parameter Type Description
campaign string The ID of the campaign you want to update.
tabletop-channel ChannelResolvable The name of the channel where session threads will be created.

Change the Announcement Channel

Set the text channel where announcements are sent. Run the /campaign settings announcement-channel command and specify the new channel. For example, to change to #new-announcements:

/campaign settings campaign: <campaign_id> announcement-channel: <channel_name>

Parameters

Parameter Type Description
campaign string The ID of the campaign you want to update.
announcement-channel ChannelResolvable The name of the channel where announcements will post.