root.scopeConstraints object

The scope constraints imposed on an app to specify in which threads you can install the app. When no constraints are specified, you can install the app to all threads within the specific scope.

Properties that reference this object type:

• root.scopeConstraints

Syntax

Syntax

{
  "teams": [
    {
      "id": "{string}"
    }
  ],
  "groupChats": [
    {
      "id": "{string}"
    }
  ]
}

Schema

{
  "type": "object",
  "properties": {
    "teams": {
      "type": "array",
      "description": "A list of team thread ids to which your app is restricted to",
      "maxItems": 128,
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Team\u0027s thread Id",
            "type": "string",
            "maxLength": 64
          }
        },
        "required": [
          "id"
        ],
        "additionalProperties": false
      }
    },
    "groupChats": {
      "type": "array",
      "description": "A list of chat thread ids to which your app is restricted to",
      "maxItems": 128,
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "description": "Chat\u0027s thread Id",
            "type": "string",
            "maxLength": 64
          }
        },
        "required": [
          "id"
        ],
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}

Properties

teams

A list of team thread ids to which your app is restricted to.

Type
Array of teams

Required
—

Constraints
Maximum array items: 128.

Supported values

groupChats

A list of chat thread ids to which your app is restricted to.

Type
Array of groupChats

Required
—

Constraints
Maximum array items: 128.

Supported values

Examples

{
    "scopeConstraints": { 
        "teams": [ 
            { "id": "%TEAMS-THREAD-ID" } 
        ], 
        "groupChats": [ 
          { "id": "%GROUP-CHATS-THREAD-ID" } 
        ] 
    }
}