NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Listclean connects to a Nagent workspace with an API key. Once it is connected, agents can call 16 Listclean actions, such as "Create Bulk Verification List", "Get Account Profile" and "Get Remaining Credits". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Listclean, with input parameters and output schema.
LISTCLEAN_CREATE_BULK_VERIFICATION_LISTTool 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
List of valid email addresses to include in the CSV file
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_DELETE_LISTTool to permanently delete a single list from the account. Use when you need to remove a list that is no longer needed.
Input parameters
The unique identifier of the list to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_DOWNLOAD_CSVTool 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
Type of emails to download: 'clean' for valid emails, 'dirty' for invalid emails, or 'unknown' for unverified emails
The ID of the email verification list to download
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_DOWNLOAD_JSONTool 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
Type of emails to download from the list
Unique identifier of the list to download
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_GET_ACCOUNT_PROFILETool to retrieve the authenticated account's profile. Use after obtaining a valid auth token to fetch user account data.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_GET_CREDITSTool to retrieve remaining verification credits. Use when you need to check your available account credits before performing more email verifications.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_GET_LISTTool to retrieve detailed information for a specific list. Returns analytics with clean/dirty breakdown, cost details, and processing status.
Input parameters
Unique identifier of the list to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_GET_UPLOAD_STATUSTool 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
Unique identifier of the upload to check status for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_GET_VERIFICATION_LOGSTool to retrieve logs for all single email verifications. Returns history of email verifications with status, remarks, credits deducted, and timestamps.
Input parameters
Offset for pagination. 0-based index of the first log entry to return.
Number of log entries to return per page (default 10).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_LIST_ALLTool to retrieve all email verification lists. Returns all processed lists with complete analytics including clean/dirty counts, summary statistics, and cost information.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_LIST_UPLOADSTool 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.
Input parameters
Offset for pagination. 0-based index of the first upload to return.
Number of uploads to return per page (default 10).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_START_UPLOADTool 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
Name of the CSV file to upload
Type of file being uploaded (must be 'csv')
The optional escape parameter sets the escape character (at most one single-byte character). An empty value disables the escape mechanism
Option to process list as fast as possible by avoiding slow operations like SMTP validation. 0 = off (default), 1 = on
The optional enclosure parameter sets the field enclosure character (one single-byte character only)
Maximum size of a chunk in bytes
Character separator for CSV file format
Total number of chunks the file will be split into for upload
Zero-based index of the column containing email addresses in the CSV file
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_UPDATE_PROFILETool 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
User's city
First name of the user
User's address
User's country
User's website
User's LinkedIn profile URL or handle
User's Skype ID
Billing name for invoices and payments
User's company name
User's phone number
User's Twitter handle
Billing address for invoices and payments
Billing company name for invoices
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_UPLOAD_CHUNKTool 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
Base64-encoded contents of the file chunk
The upload ID obtained from starting the upload process
MD5 hash of file to check the integrity of the file chunk
Sequence number of the chunk, starting at 1 for the first chunk
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_VERIFY_BATCHTool 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
List of email addresses to verify (maximum 3000 emails per batch)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
LISTCLEAN_VERIFY_EMAILTool 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
The email address to verify
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 16 Listclean actions on Nagent, including "Create Bulk Verification List", "Get Account Profile" and "Get Remaining Credits". Create Bulk Verification List: Create a CSV file with provided email addresses for bulk verification. Each action is listed on this page with its input parameters and its output.
Listclean connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Bulk Verification List takes 1 required input: emails. It returns data, error and successful.