Join BoxWorks 2024 to discover what's possible with content and AI!

Update Slack integration mapping

put

https://api.box.com/2.0

/integration_mappings/slack/:integration_mapping_id

Updates a Slack integration mapping. Supports updating the Box folder ID and options.

You need Admin or Co-Admin role to use this endpoint.

Related Guides

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Path Parameters

integration_mapping_id stringin pathrequired

example11235432

An ID of an integration mapping

Request Body

box_item objectin body

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

box_item.id stringin bodyoptional

example"1234567891"

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

box_item.type stringin bodyoptional

example"folder"

Type of the mapped item referenced in id

Value is always folder

options objectin body

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

options.is_access_management_disabled booleanin bodyoptional

exampletrue

Indicates whether or not channel member access to the underlying box item should be automatically managed. Depending on type of channel, access is managed through creating collaborations or shared links.

Response

200application/jsonIntegration mapping Slack

Returns the updated integration mapping object.

400application/jsonClient error

Returns a bad_request if an incorrect options was supplied or the Box folder cannot be mapped to this partner_item. Error codes:

SERVICE_ACCOUNT_IS_NOT_A_COOWNER_OR_OWNER - service account doesn't have co-owner collaboration or is not an owner of the box_item_id,
BOX_FOLDER_EXTERNALLY_OWNED - Box folder must be internally owned to the admin's enterprise,
JWT_APP_NOT_AUTHORIZED - JWT authorization error.

404application/jsonClient error

Returns not_found if integration mapping object was not found.

defaultapplication/jsonClient error

An unexpected client error.

put

Update Slack integration mapping

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -X -L PUT "https://api.box.com/2.0/integration_mappings/slack/512521" \
     -H "authorization: Bearer <ACCESS_TOKEN>"  \
     -H 'content-type: application/json'  \
     -d'{
         "options": {
            "is_access_management_disabled": true
        }
    }'

Node

const mapping = await client.integrationMappings.updateSlackIntegrationMapping({
	box_item: {
		id: '12345',
		type: 'folder'
	},
	options: {
		is_access_management_disabled: true
	}
}, {
	integration_mapping_id: integrationMappingId
});

console.log(
    `Slack integration mapping with id ${mapping.id} was updated`
);

Response Example

{
  "id": "12345",
  "type": "integration_mapping",
  "box_item": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "integration_type": "slack",
  "is_manually_created": true,
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "options": {
    "is_access_management_disabled": true
  },
  "partner_item": {
    "id": "C12378991223",
    "type": "channel",
    "slack_org_id": "E1234567"
  }
}