---
canonical_url: "https://docs.composio.dev/toolkits/csvbox"
markdown_url: "https://docs.composio.dev/toolkits/csvbox.md"
product: "platform"
version: null
last_updated: null
---

# CSVBox

CSVBox provides APIs for configuring spreadsheet importers and submitting spreadsheet files to connected destinations.

- **Category:** spreadsheets
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 4
- **Triggers:** 0
- **Slug:** `CSVBOX`
- **Version:** 00000000_00

## Tools

### Create CSVBox Sheet

**Slug:** `CSVBOX_CREATE_SHEET`

Create a CSVBox importer sheet. Only title is required; add nested columns, destinations, workflow steps, webhooks, or security settings when known. Creation is persistent because CSVBox documents no delete operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `steps` | object | No | Importer workflow configuration. |
| `title` | string | Yes | Human-readable title for the new importer sheet. |
| `webhooks` | array | No | Import-complete webhook configuration; omit to configure no webhook. |
| `destinations` | array | No | Destinations that receive imported rows. |
| `sheet_columns` | array | No | Importer columns in their intended order. |
| `security_settings` | object | No | Region, domain, and upload security controls. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Submit CSVBox File Import

**Slug:** `CSVBOX_SUBMIT_FILE_IMPORT`

Submit a publicly accessible spreadsheet URL to a CSVBox sheet for asynchronous delivery. This bypasses the sheet's validation rules, pushes rows in raw form to its configured destination, and may invoke import-complete webhooks. Call it only when the user intends those external side effects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | object | No | Custom user attributes to associate with the import and destination rows. |
| `auto_map` | boolean | No | Automatically map source columns to configured sheet columns when names or order differ. |
| `max_rows` | integer | No | Maximum number of source rows CSVBox should process. |
| `has_header` | boolean | No | Whether the first source row contains column headers. |
| `dynamic_columns` | array | No | Dynamic column definitions attached only to this import. |
| `file_sheet_name` | string | No | Worksheet name to import when the source file contains multiple sheets. |
| `public_file_url` | string | Yes | Publicly reachable HTTP or HTTPS URL of the spreadsheet to import. |
| `sheet_license_key` | string | Yes | License key of the destination-configured CSVBox sheet. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update CSVBox Sheet

**Slug:** `CSVBOX_UPDATE_SHEET`

Partially update an existing CSVBox importer sheet while preserving omitted top-level fields. A supplied nested array or object replaces that complete top-level setting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `steps` | object | No | Complete replacement workflow-step configuration; omit to preserve it. |
| `title` | string | No | New title; omit to leave the current title unchanged. |
| `webhooks` | array | No | Complete replacement webhook configuration; omit to preserve it. |
| `destinations` | array | No | Complete replacement destinations configuration; omit to preserve it. |
| `sheet_columns` | array | No | Complete replacement ordered column definitions; omit to preserve them. |
| `security_settings` | object | No | Complete replacement security settings; omit to preserve them. |
| `sheet_license_key` | string | Yes | License key of the sheet to update, returned by CREATE_SHEET. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify CSVBox Credentials

**Slug:** `CSVBOX_VERIFY_CREDENTIALS`

Verify the connected CSVBox API credentials and return the associated profile. Use this to diagnose connection or credential problems; it does not modify CSVBox data.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |