Sample - Box Platform API
PUT/integration_mappings/teams/{integration_mapping_id}

Update a Teams integration mapping

Updates a Teams integration mapping. Supply box_item to change the Box folder associated with the partner item, and use this operation with an Admin or Co-Admin role. A successful response returns the updated integration mapping object.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 1 body field
integration_mapping_idstringrequired
The unique identifier of the integration mapping to update.

Optional Teams integration mapping changes. Supply box_item to update the mapped Box folder.

box_itemobjectoptional
The Box folder to map to the partner item, represented by a folder reference with its `type` and `id`.

4 status codes
200Returns the updated Teams integration mapping object, including its partner item, Box item, integration type, and modification details.
idstringrequired
A unique identifier of a folder mapping (part of a composite key together with `integration_type`).
typestringrequired
Mapping type.
Allowed:integration_mapping
integration_typestringoptional
Identifies the Box partner app, with which the mapping is associated. Supports Slack and Teams. (part of the composite key together with `id`).
Allowed:teams
is_overridden_by_manual_mappingbooleanoptional
Identifies whether the mapping has been manually set by the team owner from UI for channels (as opposed to being automatically created).
partner_itemobjectrequired
Mapped item object for Teams.
box_itemobjectrequired
created_atstringoptional
When the integration mapping object was created.
modified_atstringoptional
When the integration mapping object was last modified.
400Returned when an incorrect `options` value is supplied or the Box folder cannot be mapped to the partner item because it is externally owned, already mapped, or otherwise invalid.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
404Returned when the specified integration mapping object is not found.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 400 is returned when an incorrect options value is supplied or the Box folder cannot be mapped to the partner item, including when the folder is externally owned or already mapped. A 404 is returned when the integration_mapping_id does not identify an integration mapping. Use an Admin or Co-Admin role and provide a valid box_item folder reference.