Box é uma plataforma líder de gerenciamento de conteúdo na nuvem e compartilhamento de arquivos, usada por empresas em todo o mundo para armazenar, gerenciar e colaborar em arquivos com segurança. O Box oferece APIs robustas para automatizar operações de arquivos e integrar-se a fluxos de trabalho de negócios, incluindo o Box Sign para assinaturas eletrônicas nativas.
Com a integração do Box no Zoen, você pode:
- Enviar arquivos: Envie documentos, imagens e outros arquivos para qualquer pasta do Box
- Baixar arquivos: Recupere o conteúdo de arquivos do Box para processamento nos seus fluxos de trabalho
- Obter informações do arquivo: Acesse metadados detalhados, incluindo tamanho, proprietário, timestamps, tags e links compartilhados
- Listar conteúdo de pastas: Navegue por arquivos e pastas com suporte a ordenação e paginação
- Criar pastas: Organize seu armazenamento no Box criando novas pastas de forma programática
- Excluir arquivos e pastas: Remova conteúdo com exclusão recursiva opcional para pastas
- Copiar arquivos: Duplique arquivos entre pastas com opção de renomeação
- Pesquisar: Encontre arquivos e pastas por nome, conteúdo, extensão ou localização
- Atualizar metadados do arquivo: Renomeie, mova, adicione descrições ou marque arquivos com tags
- Criar solicitações de assinatura: Envie documentos para assinatura eletrônica com um ou mais signatários
- Acompanhar status da assinatura: Monitore o progresso das solicitações de assinatura
- Listar solicitações de assinatura: Veja todas as solicitações de assinatura com paginação baseada em marcadores
- Cancelar solicitações de assinatura: Cancele solicitações pendentes que não são mais necessárias
- Reenviar lembretes de assinatura: Envie notificações de lembrete a signatários que ainda não concluíram a assinatura
Essas capacidades permitem que seus agentes Zoen automatizem operações do Box diretamente nos seus fluxos de trabalho — desde organizar documentos e distribuir conteúdo até processar arquivos enviados, gerenciar fluxos de assinatura eletrônica para cartas de oferta e contratos, e manter um armazenamento em nuvem estruturado como parte dos seus processos de negócio.
Integrate Box into your workflow to manage files, folders, and e-signatures. Upload and download files, search content, create folders, send documents for e-signature, track signing status, and more.
Upload a file to a Box folder
| Parameter | Type | Required | Description |
|---|
parentFolderId | string | Yes | The ID of the folder to upload the file to (use "0" for root) |
file | file | No | The file to upload (UserFile object) |
fileContent | string | No | Legacy: base64 encoded file content |
fileName | string | No | Optional filename override |
| Parameter | Type | Description |
|---|
id | string | File ID |
name | string | File name |
size | number | File size in bytes |
sha1 | string | SHA1 hash of file content |
createdAt | string | Creation timestamp |
modifiedAt | string | Last modified timestamp |
parentId | string | Parent folder ID |
parentName | string | Parent folder name |
Download a file from Box
| Parameter | Type | Required | Description |
|---|
fileId | string | Yes | The ID of the file to download |
| Parameter | Type | Description |
|---|
file | file | Downloaded file stored in execution files |
content | string | Base64 encoded file content |
Get detailed information about a file in Box
| Parameter | Type | Required | Description |
|---|
fileId | string | Yes | The ID of the file to get information about |
| Parameter | Type | Description |
|---|
id | string | File ID |
name | string | File name |
description | string | File description |
size | number | File size in bytes |
sha1 | string | SHA1 hash of file content |
createdAt | string | Creation timestamp |
modifiedAt | string | Last modified timestamp |
createdBy | object | User who created the file |
modifiedBy | object | User who last modified the file |
ownedBy | object | User who owns the file |
parentId | string | Parent folder ID |
parentName | string | Parent folder name |
sharedLink | json | Shared link details |
tags | array | File tags |
commentCount | number | Number of comments |
List files and folders in a Box folder
| Parameter | Type | Required | Description |
|---|
folderId | string | Yes | The ID of the folder to list items from (use "0" for root) |
limit | number | No | Maximum number of items to return per page |
offset | number | No | The offset for pagination |
sort | string | No | Sort field: id, name, date, or size |
direction | string | No | Sort direction: ASC or DESC |
| Parameter | Type | Description |
|---|
entries | array | List of items in the folder |
↳ type | string | Item type (file, folder, web_link) |
↳ id | string | Item ID |
↳ name | string | Item name |
↳ size | number | Item size in bytes |
↳ createdAt | string | Creation timestamp |
↳ modifiedAt | string | Last modified timestamp |
totalCount | number | Total number of items in the folder |
offset | number | Current pagination offset |
limit | number | Current pagination limit |
Create a new folder in Box
| Parameter | Type | Required | Description |
|---|
name | string | Yes | Name for the new folder |
parentFolderId | string | Yes | The ID of the parent folder (use "0" for root) |
| Parameter | Type | Description |
|---|
id | string | Folder ID |
name | string | Folder name |
createdAt | string | Creation timestamp |
modifiedAt | string | Last modified timestamp |
parentId | string | Parent folder ID |
parentName | string | Parent folder name |
Delete a file from Box
| Parameter | Type | Required | Description |
|---|
fileId | string | Yes | The ID of the file to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the file was successfully deleted |
message | string | Success confirmation message |
Delete a folder from Box
| Parameter | Type | Required | Description |
|---|
folderId | string | Yes | The ID of the folder to delete |
recursive | boolean | No | Delete folder and all its contents recursively |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the folder was successfully deleted |
message | string | Success confirmation message |
Copy a file to another folder in Box
| Parameter | Type | Required | Description |
|---|
fileId | string | Yes | The ID of the file to copy |
parentFolderId | string | Yes | The ID of the destination folder |
name | string | No | Optional new name for the copied file |
| Parameter | Type | Description |
|---|
id | string | File ID |
name | string | File name |
size | number | File size in bytes |
sha1 | string | SHA1 hash of file content |
createdAt | string | Creation timestamp |
modifiedAt | string | Last modified timestamp |
parentId | string | Parent folder ID |
parentName | string | Parent folder name |
Search for files and folders in Box
| Parameter | Type | Required | Description |
|---|
query | string | Yes | The search query string |
limit | number | No | Maximum number of results to return |
offset | number | No | The offset for pagination |
ancestorFolderId | string | No | Restrict search to a specific folder and its subfolders |
fileExtensions | string | No | Comma-separated file extensions to filter by (e.g., pdf,docx) |
type | string | No | Restrict to a specific content type: file, folder, or web_link |
| Parameter | Type | Description |
|---|
results | array | Search results |
↳ type | string | Item type (file, folder, web_link) |
↳ id | string | Item ID |
↳ name | string | Item name |
↳ size | number | Item size in bytes |
↳ createdAt | string | Creation timestamp |
↳ modifiedAt | string | Last modified timestamp |
↳ parentId | string | Parent folder ID |
↳ parentName | string | Parent folder name |
totalCount | number | Total number of matching results |
Update file info in Box (rename, move, change description, add tags)
| Parameter | Type | Required | Description |
|---|
fileId | string | Yes | The ID of the file to update |
name | string | No | New name for the file |
description | string | No | New description for the file (max 256 characters) |
parentFolderId | string | No | Move the file to a different folder by specifying the folder ID |
tags | string | No | Comma-separated tags to set on the file |
| Parameter | Type | Description |
|---|
id | string | File ID |
name | string | File name |
description | string | File description |
size | number | File size in bytes |
sha1 | string | SHA1 hash of file content |
createdAt | string | Creation timestamp |
modifiedAt | string | Last modified timestamp |
createdBy | object | User who created the file |
modifiedBy | object | User who last modified the file |
ownedBy | object | User who owns the file |
parentId | string | Parent folder ID |
parentName | string | Parent folder name |
sharedLink | json | Shared link details |
tags | array | File tags |
commentCount | number | Number of comments |
Create a new Box Sign request to send documents for e-signature
| Parameter | Type | Required | Description |
|---|
sourceFileIds | string | Yes | Comma-separated Box file IDs to send for signing |
signerEmail | string | Yes | Primary signer email address |
signerRole | string | No | Primary signer role: signer, approver, or final_copy_reader (default: signer) |
additionalSigners | string | No | JSON array of additional signers, e.g. [{"email":"user@example.com","role":"signer"}] |
parentFolderId | string | No | Box folder ID where signed documents will be stored (default: user root) |
emailSubject | string | No | Custom subject line for the signing email |
emailMessage | string | No | Custom message in the signing email body |
name | string | No | Name for the sign request |
daysValid | number | No | Number of days before the request expires (0-730) |
areRemindersEnabled | boolean | No | Whether to send automatic signing reminders |
areTextSignaturesEnabled | boolean | No | Whether to allow typed (text) signatures |
signatureColor | string | No | Signature color: blue, black, or red |
redirectUrl | string | No | URL to redirect signers to after signing |
declinedRedirectUrl | string | No | URL to redirect signers to after declining |
isDocumentPreparationNeeded | boolean | No | Whether document preparation is needed before sending |
externalId | string | No | External system reference ID |
| Parameter | Type | Description |
|---|
id | string | Sign request ID |
status | string | Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing) |
name | string | Sign request name |
shortId | string | Human-readable short ID |
signers | array | List of signers |
sourceFiles | array | Source files for signing |
emailSubject | string | Custom email subject line |
emailMessage | string | Custom email message body |
daysValid | number | Number of days the request is valid |
createdAt | string | Creation timestamp |
autoExpireAt | string | Auto-expiration timestamp |
prepareUrl | string | URL for document preparation (if preparation is needed) |
senderEmail | string | Email of the sender |
Get the details and status of a Box Sign request
| Parameter | Type | Required | Description |
|---|
signRequestId | string | Yes | The ID of the sign request to retrieve |
| Parameter | Type | Description |
|---|
id | string | Sign request ID |
status | string | Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing) |
name | string | Sign request name |
shortId | string | Human-readable short ID |
signers | array | List of signers |
sourceFiles | array | Source files for signing |
emailSubject | string | Custom email subject line |
emailMessage | string | Custom email message body |
daysValid | number | Number of days the request is valid |
createdAt | string | Creation timestamp |
autoExpireAt | string | Auto-expiration timestamp |
prepareUrl | string | URL for document preparation (if preparation is needed) |
senderEmail | string | Email of the sender |
List all Box Sign requests
| Parameter | Type | Required | Description |
|---|
limit | number | No | Maximum number of sign requests to return (max 1000) |
marker | string | No | Pagination marker from a previous response |
| Parameter | Type | Description |
|---|
signRequests | array | List of sign requests |
↳ id | string | Sign request ID |
↳ status | string | Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing) |
↳ name | string | Sign request name |
↳ shortId | string | Human-readable short ID |
↳ signers | array | List of signers |
↳ sourceFiles | array | Source files for signing |
↳ emailSubject | string | Custom email subject line |
↳ emailMessage | string | Custom email message body |
↳ daysValid | number | Number of days the request is valid |
↳ createdAt | string | Creation timestamp |
↳ autoExpireAt | string | Auto-expiration timestamp |
↳ prepareUrl | string | URL for document preparation (if preparation is needed) |
↳ senderEmail | string | Email of the sender |
count | number | Number of sign requests returned in this page |
nextMarker | string | Marker for next page of results |
Cancel a pending Box Sign request
| Parameter | Type | Required | Description |
|---|
signRequestId | string | Yes | The ID of the sign request to cancel |
| Parameter | Type | Description |
|---|
id | string | Sign request ID |
status | string | Request status (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing) |
name | string | Sign request name |
shortId | string | Human-readable short ID |
signers | array | List of signers |
sourceFiles | array | Source files for signing |
emailSubject | string | Custom email subject line |
emailMessage | string | Custom email message body |
daysValid | number | Number of days the request is valid |
createdAt | string | Creation timestamp |
autoExpireAt | string | Auto-expiration timestamp |
prepareUrl | string | URL for document preparation (if preparation is needed) |
senderEmail | string | Email of the sender |
Resend a Box Sign request to signers who have not yet signed
| Parameter | Type | Required | Description |
|---|
signRequestId | string | Yes | The ID of the sign request to resend |
| Parameter | Type | Description |
|---|
message | string | Success confirmation message |