Skip to main content

Conversation filter object

Welcome to the new home of Slack developer docs!

We're still building and not all features are available quite yet. Enjoy this peek into the future!

Not ready for the future? Return to the past at api.slack.com.

Defines a filter for the list of options in a conversation selector menu.

The menu can be either a conversations select menu or a conversations multi-select menu.

Fields​

FieldTypeDescriptionRequired?
includeString[]Indicates which type of conversations should be included in the list. When this field is provided, any conversations that do not match will be excludedYou should provide an array of strings from the following options: im, mpim, private, and public. The array cannot be empty.Optional
exclude_external_shared_channelsBooleanIndicates whether to exclude external shared channels from conversation lists. This field will not exclude users from shared channels. Defaults to false.Optional
exclude_bot_usersBooleanIndicates whether to exclude bot users from conversation lists. Defaults to false.Optional

Please note that while none of the fields above are individually required, you must supply at least one of these fields.

Example​

{
    "type": "conversations_select",
    "placeholder": {
        "type": "plain_text",
        "text": "Select a conversation",
        "emoji": true
    },
    "filter": {
        "include": [
            "public",
            "mpim"
        ],
        "exclude_bot_users": true
    }
}

Known issues​

  • In iOS, the placeholder text is replaced with "0 selected" when there are no selected conversations.

  • In iOS, there are UI inconsistencies when users select items in multi-select menus.