Box · Schema
Create a `zip` archive
A request to create a `zip` archive to download
Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing
Properties
| Name | Type | Description |
|---|---|---|
| items | array | A list of items to add to the `zip` archive. These can be folders or files. |
| download_file_name | string | The optional name of the `zip` archive. This name will be appended by the `.zip` file extension, for example `January Financials.zip`. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ZipDownloadRequest",
"title": "Create a `zip` archive",
"type": "object",
"description": "A request to create a `zip` archive to download",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"description": "A list of items to add to the `zip` archive. These can\nbe folders or files.",
"items": {
"type": "object",
"description": "An item to add to the `zip` archive. This can be a file or a folder.",
"required": [
"type",
"id"
],
"properties": {
"type": {
"type": "string",
"description": "The type of the item to add to the archive.",
"example": "file",
"enum": [
"file",
"folder"
]
},
"id": {
"type": "string",
"description": "The identifier of the item to add to the archive. When this item is\na folder then this can not be the root folder with ID `0`.",
"example": "12345"
}
}
}
},
"download_file_name": {
"type": "string",
"description": "The optional name of the `zip` archive. This name will be appended by the\n`.zip` file extension, for example `January Financials.zip`.",
"example": "January Financials"
}
}
}