Conversation filter object

Limits which conversations a conversations select menu or conversations multi-select menu offers.


Used in	Select menu element, Multi-select menu element

Usage

Set it as the filter field of a conversations_select or multi_conversations_select element. None of its fields is required on its own, but you must supply at least one.

Fields

Field	Type	Description	Required?
`include`	String[]	Which kinds of conversation to list. Any conversation that doesn’t match is left out. One or more of `im`, `mpim`, `private` and `public`. The array can’t be empty.	Optional
`exclude_external_shared_channels`	Boolean	Whether to leave out channels shared with other organisations. Defaults to `false`.	Optional
`exclude_bot_users`	Boolean	Whether to leave out conversations with bot users. Defaults to `false`.	Optional

Examples

Pick a public or private channel

{
  "blocks": [
    {
      "type": "section",
      "text": {
        "type": "mrkdwn",
        "text": "Where should the daily sales summary be posted?"
      },
      "accessory": {
        "type": "conversations_select",
        "action_id": "summary_channel",
        "placeholder": {
          "type": "plain_text",
          "text": "Select a channel"
        },
        "filter": {
          "include": [
            "public",
            "private"
          ],
          "exclude_bot_users": true
        }
      }
    }
  ]
}

This example belongs in a modal view.

{
  "blocks": [
    {
      "type": "input",
      "label": {
        "type": "plain_text",
        "text": "Notify these direct messages"
      },
      "element": {
        "type": "multi_conversations_select",
        "action_id": "notify_dms",
        "placeholder": {
          "type": "plain_text",
          "text": "Select conversations"
        },
        "filter": {
          "include": [
            "im"
          ]
        }
      }
    }
  ]
}