- List Slack integration mappings
- Create Slack integration mapping
- Update Slack integration mapping
- Delete Slack integration mapping
- List Teams integration mappings
- Create Teams integration mapping
- Update Teams integration mapping
- Delete Teams integration mapping
Lists Slack integration mappings in a users' enterprise.
You need Admin or Co-Admin role to use this endpoint.
This operation is performed by calling function getSlackIntegrationMapping.
See the endpoint docs at API Reference.
await userClient.integrationMappings.getSlackIntegrationMapping();- queryParams
GetSlackIntegrationMappingQueryParams- Query parameters of getSlackIntegrationMapping method
- headersInput
GetSlackIntegrationMappingHeadersInput- Headers of getSlackIntegrationMapping method
- cancellationToken
undefined | CancellationToken- Token used for request cancellation.
This function returns a value of type IntegrationMappings.
Returns a collection of integration mappings.
Creates a Slack integration mapping by mapping a Slack channel to a Box item.
You need Admin or Co-Admin role to use this endpoint.
This operation is performed by calling function createSlackIntegrationMapping.
See the endpoint docs at API Reference.
await userClient.integrationMappings.createSlackIntegrationMapping({
partnerItem: new IntegrationMappingPartnerItemSlack({
id: slackPartnerItemId,
slackOrgId: slackOrgId,
}),
boxItem: new IntegrationMappingBoxItemSlack({ id: folder.id }),
} satisfies IntegrationMappingSlackCreateRequest);- requestBody
IntegrationMappingSlackCreateRequest- Request body of createSlackIntegrationMapping method
- optionalsInput
CreateSlackIntegrationMappingOptionalsInput
This function returns a value of type IntegrationMapping.
Returns the created integration mapping.
Updates a Slack integration mapping. Supports updating the Box folder ID and options.
You need Admin or Co-Admin role to use this endpoint.
This operation is performed by calling function updateSlackIntegrationMappingById.
See the endpoint docs at API Reference.
await userClient.integrationMappings.updateSlackIntegrationMappingById(
slackIntegrationMapping.id,
{
requestBody: {
boxItem: new IntegrationMappingBoxItemSlack({ id: folder.id }),
} satisfies UpdateSlackIntegrationMappingByIdRequestBody,
} satisfies UpdateSlackIntegrationMappingByIdOptionalsInput,
);- integrationMappingId
string- An ID of an integration mapping. Example: "11235432"
- optionalsInput
UpdateSlackIntegrationMappingByIdOptionalsInput
This function returns a value of type IntegrationMapping.
Returns the updated integration mapping object.
Deletes a Slack integration mapping.
You need Admin or Co-Admin role to use this endpoint.
This operation is performed by calling function deleteSlackIntegrationMappingById.
See the endpoint docs at API Reference.
await userClient.integrationMappings.deleteSlackIntegrationMappingById(
slackIntegrationMapping.id,
);- integrationMappingId
string- An ID of an integration mapping. Example: "11235432"
- optionalsInput
DeleteSlackIntegrationMappingByIdOptionalsInput
This function returns a value of type undefined.
Empty body in response.
Lists Teams integration mappings in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.
This operation is performed by calling function getTeamsIntegrationMapping.
See the endpoint docs at API Reference.
await userClient.integrationMappings.getTeamsIntegrationMapping();- queryParams
GetTeamsIntegrationMappingQueryParams- Query parameters of getTeamsIntegrationMapping method
- headersInput
GetTeamsIntegrationMappingHeadersInput- Headers of getTeamsIntegrationMapping method
- cancellationToken
undefined | CancellationToken- Token used for request cancellation.
This function returns a value of type IntegrationMappingsTeams.
Returns a collection of integration mappings.
Creates a Teams integration mapping by mapping a Teams channel to a Box item. You need Admin or Co-Admin role to use this endpoint.
This operation is performed by calling function createTeamsIntegrationMapping.
See the endpoint docs at API Reference.
await userClient.integrationMappings.createTeamsIntegrationMapping({
partnerItem: {
type: 'channel' as IntegrationMappingPartnerItemTeamsCreateRequestTypeField,
id: partnerItemId,
tenantId: tenantId,
teamId: teamId,
} satisfies IntegrationMappingPartnerItemTeamsCreateRequest,
boxItem: new FolderReference({ id: folder.id }),
} satisfies IntegrationMappingTeamsCreateRequest);- requestBody
IntegrationMappingTeamsCreateRequest- Request body of createTeamsIntegrationMapping method
- optionalsInput
CreateTeamsIntegrationMappingOptionalsInput
This function returns a value of type IntegrationMappingTeams.
Returns the created integration mapping.
Updates a Teams integration mapping. Supports updating the Box folder ID and options. You need Admin or Co-Admin role to use this endpoint.
This operation is performed by calling function updateTeamsIntegrationMappingById.
See the endpoint docs at API Reference.
await userClient.integrationMappings.updateTeamsIntegrationMappingById(
integrationMappingId,
{
requestBody: {
boxItem: new FolderReference({ id: '1234567' }),
} satisfies UpdateTeamsIntegrationMappingByIdRequestBody,
} satisfies UpdateTeamsIntegrationMappingByIdOptionalsInput,
);- integrationMappingId
string- An ID of an integration mapping. Example: "11235432"
- optionalsInput
UpdateTeamsIntegrationMappingByIdOptionalsInput
This function returns a value of type IntegrationMappingTeams.
Returns the updated integration mapping object.
Deletes a Teams integration mapping. You need Admin or Co-Admin role to use this endpoint.
This operation is performed by calling function deleteTeamsIntegrationMappingById.
See the endpoint docs at API Reference.
await userClient.integrationMappings.deleteTeamsIntegrationMappingById(
integrationMappingId,
);- integrationMappingId
string- An ID of an integration mapping. Example: "11235432"
- optionalsInput
DeleteTeamsIntegrationMappingByIdOptionalsInput
This function returns a value of type undefined.
Empty body in response.