Conversation filter object

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

Field	Type	Description	Required?
include	String[]	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_channels	Boolean	Indicates whether to exclude external shared channels from conversation lists. This field will not exclude users from shared channels. Defaults to false.	Optional
exclude_bot_users	Boolean	Indicates 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

The conversations select composition object must be used within the section block, actions block, or input block. This example shows an input block containing the conversations select object.

{
    "title": {
        "type": "plain_text",
        "text": "My App",
        "emoji": true
    },
    "submit": {
        "type": "plain_text",
        "text": "Submit",
        "emoji": true
    },
    "type": "modal",
    "close": {
        "type": "plain_text",
        "text": "Cancel",
        "emoji": true
    },
    "blocks": [
        {
            "type": "input",
            "element": {
                "type": "conversations_select",
                "placeholder": {
                    "type": "plain_text",
                    "text": "Select a conversation",
                    "emoji": true
                },
                "filter": {
                    "include": [
                        "public",
                        "mpim"
                    ],
                    "exclude_bot_users": true
                }
            },
            "label": {
                "type": "plain_text",
                "text": "Choose the conversation to publish your result to:",
                "emoji": true
            }
        }
    ]
}

View in Block Kit Builder

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.

---