Skip to main content
PUT
/
archives
/
{archive_id}
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"
     }'
{
  "id": "12345",
  "type": "archive",
  "name": "Archive",
  "size": 123456789,
  "description": "This is an archive for important documents.",
  "owned_by": {
    "id": "12345",
    "type": "user"
  }
}
「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
box-version
enum<string>
required

Version header.

Available options:
2025.0

Path Parameters

​
archive_id
string
required

アーカイブのID。

Body

application/json
​
name
string

アーカイブの名前。

Example:

"Some Archive"

​
description
string

アーカイブの説明。

Example:

"This is an archive for important documents."

Response

更新されたアーカイブオブジェクトを返します。

アーカイブとは、冗長なコンテンツ、古くなったコンテンツ、または重要でないコンテンツの保存専用のフォルダです。アーカイブ内のコンテンツには、その所有者とコラボレータはアクセスできません。この機能を使用するには、Boxアプリケーションに対してGCMスコープをリクエストする必要があります。

​
id
string
required

アーカイブを表す一意の識別子。

Example:

"12345"

​
type
enum<string>
required

値は常にarchiveになります。

Available options:
archive
Example:

"archive"

​
name
string
required

アーカイブの名前。

アーカイブ名には、印刷不可能なASCII文字、スラッシュ、バックスラッシュ (/、\) を含む名前、末尾にスペースを含む名前、.および..という名前は使用できないという制限が適用されます。

Required string length: 1 - 100
Example:

"Archive"

​
size
integer<int64>
required

アーカイブのサイズ (バイト単位)。

Example:

123456789

​
description
string | null

アーカイブの説明。

Maximum string length: 255
Example:

"This is an archive for important documents."

​
owned_by
object

アーカイブを所有するユーザーについて説明している、アーカイブAPIレスポンスの部分。

Example:
{ "id": "12345", "type": "user" }