# Listclean

Listclean is an email verification service that helps users validate and clean their email lists to improve deliverability and maintain sender reputation.

- **Category:** email
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 16
- **Triggers:** 0
- **Slug:** `LISTCLEAN`
- **Version:** 20260227_00

## Tools

### Create Bulk Verification List

**Slug:** `LISTCLEAN_CREATE_BULK_VERIFICATION_LIST`

Tool to create a CSV file with provided email addresses for bulk verification. Use when you need to generate a file for bulk upload through LISTCLEAN_UPLOAD_LIST.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | List of valid email addresses to include in the CSV file |

#### 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 |

### Delete List

**Slug:** `LISTCLEAN_DELETE_LIST`

Tool to permanently delete a single list from the account. Use when you need to remove a list that is no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | The unique identifier of the list to delete |

#### 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 |

### Download List Results as CSV

**Slug:** `LISTCLEAN_DOWNLOAD_CSV`

Tool to download list results as a CSV file. Use when you need to retrieve verification results filtered by email type (clean, dirty, or unknown).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("clean" | "dirty" | "unknown") | Yes | Type of emails to download: 'clean' for valid emails, 'dirty' for invalid emails, or 'unknown' for unverified emails |
| `list_id` | integer | Yes | The ID of the email verification list to download |

#### 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 |

### Download List Results as JSON

**Slug:** `LISTCLEAN_DOWNLOAD_JSON`

Tool to download list results as JSON. Downloads emails filtered by type (clean, dirty, or unknown) in JSON format. Use after list verification is complete to retrieve filtered results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("clean" | "dirty" | "unknown") | Yes | Type of emails to download from the list |
| `list_id` | integer | Yes | Unique identifier of the list to download |

#### 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 |

### Get Account Profile

**Slug:** `LISTCLEAN_GET_ACCOUNT_PROFILE`

Tool to retrieve the authenticated account's profile. Use after obtaining a valid auth token to fetch user account 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 |

### Get Remaining Credits

**Slug:** `LISTCLEAN_GET_CREDITS`

Tool to retrieve remaining verification credits. Use when you need to check your available account credits before performing more email verifications.

#### 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 |

### Get List Information

**Slug:** `LISTCLEAN_GET_LIST`

Tool to retrieve detailed information for a specific list. Returns analytics with clean/dirty breakdown, cost details, and processing status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | Unique identifier of the list to retrieve |

#### 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 |

### Get Upload Status

**Slug:** `LISTCLEAN_GET_UPLOAD_STATUS`

Tool to retrieve the status of a specific upload. Returns upload status (inprocess, success, error), progress percentage, and chunk details. Use after initiating an upload to track its completion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `upload_id` | integer | Yes | Unique identifier of the upload to check status for |

#### 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 |

### Get Verification Logs

**Slug:** `LISTCLEAN_GET_VERIFICATION_LOGS`

Tool to retrieve logs for all single email verifications. Returns history of email verifications with status, remarks, credits deducted, and timestamps.

#### 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 |

### List All Verification Lists

**Slug:** `LISTCLEAN_LIST_ALL`

Tool to retrieve all email verification lists. Returns all processed lists with complete analytics including clean/dirty counts, summary statistics, and cost information.

#### 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 |

### List CSV Uploads

**Slug:** `LISTCLEAN_LIST_UPLOADS`

Tool to retrieve the list of CSV uploads. Use when you need to check upload IDs, status, and progress for all CSV file uploads in your account.

#### 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 |

### Start Upload

**Slug:** `LISTCLEAN_START_UPLOAD`

Tool to start a CSV upload process for bulk email verification. Initializes chunked file upload and returns an upload_id for subsequent chunk uploads. Use when you need to upload large CSV files containing email addresses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filename` | string | Yes | Name of the CSV file to upload |
| `file_type` | string | Yes | Type of file being uploaded (must be 'csv') |
| `escape_char` | string | No | The optional escape parameter sets the escape character (at most one single-byte character). An empty value disables the escape mechanism |
| `fast_process` | integer | No | Option to process list as fast as possible by avoiding slow operations like SMTP validation. 0 = off (default), 1 = on |
| `enclosure_char` | string | No | The optional enclosure parameter sets the field enclosure character (one single-byte character only) |
| `max_chunk_size` | integer | Yes | Maximum size of a chunk in bytes |
| `separator_char` | string | No | Character separator for CSV file format |
| `total_chunk_count` | integer | Yes | Total number of chunks the file will be split into for upload |
| `email_column_index` | integer | Yes | Zero-based index of the column containing email addresses in the CSV file |

#### 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 Account Profile

**Slug:** `LISTCLEAN_UPDATE_PROFILE`

Tool to update account profile details. Use when you need to modify user profile information such as name, address, contact details, company information, or billing details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | User's city |
| `name` | string | No | First name of the user |
| `address` | string | No | User's address |
| `country` | string | No | User's country |
| `website` | string | No | User's website |
| `linkedin` | string | No | User's LinkedIn profile URL or handle |
| `skype_id` | string | No | User's Skype ID |
| `billing_name` | string | No | Billing name for invoices and payments |
| `company_name` | string | No | User's company name |
| `phone_number` | string | No | User's phone number |
| `twitter_handle` | string | No | User's Twitter handle |
| `billing_address` | string | No | Billing address for invoices and payments |
| `billing_company_name` | string | No | Billing company name for invoices |

#### 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 |

### Upload Chunk

**Slug:** `LISTCLEAN_UPLOAD_CHUNK`

Tool to upload a chunk of a CSV file. Use when sending base64-encoded content with sequence number as part of chunked upload process, optionally with MD5 checksum for integrity verification.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | string | Yes | Base64-encoded contents of the file chunk |
| `upload_id` | integer | Yes | The upload ID obtained from starting the upload process |
| `md5_checksum` | string | No | MD5 hash of file to check the integrity of the file chunk |
| `chunk_sequence_number` | integer | Yes | Sequence number of the chunk, starting at 1 for the first chunk |

#### 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 Batch of Emails

**Slug:** `LISTCLEAN_VERIFY_BATCH`

Tool to verify a batch of email addresses (max 3000 emails). Use when you need to verify multiple emails at once and get a list_id for tracking the batch verification request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | List of email addresses to verify (maximum 3000 emails per batch) |

#### 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 Email Address

**Slug:** `LISTCLEAN_VERIFY_EMAIL`

Tool to verify an email's validity. Use when you need to ensure an address is deliverable and non-disposable, after collecting a user's email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address to verify |

#### 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 |