A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Create teams integration mapping request

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

A request to create a Teams Integration Mapping object.

box_item object

The Box folder, to which the object from the partner app domain (referenced in partner_item_id) is mapped.

box_item.id string

example42037322

ID of the folder.

box_item.type string

examplefolder

The value will always be folder.

Value is always folder

partner_item object

The schema for an integration mapping mapped item object for type Teams.

partner_item.id string

example19%ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2

ID of the mapped item (of type referenced in type).

partner_item.type string

examplechannel

Type of the mapped item referenced in id.

Value is one of channel,team

partner_item.team_id string

examplehjgjgjg-bhhj-564a-b643-hghgj685u

ID of the team that is registered with Microsoft Teams.

partner_item.tenant_id string

exampleabcd-defg-1235-7890

ID of the tenant that is registered with Microsoft Teams.

Response Example

{
  "box_item": {
    "id": "42037322",
    "type": "folder"
  },
  "partner_item": {
    "id": "19%ABCD-Avgfggkggyftdtfgghjhkhkhh%40thread:tacv2",
    "type": "channel",
    "team_id": "hjgjgjg-bhhj-564a-b643-hghgj685u",
    "tenant_id": "abcd-defg-1235-7890"
  }
}