Sample - Box Platform API
PUT/files/{file_id}/metadata/global/boxSkillsCards

Update Box Skill cards on a file

Updates one or more Box Skill cards in the metadata assigned to a file. Supply JSON Patch replace operations whose paths identify the cards to replace, such as /cards/{index}.

1 parameter · 3 body fields
file_idstringrequired
The unique identifier of the file whose Box Skill cards to update.

An optional JSON Patch document containing operations that replace Box Skill cards in the file's skills metadata.

opstringoptional
The value will always be `replace`.
Allowed:replace
pathstringoptional
The JSON Path that represents the card to replace. In most cases this will be in the format `/cards/{index}` where `index` is the zero-indexed position of the card in the list of cards.
valueobjectoptional

3 status codes
200Returns the updated skills metadata instance with its custom template data and current `cards` list.
$canEditbooleanoptional
Whether the user can edit this metadata.
$idstringoptional
A UUID to identify the metadata object.
$parentstringoptional
An ID for the parent folder.
$scopestringoptional
An ID for the scope in which this template has been applied.
$templatestringoptional
The name of the template.
$typestringoptional
A unique identifier for the "type" of this instance. This is an internal system property and should not be used by a client application.
$typeVersionintegeroptional
The last-known version of the template of the object. This is an internal system property and should not be used by a client application.
$versionintegeroptional
The version of the metadata object. Starts at 0 and increases every time a user-defined property is modified.
cardsarray<BoxSkillCard>optional
A list of Box Skill cards that have been applied to this file.
404Returned when the requested file cannot be 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 404 is returned when the file identified by file_id cannot be found. Each patch operation uses replace for op, and path must identify the card position being replaced. Supply a valid Box Skill card in value.