Skip to main content
POST
/
integration_mappings
/
slack
cURL
curl -X -L POST "https://api.box.com/2.0/integration_mappings/slack" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H 'content-type: application/json' \
     -d '{
          "partner_item": {
              "id": "C987654321",
              "type": "channel",
              "slack_workspace_id": "T5555555"
          },
          "box_item": {
              "id": "123456789",
              "type": "folder"
          }
      }'
{
  "id": "12345",
  "type": "integration_mapping",
  "partner_item": {
    "id": "C12378991223",
    "type": "channel",
    "slack_org_id": "E1234567"
  },
  "box_item": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "integration_type": "slack",
  "is_manually_created": true,
  "options": {
    "is_access_management_disabled": true
  },
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "[email protected]"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00"
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

A request to create a Slack Integration Mapping object.

​
partner_item
Integration mapping mapped item schema for type Slack · object
required

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

Depending if Box for Slack is installed at the org or workspace level, provide either slack_org_id or slack_workspace_id. Do not use both parameters at the same time.

​
box_item
Integration mapping Box item schema for type Slack · object
required

The schema for an integration mapping Box item object for type Slack.

​
options
Integration mapping options for type Slack · object

The schema for an integration mapping options object for Slack type.

Response

Returns the created integration mapping.

A Slack specific representation of an integration mapping object.

​
id
string
required

A unique identifier of a folder mapping (part of a composite key together with integration_type).

Example:

"12345"

​
type
enum<string>
required

Mapping type.

Available options:
integration_mapping
Example:

"integration_mapping"

​
partner_item
Integration mapping mapped item schema for type Slack · object
required

Mapped item object for Slack.

Example:
{
  "id": "C12378991223",
  "type": "channel",
  "slack_org_id": "E1234567"
}
​
box_item
Folder (Mini) · object
required

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

​
integration_type
enum<string>

Identifies the Box partner app, with which the mapping is associated. Currently only supports Slack. (part of the composite key together with id).

Available options:
slack
Example:

"slack"

​
is_manually_created
boolean

Identifies whether the mapping has been manually set (as opposed to being automatically created).

Example:

true

​
options
Integration mapping options for type Slack · object

The schema for an integration mapping options object for Slack type.

​
created_by
User (Integration Mappings) · object

An object representing the user who created the integration mapping.

​
modified_by
User (Integration Mappings) · object

The user who last modified the integration mapping.

​
created_at
string<date-time>

When the integration mapping object was created.

Example:

"2012-12-12T10:53:43-08:00"

​
modified_at
string<date-time>

When the integration mapping object was last modified.

Example:

"2012-12-12T10:53:43-08:00"