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

filenamestring required
file_typestring required
total_chunk_countinteger required
max_chunk_sizeinteger required

max size of a chunk in bytes

separator_charstring

character separator for csv file format

enclosure_charstring

The optional enclosure parameter sets the field enclosure character (one single-byte character only).

escape_charstring

The optional escape parameter sets the escape character (at most one single-byte character). An empty value disables the escape mechanism.

fast_processinteger

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

Example request

{
  "filename": "My file.csv",
  "file_type": "csv",
  "total_chunk_count": 24,
  "max_chunk_size": 64000,
  "separator_char": ",",
  "enclosure_char": "\""
}

Response

Response on success

success0 | 1

Success status, 0 for failed 1 for success

messagestring
error_codeinteger

Example response

{
  "success": 1,
  "message": "Upload created successfully",
  "data": {
    "upload_id": 1327
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.