This endpoint processes and cleans an uploaded email list file with comprehensive validation options. It requires a previously uploaded file from the File Upload endpoint.
How it Works
1
Upload File First
Use the File Upload endpoint to
upload your CSV or XLSX file and obtain the file_id and file URL
2
Configure Cleaning Options
Set your desired validation options (syntax, DMARC, SMTP, MX records)
3
Submit Cleaning Job
Send the cleaning request with the file reference and options
4
Monitor Progress
Use the returned job_id to track the cleaning progress
Prerequisites
File Upload Required: You must first upload a file using the
/v1/api/filesupload/ endpoint to obtain the required file_id and file
URL parameters.
Validation Options
The cleaning process supports multiple validation levels:
validate_syntax: Checks email format and structure
check_dmarc: Validates DMARC policy records
validate_smtp: Performs SMTP server validation
validate_mx: Checks MX record existence
Comprehensive Cleaning: Enable all validation options for the most
thorough email list cleaning, though this will consume more credits and take
longer to process.
Example Workflow
// 1. First upload a filePOST /v1/api/filesupload/// Response includes: { "id": 739, "file": "https://s3.../file.csv" }// 2. Then clean the uploaded filePOST /v1/api/cleanemail/{ "file_id": 739, "file": "https://s3.us-east-1.amazonaws.com/sanitizeemail/email_validation_files/Book_Sheet1_e5FL41X.csv", "user": 100, "list_name": "Customer List - Cleaned", "options": { "validate_syntax": true, "check_dmarc": true, "validate_smtp": true, "validate_mx": true }}
Credits Consumption: The cleaning process consumes credits based on the
number of emails and validation options selected. More comprehensive
validation uses more credits.
Authorizations
X-API-KEY
string
header
required
API key for authentication
Body
application/json
Email list cleaning request payload
file_id
integer
required
ID of the uploaded file (obtained from file upload response)
Example:
739
list_name
string
required
Name for the cleaned email list
Example:
"Customer List - Cleaned"
options
object
Validation and cleaning options
Show child attributes
Response
Email cleaning job initiated successfully
job_id
string
Unique identifier for the cleaning job
status
enum<string>
Current status of the cleaning job
Available options:
queued,
processing,
completed,
failed
list_name
string
Name of the email list being cleaned
file_id
integer
ID of the source file
estimated_completion_time
string<date-time>
Estimated completion time for the cleaning job
options_applied
object
Validation options that will be applied
Show child attributes
total_emails
integer
Total number of emails to be processed
credits_required
integer
Number of credits required for this cleaning job
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Sanitize Email API Docs","colors":{"primary":"#7f56d9","light":"#7f56d9","dark":"#7f56d9"},"logo":{"light":"https://mintcdn.com/sanitizeemail/FMqKL5b2i6-mwdGF/logo/light.svg?fit=max\u0026auto=format\u0026n=FMqKL5b2i6-mwdGF\u0026q=85\u0026s=46346baef74643b10ebb614be40687b2","dark":"https://mintcdn.com/sanitizeemail/FMqKL5b2i6-mwdGF/logo/dark.svg?fit=max\u0026auto=format\u0026n=FMqKL5b2i6-mwdGF\u0026q=85\u0026s=f543e50a0ef69e0fd7a3f9b7a924656e"},"favicon":"/favicon.svg","navbar":{"links":[{"label":"Support","href":"mailto:support@sanitizeemail.com"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.sanitizeemail.com/"}},"footer":{"socials":{"x":"https://x.com/sanitizeemailX","linkedin":"https://www.linkedin.com/company/sanitizeemail","instagram":"https://www.instagram.com/sanitizeemail","youtube":"https://www.youtube.com/@SanitizeEmail","facebook":"https://www.facebook.com/sanitizeemail"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sanitizeemail","hasAudioNarration":false,"actualSubdomain":"sanitizeemail","customDomains":["docs.sanitizeemail.com"],"gitSource":{"type":"github","owner":"vrittech","repo":"sanitize-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae92ac0ab814ccd6585676f:success","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":11},{"language":"default","tag":"Validation endpoints","count":3},{"language":"default","tag":"File endpoints","count":3},{"language":"default","tag":"Get Results","count":2},{"language":"default","tag":"Download Results","count":2},{"language":"default","tag":"Guides","count":2},{"language":"default","tag":"Get Started","count":2},{"language":"default","tag":"API Documentation","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".dark select,.dark .select-field,[data-theme=\"dark\"] select{background-color:#0b0b0f!important;color:#f9fafb!important;border:1px solid #191922!important}.dark select option,[data-theme=\"dark\"] select option{background-color:#0b0b0f!important;border-radius:10px;color:#f9fafb!important}.dark select:focus,[data-theme=\"dark\"] select:focus{border-color:#7f56d9!important;box-shadow:0 0 0 1px #7f56d9!important}.dark .api-playground select,[data-theme=\"dark\"] .api-playground select{background-color:#111827!important;border-color:#4b5563!important}"}],"page":{"pagePath":"api-reference/endpoint/clean_list","slug":"/api-reference/endpoint/clean_list","pageMetadata":{"title":"Clean Email List","openapi":"POST /v1/api/cleanemail/","description":"Process and clean an uploaded email list file with comprehensive validation options","href":"/api-reference/endpoint/clean_list","hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Process and clean an uploaded email list file with comprehensive validation options\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Step,Steps,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`This endpoint processes and cleans an uploaded email list file with comprehensive validation options. It requires a previously uploaded file from the `,_jsx(_components.a,{href:`/api-reference/endpoint/file_upload`,children:`File Upload`}),` endpoint.`]}),`\n`,_jsx(Heading,{level:`2`,id:`how-it-works`,children:`How it Works`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Upload File First`,children:_jsxs(_components.p,{children:[`Use the `,_jsx(_components.a,{href:`/api-reference/endpoint/file_upload`,children:`File Upload endpoint`}),` to\nupload your CSV or XLSX file and obtain the `,_jsx(_components.code,{children:`file_id`}),` and `,_jsx(_components.code,{children:`file`}),` URL`]})}),_jsx(Step,{title:`Configure Cleaning Options`,children:_jsx(_components.p,{children:`Set your desired validation options (syntax, DMARC, SMTP, MX records)`})}),_jsx(Step,{title:`Submit Cleaning Job`,children:_jsx(_components.p,{children:`Send the cleaning request with the file reference and options`})}),_jsx(Step,{title:`Monitor Progress`,children:_jsxs(_components.p,{children:[`Use the returned `,_jsx(_components.code,{children:`job_id`}),` to track the cleaning progress`]})})]}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`File Upload Required`}),`: You must first upload a file using the\n`,_jsx(_components.code,{children:`/v1/api/filesupload/`}),` endpoint to obtain the required `,_jsx(_components.code,{children:`file_id`}),` and `,_jsx(_components.code,{children:`file`}),`\nURL parameters.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`validation-options`,children:`Validation Options`}),`\n`,_jsx(_components.p,{children:`The cleaning process supports multiple validation levels:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`validate_syntax`}),`: Checks email format and structure`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`check_dmarc`}),`: Validates DMARC policy records`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`validate_smtp`}),`: Performs SMTP server validation`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`validate_mx`}),`: Checks MX record existence`]}),`\n`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Comprehensive Cleaning`}),`: Enable all validation options for the most\nthorough email list cleaning, though this will consume more credits and take\nlonger to process.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`example-workflow`,children:`Example Workflow`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`18`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`18`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// 1. First upload a file`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`POST /v`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`/api/filesupload/`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// Response includes: { \"id\": 739, \"file\": \"https://s3.../file.csv\" }`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// 2. Then clean the uploaded file`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`POST /v`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`/api/cleanemail/`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"file_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`739`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"file\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://s3.us-east-1.amazonaws.com/sanitizeemail/email_validation_files/Book_Sheet1_e5FL41X.csv\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"user\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`100`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"list_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Customer List - Cleaned\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"options\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"validate_syntax\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"check_dmarc\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"validate_smtp\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"validate_mx\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Credits Consumption`}),`: The cleaning process consumes credits based on the\nnumber of emails and validation options selected. More comprehensive\nvalidation uses more credits.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Clean Email List","openapi":"POST /v1/api/cleanemail/","description":"Process and clean an uploaded email list file with comprehensive validation options","href":"/api-reference/endpoint/clean_list","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"How it Works","slug":"how-it-works","depth":2,"children":[]},{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Validation Options","slug":"validation-options","depth":2,"children":[]},{"title":"Example Workflow","slug":"example-workflow","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Clean Email List","description":"Process and clean an uploaded email list file with comprehensive validation options","tags":["Email Cleaning"],"requestBody":"39083e86-5dfc-4048-9ead-d8fe846edf81","responses":{"200":"253a5bee-bfbf-475a-835a-6829bce020cb","400":"fa596517-8b3b-4c9a-acb8-a809afb4ff53","401":"ced25714-80ef-454d-9a05-1d63b570ce71","404":"7d03af66-38da-49bd-9ffe-4a3fc128007a","429":"041596f3-938e-428e-badf-fbed6aaf8e30"},"method":"post","type":"path","servers":["ca31efd6-2adb-4d0e-9d40-4acd0d3193b1"],"security":["6b03ea10-a856-4a37-a66c-71bc344a78c8"],"path":"/v1/api/cleanemail/","baseUrlOptions":["https://base.sanitizeemail.com"],"title":"Clean Email List","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Email list cleaning request payload","required":true,"content":{"application/json":{"schema":{"type":"object","required":["file_id","file","user","list_name"],"properties":{"file_id":{"type":"integer","description":"ID of the uploaded file (obtained from file upload response)","example":739,"isRequired":true,"uniqueKey":"file_id","typeLabel":"integer"},"list_name":{"type":"string","description":"Name for the cleaned email list","example":"Customer List - Cleaned","isRequired":true,"uniqueKey":"list_name","typeLabel":"string"},"options":{"type":"object","description":"Validation and cleaning options","properties":{"validate_syntax":{"type":"boolean","description":"Whether to validate email syntax","default":true,"uniqueKey":"options.validate_syntax","typeLabel":"boolean"},"check_dmarc":{"type":"boolean","description":"Whether to check DMARC records","default":true,"uniqueKey":"options.check_dmarc","typeLabel":"boolean"},"validate_smtp":{"type":"boolean","description":"Whether to perform SMTP validation","default":true,"uniqueKey":"options.validate_smtp","typeLabel":"boolean"},"validate_mx":{"type":"boolean","description":"Whether to validate MX records","default":true,"uniqueKey":"options.validate_mx","typeLabel":"boolean"}},"uniqueKey":"options","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"file_id":739,"list_name":"Customer List - Cleaned","options":{"validate_syntax":true,"check_dmarc":true,"validate_smtp":true,"validate_mx":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"253a5bee-bfbf-475a-835a-6829bce020cb":{"description":"Email cleaning job initiated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"job_id":{"type":"string","description":"Unique identifier for the cleaning job","uniqueKey":"job_id","typeLabel":"string"},"status":{"type":"string","enum":["queued","processing","completed","failed"],"description":"Current status of the cleaning job","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"list_name":{"type":"string","description":"Name of the email list being cleaned","uniqueKey":"list_name","typeLabel":"string"},"file_id":{"type":"integer","description":"ID of the source file","uniqueKey":"file_id","typeLabel":"integer"},"estimated_completion_time":{"type":"string","format":"date-time","description":"Estimated completion time for the cleaning job","uniqueKey":"estimated_completion_time","typeLabel":"string\u003cdate-time>"},"options_applied":{"type":"object","description":"Validation options that will be applied","properties":{"validate_syntax":{"type":"boolean","uniqueKey":"options_applied.validate_syntax","typeLabel":"boolean"},"check_dmarc":{"type":"boolean","uniqueKey":"options_applied.check_dmarc","typeLabel":"boolean"},"validate_smtp":{"type":"boolean","uniqueKey":"options_applied.validate_smtp","typeLabel":"boolean"},"validate_mx":{"type":"boolean","uniqueKey":"options_applied.validate_mx","typeLabel":"boolean"}},"uniqueKey":"options_applied","typeLabel":"object"},"total_emails":{"type":"integer","description":"Total number of emails to be processed","uniqueKey":"total_emails","typeLabel":"integer"},"credits_required":{"type":"integer","description":"Number of credits required for this cleaning job","uniqueKey":"credits_required","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"job_id":"\u003cstring>","status":"queued","list_name":"\u003cstring>","file_id":123,"estimated_completion_time":"2023-11-07T05:31:56Z","options_applied":{"validate_syntax":true,"check_dmarc":true,"validate_smtp":true,"validate_mx":true},"total_emails":123,"credits_required":123}}},"exampleType":"generated"}},"exampleType":"generated"},"fa596517-8b3b-4c9a-acb8-a809afb4ff53":{"description":"Bad request - Invalid payload or file reference","content":{"application/json":{"schema":{"required":["error","message"],"type":"object","properties":{"error":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"error","typeLabel":"integer\u003cint32>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"ced25714-80ef-454d-9a05-1d63b570ce71":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"required":["error","message"],"type":"object","properties":{"error":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"error","typeLabel":"integer\u003cint32>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"7d03af66-38da-49bd-9ffe-4a3fc128007a":{"description":"File not found","content":{"application/json":{"schema":{"required":["error","message"],"type":"object","properties":{"error":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"error","typeLabel":"integer\u003cint32>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"041596f3-938e-428e-badf-fbed6aaf8e30":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"required":["error","message"],"type":"object","properties":{"error":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"error","typeLabel":"integer\u003cint32>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6b03ea10-a856-4a37-a66c-71bc344a78c8":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"API key for authentication","scopes":[]}}},"servers":{"ca31efd6-2adb-4d0e-9d40-4acd0d3193b1":{"url":"https://base.sanitizeemail.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"API key for authentication","scopes":[]},"schema":{"title":"X-API-KEY","type":"string","description":"API key for authentication","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"X-API-KEY"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"sanitizeemail","siteName":"Sanitize Email API Docs","title":"Clean Email List - Sanitize Email API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T09:46:39.521Z","originalFileLocation":"api-reference/endpoint/clean_list.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Process and clean an uploaded email list file with comprehensive validation options\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sanitize Email API Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sanitizeemail/_GQ_575T0N5dLEtb/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/sanitizeemail/_GQ_575T0N5dLEtb/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sanitizeemail/_GQ_575T0N5dLEtb/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sanitizeemail/_GQ_575T0N5dLEtb/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sanitizeemail/_GQ_575T0N5dLEtb/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sanitizeemail/_GQ_575T0N5dLEtb/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sanitizeemail/_GQ_575T0N5dLEtb/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sanitizeemail/_GQ_575T0N5dLEtb/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sanitizeemail/_GQ_575T0N5dLEtb/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Clean Email List - Sanitize Email API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Process and clean an uploaded email list file with comprehensive validation options\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sanitize Email API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sanitizeemail.com/api-reference/endpoint/clean_list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sanitizeemail.mintlify.site/_mintlify/api/og/v2?division=Validation+endpoints\u0026amp;title=Clean+Email+List\u0026amp;description=Process+and+clean+an+uploaded+email+list+file+with+comprehensive+validation+options\u0026amp;theme=9d04777a0ebfbd0878ebcbed\u0026amp;signature=41fc734462eed5a435a71440823df5bdbba795d92a5e6761437580f374a050d2\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Clean Email List - Sanitize Email API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Process and clean an uploaded email list file with comprehensive validation options\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sanitizeemail.mintlify.site/_mintlify/api/og/v2?division=Validation+endpoints\u0026amp;title=Clean+Email+List\u0026amp;description=Process+and+clean+an+uploaded+email+list+file+with+comprehensive+validation+options\u0026amp;theme=9d04777a0ebfbd0878ebcbed\u0026amp;signature=41fc734462eed5a435a71440823df5bdbba795d92a5e6761437580f374a050d2\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/sanitizeemail/_GQ_575T0N5dLEtb/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sanitize Email API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7f56d9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sanitizeemail.com/api-reference/endpoint/clean_list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/clean_list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sanitizeemail.com/#organization\",\"name\":\"Sanitize Email API Docs\",\"url\":\"https://docs.sanitizeemail.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sanitizeemail/FMqKL5b2i6-mwdGF/logo/light.svg?fit=max\u0026auto=format\u0026n=FMqKL5b2i6-mwdGF\u0026q=85\u0026s=46346baef74643b10ebb614be40687b2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sanitizeemail.com#website\",\"name\":\"Sanitize Email API Docs\",\"url\":\"https://docs.sanitizeemail.com\",\"publisher\":{\"@id\":\"https://docs.sanitizeemail.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sanitizeemail.com/api-reference/endpoint/clean_list#webpage\",\"url\":\"https://docs.sanitizeemail.com/api-reference/endpoint/clean_list\",\"name\":\"Clean Email List\",\"description\":\"Process and clean an uploaded email list file with comprehensive validation options\",\"dateModified\":\"2026-01-07T09:46:39.521Z\",\"isPartOf\":{\"@id\":\"https://docs.sanitizeemail.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.sanitizeemail.com/api-reference/endpoint/clean_list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.sanitizeemail.com/api-reference/endpoint/clean_list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Validation endpoints\",\"item\":\"https://docs.sanitizeemail.com/api-reference/endpoint/analyze_list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Clean Email List\",\"item\":\"https://docs.sanitizeemail.com/api-reference/endpoint/clean_list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sanitizeemail.com/api-reference/endpoint/clean_list#apireference\",\"headline\":\"Clean Email List\",\"name\":\"Clean Email List\",\"description\":\"Process and clean an uploaded email list file with comprehensive validation options\",\"url\":\"https://docs.sanitizeemail.com/api-reference/endpoint/clean_list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sanitizeemail.com/api-reference/endpoint/clean_list#webpage\"},\"dateModified\":\"2026-01-07T09:46:39.521Z\",\"publisher\":{\"@id\":\"https://docs.sanitizeemail.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sanitizeemail.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sanitize Email API Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Sanitize Email API Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/clean_list.md","siteName":"Sanitize Email API Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"File endpoints","pages":[{"title":"Upload CSV or XLSX","openapi":"POST /v1/api/filesupload/","href":"/api-reference/endpoint/file_upload"},{"title":"List Uploaded Files","openapi":"GET /v1/api/filesupload/","href":"/api-reference/endpoint/view_all_files"},{"title":"View File Details","openapi":"GET /v1/api/filesupload/{file_id}","href":"/api-reference/endpoint/view_file"}]},{"group":"Validation endpoints","pages":[{"title":"Analyze Email List","openapi":"POST /v1/api/filesupload/analyze-list/","href":"/api-reference/endpoint/analyze_list"},{"title":"Validate Emails","openapi":"POST /v1/api/email-validation/","description":"Validate one or more email addresses for syntax, domain, deliverability, and SMTP checks","href":"/api-reference/endpoint/validate_emails"},{"title":"Clean Email List","openapi":"POST /v1/api/cleanemail/","href":"/api-reference/endpoint/clean_list"}]},{"group":"Get Results","pages":[{"title":"View Clean List Results","openapi":"GET /v1/api/cleanedemail/","description":"This endpoint retrieves the results of a cleaned email list, showing all valid emails that passed the validation process. Use this to access the clean emails after the cleaning job is completed.","href":"/api-reference/endpoint/clean_list_result"},{"title":"View Validation Results","openapi":"GET /v1/api/email-validation/","href":"/api-reference/endpoint/validation_result"}]},{"group":"Download Results","pages":[{"title":"Download Clean List","openapi":"GET /v1/api/cleanedemail/download-cleaned-emails/","href":"/api-reference/endpoint/download_clean_list"},{"title":"Download Validation Results","openapi":"GET /v1/api/email-validation/download-validation-results/","href":"/api-reference/endpoint/download_validated_list"}]}]}]},"basePath":"","title":"Clean Email List - Sanitize Email API Docs","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}