Skip to main content

An archive is a folder dedicated to storing content that is redundant, outdated, or trivial. Content in an archive is not accessible to its owner and collaborators. To use this feature, you must request GCM scope for your Box application.

​
id
string
required

The unique identifier that represents an archive.

Example:

"12345"

​
type
enum<string>
required

The value is always archive.

Available options:
archive
Example:

"archive"

​
name
string
required

The name of the archive.

The following restrictions to the archive name apply: names containing non-printable ASCII characters, forward and backward slashes (/, \), names with trailing spaces, and names . and .. are not allowed.

Required string length: 1 - 100
Example:

"Archive"

​
size
integer<int64>
required

The size of the archive in bytes.

Example:

123456789

​
description
string | null

The description of the archive.

Maximum string length: 255
Example:

"This is an archive for important documents."

​
owned_by
object

The part of an archive API response that describes the user who owns the archive.

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