NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Campaign Cleaner connects to a Nagent workspace with an API key. Once it is connected, agents can call 5 Campaign Cleaner actions, such as "Get Campaign List", "Get Campaign Status" and "Get 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 Campaign Cleaner, with input parameters and output schema.
CAMPAIGN_CLEANER_DELETE_CAMPAIGNTool to delete a saved campaign by ID. Use when you need to remove a campaign after confirming its ID.
Input parameters
Wrapper object containing the campaign ID 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
CAMPAIGN_CLEANER_GET_CAMPAIGN_LISTTool to list all campaigns in the account. Use when you need to retrieve campaign listings for reporting or management.
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
CAMPAIGN_CLEANER_GET_CAMPAIGN_PDF_ANALYSISDownload a PDF analysis report for a processed campaign. The report includes deliverability analysis, spam score assessment, and optimization recommendations. Use this after a campaign has been submitted via send_campaign and processing is complete.
Input parameters
Campaign object containing the campaign ID to retrieve the PDF analysis 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
CAMPAIGN_CLEANER_GET_CAMPAIGN_STATUSTool to check the processing status of a submitted campaign. Use after submitting a campaign to monitor its progress.
Input parameters
Campaign object containing the unique identifier of the campaign to check.
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
CAMPAIGN_CLEANER_GET_CREDITSTool to retrieve the number of available credits in your Campaign Cleaner account. Credits are consumed when calling the send_campaign API.
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 5 Campaign Cleaner actions on Nagent, including "Get Campaign List", "Get Campaign Status" and "Get Credits". Get Campaign List: List all campaigns in the account. Each action is listed on this page with its input parameters and its output.
Campaign Cleaner 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.
It returns data, error and successful.