---
title: "Start the Upload (csv upload)"
method: POST
path: "/uploads/"
tags: ["uploads"]
---

# Start the Upload (csv upload)

`POST /uploads/`

## Request

- Base URL: `https://api.listclean.xyz/v1`
- URL: `https://api.listclean.xyz/v1/uploads/`
- Auth: API key in header `X-Auth-Token`

## Request body

- object
  - `filename` string, required
  - `file_type` string, required
  - `total_chunk_count` integer, required
  - `max_chunk_size` integer, required: max size of a chunk in bytes
  - `separator_char` string: character separator for csv file format
  - `enclosure_char` string: The optional enclosure parameter sets the field enclosure character (one single-byte character only).
  - `escape_char` string: The optional escape parameter sets the escape character (at most one single-byte character). An empty value disables the escape mechanism.
  - `fast_process` integer: Option to process list as fast as possible by avoiding slow opertions like SMTP validation, etc and instead only use fast operation like db lookup from cache, dns validation, format validation, etc. Default value is 0 which means off

## Response `200`

Response on success

- object
  - `success` 0 | 1: Success status, 0 for failed 1 for success
  - `message` string
  - `error_code` integer
  - `data` object
    - `upload_id` integer

## Other responses

- `400`: List name is required
- `401`: Auth Failed

---

[API](https://skmtc.dev/listclean/apis/listclean-api-beta.md) · [All operations](https://skmtc.dev/listclean/apis/listclean-api-beta/llms.txt) · [OpenAPI document](https://skmtc.dev/listclean/apis/listclean-api-beta/revisions/780c4fe6db87?raw)