Box Developerドキュメントの新しいベータ版サイトがまもなくリリースされる予定です。最新の開発者向けガイド、APIリファレンス、AI搭載の検索により、Boxを使用した迅速な開発をサポートします。更新情報については今しばらくお待ちください。
最新バージョン
アーカイブを更新
APIバージョン 2025.0
アーカイブを更新します。
アーカイブのAPIの詳細については、Archive APIガイドを参照してください。
レスポンス
application/jsonArchive
更新されたアーカイブオブジェクトを返します。
application/jsonクライアントエラー
一部のパラメータが無効な場合に返されます。
application/jsonクライアントエラー
Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。
application/jsonクライアントエラー
認証済みユーザーにアーカイブを更新するための適切な権限がない場合に返されます。
application/jsonクライアントエラー
アーカイブが見つからない場合に返されます。
application/jsonクライアントエラー
指定した名前を持つアーカイブがすでに存在する場合に返されます。
application/jsonクライアントエラー
予期しないサーバーエラーが発生した場合に返されます。
application/jsonクライアントエラー
予期しないクライアントエラーが発生した場合に返されます。
リクエストの例
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);Python v10
client.archives.update_archive_by_id_v2025_r0(
archive.id, name=new_archive_name, description=new_archive_description
).NET v10
await client.Archives.UpdateArchiveByIdV2025R0Async(archiveId: archive.Id, requestBody: new UpdateArchiveByIdV2025R0RequestBody() { Name = newArchiveName, Description = newArchiveDescription });Swift v10
try await client.archives.updateArchiveByIdV2025R0(archiveId: archive.id, requestBody: UpdateArchiveByIdV2025R0RequestBody(name: newArchiveName, description: newArchiveDescription))Java v10
client.getArchives().updateArchiveByIdV2025R0(archive.getId(), new UpdateArchiveByIdV2025R0RequestBody.Builder().name(newArchiveName).description(newArchiveDescription).build()).NET v6
await client.Archives.UpdateArchiveByIdV2025R0Async(archiveId: archive.Id, requestBody: new UpdateArchiveByIdV2025R0RequestBody() { Name = newArchiveName, Description = newArchiveDescription });Node v4
await client.archives.updateArchiveByIdV2025R0(archive.id, {
requestBody: {
name: newArchiveName,
description: newArchiveDescription,
} satisfies UpdateArchiveByIdV2025R0RequestBody,
} satisfies UpdateArchiveByIdV2025R0OptionalsInput);レスポンスの例
{
"id": "12345",
"type": "archive",
"description": "This is an archive for important documents.",
"name": "Archive",
"owned_by": {
"id": "12345",
"type": "user"
},
"size": 123456789
}