Latest version
Update archive
API version 2025.0
Updates an archive.
To learn more about the archive APIs, see the Archive API Guide.
Request
bearer [ACCESS_TOKEN]
application/json
Request Headers
stringin headerrequired
Version header.
Value is always 2025.0
Path Parameters
stringin pathrequired
982312The ID of the archive.
Request Body
stringin bodyoptional
"This is an archive for important documents."The description of the archive.
stringin bodyoptional
"Some Archive"The name of the archive.
Response
application/jsonArchive
Returns the updated archive object.
application/jsonClient error
Returned when some of the parameters are not valid.
application/jsonClient error
Returned when the access token provided in the Authorization header
is not recognized or not provided.
application/jsonClient error
Returned when the authenticated user does not have the right permissions to update the archive.
application/jsonClient error
Returned when the archive is not found.
application/jsonClient error
Returned when an archive with the given name already exists.
application/jsonClient error
Returned when an unexpected server error occurs.
application/jsonClient error
Returned when an unexpected client error occurs.
Request Example
cURL
curl -i -X PUT "https://api.box.com/2.0/archives/12345" \
-H "box-version: 2025.0" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"name": "Some Archive Name",
"description": "Some Archive Description"
}'Node/TypeScript v10
await client.archives.updateArchiveByIdV2025R0(archive.id, {
requestBody: {
name: newArchiveName,
description: newArchiveDescription,
} satisfies UpdateArchiveByIdV2025R0RequestBody,
} satisfies UpdateArchiveByIdV2025R0OptionalsInput);Response Example
{
"id": "12345",
"type": "archive",
"description": "This is an archive for important documents.",
"name": "Archive",
"owned_by": {
"id": "12345",
"type": "user"
},
"size": 123456789
}